Webpack 模塊打包機制淺析

在官方定義中，Webpack 是一個現代 JavaScript 應用靜態模塊打包器。它統一了 JavaScript 在發展過程當中出現的各類模塊化方案，咱們能夠認爲 Webpack 是 JavaScript 模塊化的統一解決方案。

若是有對 JavaScript 各類模塊化方案還不是很瞭解的小夥伴，建議閱讀《JavaScript 模塊的發展史》。

在 Webpack 對源代碼的編譯過程當中，包含了一個模塊打包的工做，其實就是 Webpack 從入口文件開始，逐級地將源代碼中各個模塊的依賴關係分析出來，輸入最終的打包文件。

接下來讓咱們以 CommonJS 和 ES6 的模塊機制爲例，來更深刻地理解 Webpack 的模塊打包機制。

以下 webpack.config.js 的簡單配置，在下述例子中，都是以該配置爲準的。

// webpack.config.js
const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'bundle.js'
  },
  mode:'development'
};
複製代碼

CommonJS

在 CommonJS 的模塊機制中，使用 require 引入模塊，module.exports/exports 輸出模塊。

模塊文件 bar.js 和入口文件 index.js 分別以下：

// src/bar.js
var num = 1;
function addNum(){
  num++;
}

module.exports = { 
  num: num, 
  addNum: addNum
}
複製代碼

// src/index.js
var bar = require('./bar.js');

console.log(bar.num)  // 1
bar.addNum();
console.log(bar.num); // 1
複製代碼

運行 webpack 命令後，咱們可獲得最終的輸出文件 bundle.js，最終生成的 bundle.js 文件中的內容其實是一個自執行函數，其傳入的參數 modules 對象包含了入口文件以及各個依賴模塊，形式以下：

{
 "./src/bar.js":(function (module, exports) {}),
 "./src/index.js":(function (module, exports, __webpack_require__) {})
}
複製代碼

在 modules 對象中，各個屬性名爲文件路徑字符串，屬性值爲一個函數，其中包含了文件源代碼中的內容，而源代碼中的引入輸出功能則是經過自定義的方式來實現的。

其中的關鍵即是 __webpack_require__ 方法：

var installedModules = {};
// The require function
function __webpack_require__(moduleId) {
  // Check if module is in cache
  if (installedModules[moduleId]) {
    return installedModules[moduleId].exports;
  }
  // Create a new module (and put it into the cache)
  var module = installedModules[moduleId] = {
    i: moduleId,
    l: false,
    exports: {}
  };
  // Execute the module function
  modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
  // Flag the module as loaded
  module.l = true;

  // Return the exports of the module
  return module.exports;
}
複製代碼

__webpack_require__ 方法接收模塊惟一的 moduleId 做爲參數，其主要作了如下幾件事：

1. 判斷該模塊是否存在緩存對象中，如果則返回緩存對象中對應模塊，若不然定義模塊對象並存儲進緩存對象中；
2. 執行 modules 對象中對應模塊的函數（在函數中會將該模塊輸出的內容存儲進 module.exports 中）；
3. 返回該模塊 module.exports；

因此，在最終生成的自執行函數中，除了對一些變量、方法的定義外，其最終返回了對入口文件的引用：

return __webpack_require__(__webpack_require__.s = "./src/index.js");
複製代碼

接下來便會按咱們的預期去執行 __webpack_require__ 函數，傳入的 moduleId 爲 ./src/index.js，因此會執行 modules 對象中相應的屬性值函數：

// modules 對象中 ./src/index.js 對應函數
(function(module, exports, __webpack_require__) {
  eval("// src/index.js\nvar bar = __webpack_require__(/*! ./bar.js */ \"./src/bar.js\");\n\nconsole.log(bar.num) // 1\nbar.addNum();\nconsole.log(bar.num); // 1\n\n//# sourceURL=webpack:///./src/index.js?");
})
複製代碼

能夠看到，在該函數中使用自定義的 __webpack_require__ 方法去替代了 CommonJS 中的 require 方法引入 bar.js 模塊，並執行相應代碼。

而在引入 ./src/bar.js 所對應的屬性值函數時，也會執行函數內的代碼：

// modules 對象中 ./src/bar.js 對應函數
(function(module, exports) {
  eval("var num = 1;\nfunction addNum() {\n num++;\n}\n\nmodule.exports = {\n num: num,\n addNum: addNum\n}\n\n//# sourceURL=webpack:///./src/bar.js?");
})
複製代碼

咱們會發現該函數的實際內容與 bar.js 模塊的內容是如出一轍的，但實際上不一樣的是函數中 module.exports 並非屬於 CommonJS 模塊的語法，而是函數中傳進來的 module 對象的屬性，這個 module 是 Webpack 中自定義的模塊對象，形式以下：

var module = installedModules[moduleId] = {
  i: moduleId,
  l: false,
  exports: {}
};
複製代碼

在 Webpack 中正是經過這種方式實現模塊內容的輸出。

至此，Webpack 已經實現了 CommonJS 模塊的引入輸出功能，接下來咱們再來深究 CommonJS 模塊輸出的一個特性：CommonJS 模塊輸出的是值的緩存，不存在動態更新。

上述的例子，在 index.js 文件中先輸出 num 的值，而後再調用 addNum 方法，最後再輸出 num 的值，會發現 num 的值沒有改變。由於 addNum 方法改變的是 bar.js 中 num 的值，而在 bar.js 中的輸出是以淺拷貝的方式。

因此，在執行 ./src/bar.js 對應屬性值函數時，能夠發現以下代碼：

module.exports = {\n  num: num,\n  addNum: addNum\n}
複製代碼

這也代表了在 Webpack 中模塊的輸出實現方式依舊遵循 CommonJS 模塊輸出的特性，輸出實際上是以淺拷貝的方式來實現的（注意這點，會與下述 ES6 中的 export 輸出的特性作比較）。

ES6

在 ES6 模塊化方案中，使用 import 引入模塊，export 或 export default 輸出模塊。

export

// src/bar.js
var num = 1;
function addNum(){
  num++;
}

export { num, addNum }
複製代碼

// src/index.js
import { num, addNum } from './bar.js';

console.log(num)  // 1
addNum();
console.log(num); // 2
複製代碼

運行 webpack 命令後，一樣地輸出一個 bundle.js 文件，在 bundle.js 文件中一樣是一個自執行函數，與 CommonJS 模塊打包出來的文件基本上是一致的，不一樣的是在 modules 對象中對應的屬性值函數不一樣。

ES6 模塊機制中輸出的特性是：export 語句輸出的接口，與其對應的值是動態綁定關係。

在 modules 對象 中 ./src/index.js 對應的屬性值函數爲：

// modules 對象中 ./src/index.js 對應函數
(function (module, __webpack_exports__, __webpack_require__) {
  "use strict";
  eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _bar_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./bar.js */ \"./src/bar.js\");\n\n\nconsole.log(_bar_js__WEBPACK_IMPORTED_MODULE_0__[\"num\"]) // 1\nObject(_bar_js__WEBPACK_IMPORTED_MODULE_0__[\"addNum\"])();\nconsole.log(_bar_js__WEBPACK_IMPORTED_MODULE_0__[\"num\"]); // 2\n\n//# sourceURL=webpack:///./src/index.js?");
})
複製代碼

./src/bar.js 對應的屬性值函數爲：

// modules 對象中 ./src/bar.js 對應函數
(function (module, __webpack_exports__, __webpack_require__) {
  "use strict";
  eval("__webpack_require__.r(__webpack_exports__);\n/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, \"num\", function() { return num; });\n/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, \"addNum\", function() { return addNum; });\nvar num = 1;\nfunction addNum() {\n num++;\n}\n\n\n\n//# sourceURL=webpack:///./src/bar.js?");
})
複製代碼

能夠看出其不是直接經過 module.exports 淺拷貝的方式來實現的，而是經過一個 __webpack_require__.d 方法來實現：

__webpack_require__.d = function (exports, name, getter) {
  if (!__webpack_require__.o(exports, name)) {
    Object.defineProperty(exports, name, { enumerable: true, get: getter });
  }
};
複製代碼

該方法主要是直接經過定義對象屬性的 getter，來實現對引入變量的訪問還是原先模塊的內部變量。

而爲何僅僅定義了 getter 而不定義 setter 呢，是由於在 ES6 模塊中，import命令輸入的變量都是隻讀的，由於它的本質是輸入接口；若是引入對變量是一個對象，改寫變量的屬性則是容許的。

export default

// src/bar.js
var num = 1;
function getNum(){
  return num;
}

export default getNum
複製代碼

// src/index.js
import getNum from './bar.js';

console.log(getNum())  // 1
複製代碼

一樣的執行 webpack 命令打包獲得 bundle.js。

在 modules 對象 中 ./src/index.js 對應的屬性值函數爲：

// modules 對象中 ./src/index.js 對應函數
(function (module, __webpack_exports__, __webpack_require__) {
  "use strict";
  eval("__webpack_require__.r(__webpack_exports__);\n/* harmony import */ var _bar_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./bar.js */ \"./src/bar.js\");\n\n\nconsole.log(Object(_bar_js__WEBPACK_IMPORTED_MODULE_0__[\"default\"])()) // 1\n\n\n//# sourceURL=webpack:///./src/index.js?");
})
複製代碼

在 modules 對象 中 ./src/bar.js 對應的屬性值函數爲:

// modules 對象中 ./src/bar.js 對應函數
(function (module, __webpack_exports__, __webpack_require__) {
  "use strict";
  eval("__webpack_require__.r(__webpack_exports__);\nvar num = 1;\nfunction getNum(){\n return num;\n}\n\n/* harmony default export */ __webpack_exports__[\"default\"] = (getNum);\n\n//# sourceURL=webpack:///./src/bar.js?");
})
複製代碼

對於 export.default 來講，其特性與 CommonJS 相似，輸出也是以淺拷貝的方式來進行的，不一樣的是其是存儲在 module.exports 中的 default 屬性中的，而在入口文件中則是經過對象的 default 屬性來訪問的。

---

參考文章：

webpack組織模塊的原理 - 基礎篇

---

公衆號不定時分享我的在前端方面的學習經驗，歡迎關注。