写点什么

webpack 模块化的原理

作者:Geek_02d948
  • 2023-02-27
    浙江
  • 本文字数:3217 字

    阅读完需:约 11 分钟

commonjs

在 webpack 中既可以书写 commonjs 模块也可以书写 es 模块,而且不用考虑浏览器的兼容性问题,我们来分析一下原理。


首先搞清楚 commonjs 模块化的处理方式,简单配置一下 webpack,写两个模块编译一下看一下:


webpack.config.js


module.exports = {    mode: "development",    devtool: "none"}
复制代码


index.js


const a = require('./a')console.log(a)
复制代码


a.js


const a = 'a';module.exports = a;
复制代码

编译结果

查看编译结果,可以发现 webpack 对于每个模块的做法类似于 node,将每个模块放在一个函数环境中并向其中传入一些必要的参数。webpack 将这些模块组成一个对象(属性名是模块路径(模块 id),属性值为模块内容)传入一个立即执行函数,立即执行函数中定义了一个函数 __webpack_require__类似 node 中的require函数,实现了导入模块的作用。



打包结果中删去了一些注释和暂时用不要的代码,可以很明显的看出来实现 commonjs 模块化的关键就是这个 __webpack_require__ 函数,通过传入模块 id 来得到模块的导出。

require 函数

__webpack_require__ 函数的实现:


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;}
复制代码


如果熟悉 node 就很容易理解这个函数了:


  1. 首先查看这个模块是否已经被加载过,所以就需要一个全局变量installedModules用来记录所有被加载过模块的导出

  2. 没有加载过的模块就先构造一个module对象,关键是要有一个 exports 属性

  3. 执行模块代码并返回模块导出值


最终的一步就是需要加载启动模块,也就是 IIFE 的最后一句:


return __webpack_require__("./src/index.js");
复制代码

ES Module

es 模块化的处理方式是需要借助 __webpack_require__ 实现的,首先看一些刚才被删除的代码:


  1. __webpack_require__.r

  2. 该函数用于标识 es 模块的导出

  3. __webpack_require__.d

  4. 用于处理 es 模块的具名导出

  5. __webpack_require__.o

  6. 就是给 hasOwnPreperty 换了个名字


我们改一下模块代码看看纯 es Module 导入导出的编译结果:


index.js


import a, { test } from './a'import b from './b'console.log(a);test();console.log(b)
复制代码


a.js


const a = 'a';function test() { }export default a;export { test }
复制代码


b.js


const b = 'b';export default b;
复制代码


参考 前端进阶面试题详细解答

编译结果

{    "./src/a.js": (function (module, __webpack_exports__, __webpack_require__) {
"use strict"; __webpack_require__.r(__webpack_exports__); /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "test", function () { return test; });
const a = 'a';
function test() { }
/* harmony default export */ __webpack_exports__["default"] = (a); }), "./src/b.js": (function (module, __webpack_exports__, __webpack_require__) {
"use strict"; __webpack_require__.r(__webpack_exports__); const b = 'b';
/* harmony default export */ __webpack_exports__["default"] = (b);
}), "./src/index.js": (function (module, __webpack_exports__, __webpack_require__) {
"use strict"; __webpack_require__.r(__webpack_exports__); /* harmony import */ var _a__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__("./src/a.js"); /* harmony import */ var _b__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__("./src/b.js");
console.log(_a__WEBPACK_IMPORTED_MODULE_0__["default"])
Object(_a__WEBPACK_IMPORTED_MODULE_0__["test"])();
console.log(_b__WEBPACK_IMPORTED_MODULE_1__["default"]) })}
复制代码


根据编译结果可以很明白的看出来,和 commonjs 编译出来的结果差不多,核心都是使用 __webpack_require__ 函数,区别在于 es 模块化,exports 对象首先就会被__webpack_require__.r标记为 es module,对于默认导出就是 exportsdefault 属性,对于具名导出使用 __webpack_require__.d 包装了一下,目的是让这些具名导出在模块之外只能读不能被修改(这是 es module 的特点)。

v5 的变化

但是为什么 default 没有被__webpack_require__.d 处理,这不合理啊。本来是使用的 webpack 4 打包的,然后换了 webpack 5 试了一下,webpack 5 打包的结果中 default 也被处理了,这可能是 webpack 4 的一个小 bug 吧。


webpack5 的编译结果有些许的不同,但是整个逻辑是没有变的:


两种模块化交互

webpack 是支持两种模块化代码共存的,虽然不建议这样做。首先我们先看一下他们互相导入的时候的导入结果是什么样的:




我们来看看 webpack 是如何实现的,先修改一下模块:


index.js


const { a, test } = require('./a')
复制代码


a.js


import b from './b'import * as bbb from './b'console.log(bbb)console.log(b)console.log(b.b)const a = 'a';function test() { }export default a;export { test };
复制代码


b.js


module.exports = {  b: () => { },  moduleName: 'b'}
复制代码

编译结果

{  "./src/a.js":    (function (module, __webpack_exports__, __webpack_require__) {
"use strict"; __webpack_require__.r(__webpack_exports__); /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "test", function () { return test; }); /* harmony import */ var _b__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__("./src/b.js"); /* harmony import */ var _b__WEBPACK_IMPORTED_MODULE_0___default = __webpack_require__.n(_b__WEBPACK_IMPORTED_MODULE_0__);
console.log(_b__WEBPACK_IMPORTED_MODULE_0__)
console.log(_b__WEBPACK_IMPORTED_MODULE_0___default.a)
console.log(_b__WEBPACK_IMPORTED_MODULE_0___default.a.b)
const a = 'a';
function test() { }
/* harmony default export */ __webpack_exports__["default"] = (a); }), "./src/b.js": (function (module, exports) {
module.exports = { b: () => { }, moduleName: 'b' } }), "./src/index.js": (function (module, exports, __webpack_require__) {
const { a, test } = __webpack_require__("./src/a.js") })}
复制代码


可以发现当通过 es 模块的方式去 import 一个 commonjs 模块时,就会把导入的模块进行一层包装,通过 __webpack_require__.n,主要目的应该是为了兼容 import * as obj from '....' 这样的语法。


该函数的具体实现:


__webpack_require__.n = function (module) {    var getter = module && module.__esModule     ? function getDefault() { return module['default']; }    : function getModuleExports() { return module; };    __webpack_require__.d(getter, 'a', getter);    return getter;}
复制代码

总结

webpack 中实现模块化的核心就是 __webpack_require__ 函数,无论是 commonjs 模块化还是 es 模块都是通过该函数来导入的。并且利用立即执行函数的特点实现了作用域的封闭避免了全局变量的污染,非常的巧妙。


用户头像

Geek_02d948

关注

还未添加个人签名 2022-09-08 加入

还未添加个人简介

评论

发布
暂无评论
webpack模块化的原理_JavaScript_Geek_02d948_InfoQ写作社区