摘要:所以你編譯后的文件實際上應當只輸出,這就需要在配置里用來控制這樣上面的模塊加載函數會在返回值后面加一個,這樣就只返回的部分。
之前一篇文章分析了Webpack打包JS模塊的基本原理,所介紹的案例是最常見的一種情況,即多個JS模塊和一個入口模塊,打包成一個bundle文件,可以直接被瀏覽器或者其它JavaScript引擎執行,相當于直接編譯生成一個完整的可執行的文件。不過還有一種很常見的情況,就是我們要構建發布一個JavaScript的庫,比如你在npm社區發布自己的庫,這時Webpack就需要相應的配置,編譯生成的代碼也會略有不同。
和之前一篇文章一樣,本文主要分析的是Webpack的生成代碼,并結合它來說明編譯庫時Webpack那些關于library的配置選項的具體作用,相應的官方文檔在這里。
編寫JS的庫我們還是從簡單的案例開始,我們隨便編寫一個簡單的庫util.js:
import $ from "jquery" function sayHello() { console.log("Hello"); } function hideImages() { $("img").hide(); } export default { sayHello: sayHello, hideImages: hideImages }
提供了兩個函數,當然它們之間毫無關系,也實際上沒有任何卵用,純粹是僅供教學參考。。。
接下來寫Webpack的配置:
// 入口文件 entry: { util: "./util.js", } // 輸出文件 output: { path: "./dist", filename: "[name].dist.js" }
但僅僅這樣是不夠的,這樣輸出的文件就是一個立即執行的函數,最后會返回util.js的exports,參照上一篇文章中分析,最后生成的bundle代碼結構大致是這樣的:
(function(modules) { var installedModules = {}; function webpack_require(moduleId) { // ... } return webpack_require("./util.js"); }) ({ "./util.js": generated_util, "/path/to/jquery.js": generated_jquery });
它如果執行完,那就結束了,將util.js的export部分返回而已,而我們需要的是將這個返回值交給編譯后的文件的module.export,這樣編譯后的文件就成了一個可以被別人import的庫。所以我們希望得到的編譯文件應該是這樣的:
module.exports = (function(modules) { var installedModules = {}; function webpack_require(moduleId) { // ... } return webpack_require("./util.js"); }) ({ "./util.js": generated_util, "/path/to/jquery.js": generated_jquery });
要得到這樣的結果,Webpack配置output部分需要加入library信息:
// 入口文件 output: { path: "./dist", filename: "[name].dist.js", library: "util", libraryTarget: commonjs2 }
這里最重要的就是libraryTarget,我們現在采用commonjs2的格式,就會得到上面的編譯結果,也就是說Webpack會library把最后的輸出以CommonJS的形式export出來,這樣就實現了一個庫的發布。
除了commonjs2,libraryTarget還有其它選項:
var (默認值,發布為全局變量) commonjs commonjs2 amd umd
使用不同的選項,編譯出來的文件就能夠在不同JavaScript執行環境中使用。在這里我們直接看萬金油umd格式的輸出是怎么樣的:
(function webpackUniversalModuleDefinition(root, factory) { if(typeof exports === "object" && typeof module === "object") // commonjs2 module.exports = factory(); else if(typeof define === "function" && define.amd) define("util", [], factory); // amd else if(typeof exports === "object") exports["util"] = factory(); // commonjs else root["util"] = factory(); // var }) (window, function() { return (function(modules) { var installedModules = {}; function webpack_require(moduleId) { // ... } return webpack_require("./util.js"); }) ({ "./util.js": generated_util, "/path/to/jquery.js": generated_jquery }); }
比之前的commonjs2的情況要復雜得多,因為它需要處理各種不同的case,但其實后面的部分都是一樣的,最重要的就是最前面的幾行,這是umd模塊的標準寫法。它運行傳入的factory函數,實際上就是加載模塊的函數,然后把返回的結果根據不同的運行環境交給相應的對象。例如var,那就會把結果設置為一個全局變量,這用于瀏覽器通過標簽直接導入該JS文件;如果是CommonJS,它則交給exports對象;如果是AMD環境,它也是用標準的AMD的寫法。這樣這個發布出來的JS庫就可以在任意的環境中都能被其他人使用。
如果用umd格式打包,可能會有一個坑需要注意,如果你的庫的源代碼是用ES6格式export default來輸出的,正如上面的例子util.js,你直接把編譯后的JS庫文件放到瀏覽器中使用,可以是,或者RequireJS,可能得不到你想要的結果。這是因為你的JS文件返回給你的對象是這樣的:
{ "default": { sayHello: sayHello, hideImages: hideImages } }
而不是你所期望的:
{ sayHello: sayHello, hideImages: hideImages }
不僅是瀏覽器,在不支持ES6的模塊系統中同樣會出這個問題,就是因為它們并不認識default。所以你編譯后的JS文件實際上應當只輸出default,這就需要在Webpack配置里用targetExport來控制:
library: "util", libraryTarget: umd, targetExport: "default"
這樣上面的模塊加載函數factory會在返回值后面加一個["default"],這樣就只返回exports的default部分。
這個坑在umd格式下其實還是挺容易踩到的,例如你發布一個Vue組件,.vue文件中的JavaScript部分一般都是把Component對象以export default的格式導出的,就像這樣:
export default { name: "xxx", data() { return // ... }, props: { // ... } methods: { // ... } }
如果你把編譯后的JS文件直接放在瀏覽器里運行,并且用CDN的方式加載Vue,你會發現Vue無法識別這個Component,因為你得到的這個對象多了一層不必要的default。
你可能會問如果我把輸出內容改成了default,會不會影響這個模塊在ES6環境下的使用?一般來說是不會的。之前一篇文章里已經談到,Webpack的生成代碼在引入一個模塊時,會通過一個叫__esModule的值來設置和判斷它是不是ES6格式的export,現在如果只導出default部分,那么這個對象是被視為非ES6的,因為它不含__esModule。這樣其它模塊通過import來引入這個模塊時,會引入整個對象,這實際上變相地就等價于只引入原模塊的export default部分。
當然以上討論的前提是,你所有需要export的內容全部都在export default里。如果你既有default,又有正常的export,那編譯后的文件只導出default部分顯然是不行的。
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/93308.html
摘要:所以通常情況下當你的庫需要依賴到例如,這樣的通用模塊時,我們可以不將它打包進,而是在的配置中聲明這就是在告訴請不要將這個模塊注入編譯后的文件里,對于我源代碼里出現的任何這個模塊的語句,請將它保留。 這篇文章討論Webpack打包library時經常需要用到的一個選項external,它用于避免將一些很通用的模塊打包進你發布的library里,而是選擇把它們聲明成external的模塊,...
摘要:每一個模塊的源代碼都會被組織在一個立即執行的函數里。接下來看的生成代碼可以看到,的源代碼中關于引入的模塊的部分做了修改,因為無論是,或是風格的,都無法被解釋器直接執行,它需要依賴模塊管理系統,把這些抽象的關鍵詞具體化。 現在前端用Webpack打包JS和其它文件已經是主流了,加上Node的流行,使得前端的工程方式和后端越來越像。所有的東西都模塊化,最后統一編譯。Webpack因為版本的...
摘要:一看就懂之基礎配置一簡介本質上,是一個現代應用程序的靜態模塊打包器。屬性表示的是的上下文目錄,配置入口文件的時候,如果入口文件使用的是相對路徑,那么就是相對于所在的目錄。通常用于指定以何種方式導出庫,通常用于指定接收庫的名稱。 一看就懂之webpack基礎配置 一、webpack 簡介 本質上,webpack 是一個現代 JavaScript 應用程序的靜態模塊打包器(module b...
摘要:配置以何種方式導出庫。當檢測文件不再發生變化,會先緩存起來,等等待一段時間后之后再通知監聽者,這個等待時間通過配置。發布到線上給用戶使用的運行環境。 一 縮小文件搜索范圍 1 include & exclude 1) action 限制編譯范圍 2) useage module: { rules: [ { test...
摘要:基本配置項基本配置項。的插件架構主要基于實現的,這個就是專注于事件的廣播和操作。開啟多進程,加快打包速度。 這次我們主要研究的是webpack框架的相關知識,webpack是一個打包構建的前端框架,用于解決前端開發的模塊化問題。 應用場景和縱向比較 說到webpack,肯定你還會想到gulp和grunt這些框架,那么webpack是做什么的呢?他和其他的框架有什么區別呢?我們一起來分析...
閱讀 3859·2023-04-26 00:36
閱讀 2667·2021-11-16 11:44
閱讀 1082·2021-11-15 17:58
閱讀 1665·2021-09-30 09:47
閱讀 1208·2019-08-30 13:05
閱讀 1539·2019-08-30 12:55
閱讀 2409·2019-08-30 11:02
閱讀 2718·2019-08-29 17:01