webpack組織模組打包Library的原理及實現，webpacklibrary

webpack組織模組打包Library的原理及實現，webpacklibrary

之前一篇文章分析了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 (預設值，發布為全域變數)commonjscommonjs2amdumd

使用不同的選項，編譯出來的檔案就能夠在不同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，那就會把結果設定為一個全域變數，這用於瀏覽器通過<script>標籤直接匯入該JS檔案；如果是CommonJS，它則交給exports對象；如果是AMD環境，它也是用標準的AMD的寫法。這樣這個發布出來的JS庫就可以在任意的環境中都能被其他人使用。

targetExport控制輸出內容

如果用umd格式打包，可能會有一個坑需要注意，如果你的庫的原始碼是用ES6格式export default來輸出的，正如上面的例子util.js，你直接把編譯後的JS庫檔案放到瀏覽器中使用，可以是<script>，或者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的方式通過<script>載入Vue，你會發現Vue無法識別這個Component，因為你得到的這個對象多了一層不必要的default。

你可能會問如果我把輸出內容改成了default，會不會影響這個模組在ES6環境下的使用？一般來說是不會的。之前一篇文章裡已經談到，Webpack的產生代碼在引入一個模組時，會通過一個叫__esModule的值來設定和判斷它是不是ES6格式的export，現在如果只匯出default部分，那麼這個對象是被視為非ES6的，因為它不含__esModule。這樣其它模組通過import來引入這個模組時，會引入整個對象，這實際上變相地就等價於只引入原模組的export default部分。

當然以上討論的前提是，你所有需要export的內容全部都在export default裡。如果你既有default，又有正常的export，那編譯後的檔案只匯出default部分顯然是不行的。

以上就是本文的全部內容，希望對大家的學習有所協助，也希望大家多多支援幫客之家。