本文开始我会围绕webpack和babel写一系列的工程化文章，这两个工具我虽然天天用，但是对他们的原理理解的其实不是很深入，写这些文章的过程其实也是我深入学习的过程。由于webpack和babel的体系太大，知识点众多，不可能一篇文章囊括所有知识点，目前我的计划是从简单入手，先实现一个最简单的可以运行的webpack，然后再看看plugin, loader和tree shaking等功能。目前我计划会有这些文章：
- 手写最简
webpack，也就是本文 webpack的plugin实现原理webpack的loader实现原理webpack的tree shaking实现原理webpack的HMR实现原理babel和ast原理
所有文章都是原理或者源码解析，欢迎关注~
本文可运行代码已经上传GitHub，大家可以拿下来玩玩：https://github.com/dennis-jiang/Front-End-Knowledges/tree/master/Examples/Engineering/mini-webpack
注意：本文主要讲webpack原理，在实现时并不严谨，而且只处理了import和export的default情况，如果你想在生产环境使用，请自己添加其他情况的处理和边界判断。
为什么要用webpack
笔者刚开始做前端时，其实不知道什么webpack，也不懂模块化，都是html里面直接写script，引入jquery直接干。所以如果一个页面的JS需要依赖jquery和lodash，那html可能就长这样：
这样写会导致几个问题：
- 单独看
index.js不能清晰的找到他到底依赖哪些外部库 script的顺序必须写正确，如果错了就会导致找不到依赖，直接报错- 模块间通信困难，基本都靠往
window上注入变量来暴露给外部 - 浏览器严格按照
script标签来下载代码，有些没用到的代码也会下载下来 - 当前端规模变大，JS脚本会显得很杂乱，项目管理混乱
webpack的一个最基本的功能就是来解决上述的情况，允许在JS里面通过import或者require等关键字来显式申明依赖，可以引用第三方库，自己的JS代码间也可以相互引用，这样在实质上就实现了前端代码的模块化。由于历史问题，老版的JS并没有自己模块管理方案，所以社区提出了很多模块管理方案，比如ES2015的import，CommonJS的require，另外还有AMD，CMD等等。就目前我见到的情况来说，import因为已经成为ES2015标准，所以在客户端广泛使用，而require是Node.js的自带模块管理机制，也有很广泛的用途，而AMD和CMD的使用已经很少见了。
但是webpack作为一个开放的模块化工具，他是支持ES6，CommonJS和AMD等多种标准的，不同的模块化标准有不同的解析方法，本文只会讲ES6标准的import方案，这也是客户端JS使用最多的方案。
简单例子
按照业界惯例，我也用hello world作为一个简单的例子，但是我将这句话拆成了几部分，放到了不同的文件里面。
先来建一个hello.js，只导出一个简单的字符串：
const hello = 'hello';
export default hello;然后再来一个helloWorld.js，将hello和world拼成一句话，并导出拼接的这个方法：
import hello from './hello';
const world = 'world';
const helloWorld = () => `${hello} ${world}`;
export default helloWorld;最后再来个index.js，将拼好的hello world插入到页面上去：
import helloWorld from "./helloWorld";
const helloWorldStr = helloWorld();
function component() {
const element = document.createElement("div");
element.innerHTML = helloWorldStr;
return element;
}
document.body.appendChild(component());现在如果你直接在html里面引用index.js是不能运行成功的，因为大部分浏览器都不支持import这种模块导入。而webpack就是来解决这个问题的，它会将我们模块化的代码转换成浏览器认识的普通JS来执行。
引入webpack
我们印象中webpack的配置很多，很麻烦，但那是因为我们需要开启的功能很多，如果只是解析转换import，配置起来非常简单。
先把依赖装上吧，这没什么好说的：
// package.json { "devDependencies": { "webpack": "^5.4.0", "webpack-cli": "^4.2.0" }, }为了使用方便，再加个
build脚本吧：// package.json { "scripts": { "build": "webpack" }, }最后再简单写下
webpack的配置文件就好了：// webpack.config.js const path = require("path"); module.exports = { mode: "development", devtool: 'source-map', entry: "./src/index.js", output: { filename: "main.js", path: path.resolve(__dirname, "dist"), }, };这个配置文件里面其实只要指定了入口文件
entry和编译后的输出文件目录output就可以正常工作了，这里这个配置的意思是让webpack从./src/index.js开始编译，编译后的文件输出到dist/main.js这个文件里面。这个配置文件上还有两个配置
mode和devtool只是我用来方便调试编译后的代码的，mode指定用哪种模式编译，默认是production，会对代码进行压缩和混淆，不好读，所以我设置为development；而devtool是用来控制生成哪种粒度的source map，简单来说，想要更好调试，就要更好的，更清晰的source map，但是编译速度变慢；反之，想要编译速度快，就要选择粒度更粗，更不好读的source map，webpack提供了很多可供选择的source map，具体的可以看他的文档。然后就可以在
dist下面建个index.html来引用编译后的代码了：// index.html- 运行下
yarn build就会编译我们的代码，然后打开index.html就可以看到效果了。
深入原理
前面讲的这个例子很简单，一般也满足不了我们实际工程中的需求，但是对于我们理解原理却是一个很好的突破口，毕竟webpack这么庞大的一个体系，我们也不能一口吃个胖子，得一点一点来。
webpack把代码编译成了啥？
为了弄懂他的原理，我们可以直接从编译后的代码入手，先看看他长啥样子，有的朋友可能一提到去看源码，心理就没底，其实我以前也是这样的。但是完全没有必要惧怕，他编译后的代码浏览器能够执行，那肯定就是普通的JS代码，不会藏着这么黑科技。
下面是编译完的代码截图：
虽然我们只有三个简单的JS文件，但是加上webpack自己的逻辑，编译后的文件还是有一百多行代码，所以即使我把具体逻辑折叠起来了，这个截图还是有点长，为了能够看清楚他的结构，我将它分成了4个部分，标记在了截图上，下面我们分别来看看这几个部分吧。
- 第一部分其实就是一个对象
__webpack_modules__，这个对象里面有三个属性，属性名字是我们三个模块的文件路径，属性的值是一个函数，我们随便展开一个./src/helloWorld.js看下：
我们发现这个代码内容跟我们自己写的
helloWorld.js非常像：
他只是在我们的代码前先调用了
__webpack_require__.r和__webpack_require__.d，这两个辅助函数我们在后面会看到。然后对我们的代码进行了一点修改，将我们的
import关键字改成了__webpack_require__函数，并用一个变量_hello__WEBPACK_IMPORTED_MODULE_0__来接收了import进来的内容，后面引用的地方也改成了这个，其他跟这个无关的代码，比如const world = 'world';还是保持原样的。这个
__webpack_modules__对象存了所有的模块代码，其实对于模块代码的保存，在不同版本的webpack里面实现的方式并不一样，我这个版本是5.4.0，在4.x的版本里面好像是作为数组存下来，然后在最外层的立即执行函数里面以参数的形式传进来的。但是不管是哪种方式，都只是转换然后保存一下模块代码而已。 第二块代码的核心是
__webpack_require__，这个代码展开，瞬间给了我一种熟悉感：
来看一下这个流程吧：
- 先定义一个变量
__webpack_module_cache__作为加载了的模块的缓存 __webpack_require__其实就是用来加载模块的- 加载模块时，先检查缓存中有没有，如果有，就直接返回缓存
- 如果缓存没有，就从
__webpack_modules__将对应的模块取出来执行 __webpack_modules__就是上面第一块代码里的那个对象，取出的模块其实就是我们自己写的代码，取出执行的也是我们每个模块的代码- 每个模块执行除了执行我们的逻辑外，还会将
export的内容添加到module.exports上，这就是前面说的__webpack_require__.d辅助方法的作用。添加到module.exports上其实就是添加到了__webpack_module_cache__缓存上，后面再引用这个模块就直接从缓存拿了。
这个流程我太熟悉了，因为他简直跟
Node.js的CommonJS实现思路一模一样，具体的可以看我之前写的这篇文章：深入Node.js的模块加载机制，手写require函数。- 先定义一个变量
第三块代码其实就是我们前面看到过的几个辅助函数的定义，具体干啥的，其实他的注释已经写了：
__webpack_require__.d：核心其实是Object.defineProperty，主要是用来将我们模块导出的内容添加到全局的__webpack_module_cache__缓存上。
__webpack_require__.o：其实就是Object.prototype.hasOwnProperty的一个简写而已。
__webpack_require__.r：这个方法就是给每个模块添加一个属性__esModule，来表明他是一个ES6的模块。
- 第四块就一行代码，调用
__webpack_require__加载入口模块，启动执行。
这样我们将代码分成了4块，每块的作用都搞清楚，其实webpack干的事情就清晰了：
- 将
import这种浏览器不认识的关键字替换成了__webpack_require__函数调用。 __webpack_require__在实现时采用了类似CommonJS的模块思想。- 一个文件就是一个模块，对应模块缓存上的一个对象。
- 当模块代码执行时，会将
export的内容添加到这个模块对象上。 - 当再次引用一个以前引用过的模块时，会直接从缓存上读取模块。
自己实现一个webpack
现在webpack到底干了什么事情我们已经清楚了，接下来我们就可以自己动手实现一个了。根据前面最终生成的代码结果，我们要实现的代码其实主要分两块：
- 遍历所有模块，将每个模块代码读取出来，替换掉
import和export关键字，放到__webpack_modules__对象上。 - 整个代码里面除了
__webpack_modules__和最后启动的入口是变化的，其他代码，像__webpack_require__，__webpack_require__.r这些方法其实都是固定的，整个代码结构也是固定的，所以完全可以先定义好一个模板。
使用AST解析代码
由于我们需要将import这种代码转换成浏览器能识别的普通JS代码，所以我们首先要能够将代码解析出来。在解析代码的时候，可以将它读出来当成字符串替换，也可以使用更专业的AST来解析。AST全称叫Abstract Syntax Trees，也就是抽象语法树，是一个将代码用树来表示的数据结构，一个代码可以转换成AST，AST又可以转换成代码，而我们熟知的babel其实就可以做这个工作。要生成AST很复杂，涉及到编译原理，但是如果仅仅拿来用就比较简单了，本文就先不涉及复杂的编译原理，而是直接将babel生成好的AST拿来使用。
注意： webpack源码解析AST并不是使用的babel，而是使用的acorn，webpack继承acorn的Parser，自己实现了一个JavascriptParser，本文写作时采用了babel，这也是一个大家更熟悉的工具。
比如我先将入口文件读出来，然后用babel转换成AST可以直接这样写：
const fs = require("fs");
const parser = require("@babel/parser");
const config = require("../webpack.config"); // 引入配置文件
// 读取入口文件
const fileContent = fs.readFileSync(config.entry, "utf-8");
// 使用babel parser解析AST
const ast = parser.parse(fileContent, { sourceType: "module" });
console.log(ast); // 把ast打印出来看看上面代码可以将生成好的ast打印在控制台：
这虽然是一个完整的AST，但是看起来并不清晰，关键数据其实是body字段，这里的body也只是展示了类型名字。所以照着这个写代码其实不好写，这里推荐一个在线工具https://astexplorer.net/，可以很清楚的看到每个节点的内容：
从这个解析出来的AST我们可以看到，body主要有4块代码：
ImportDeclaration：就是第一行的import定义VariableDeclaration：第三行的一个变量申明FunctionDeclaration：第五行的一个函数定义ExpressionStatement：第十三行的一个普通语句
你如果把每个节点展开，会发现他们下面又嵌套了很多其他节点，比如第三行的VariableDeclaration展开后，其实还有个函数调用helloWorld()：
使用traverse遍历AST
对于这样一个生成好的AST，我们可以使用@babel/traverse来对他进行遍历和操作，比如我想拿到ImportDeclaration进行操作，就直接这样写：
// 使用babel traverse来遍历ast上的节点
traverse(ast, {
ImportDeclaration(path) {
console.log(path.node);
},
});上面代码可以拿到所有的import语句：
将import转换为函数调用
前面我们说了，我们的目标是将ES6的import：
import helloWorld from "./helloWorld";转换成普通浏览器能识别的函数调用：
var _helloWorld__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__("./src/helloWorld.js");为了实现这个功能，我们还需要引入@babel/types，这个库可以帮我们创建新的AST节点，所以这个转换代码写出来就是这样：
const t = require("@babel/types");
// 使用babel traverse来遍历ast上的节点
traverse(ast, {
ImportDeclaration(p) {
// 获取被import的文件
const importFile = p.node.source.value;
// 获取文件路径
let importFilePath = path.join(path.dirname(config.entry), importFile);
importFilePath = `./${importFilePath}.js`;
// 构建一个变量定义的AST节点
const variableDeclaration = t.variableDeclaration("var", [
t.variableDeclarator(
t.identifier(
`__${path.basename(importFile)}__WEBPACK_IMPORTED_MODULE_0__`
),
t.callExpression(t.identifier("__webpack_require__"), [
t.stringLiteral(importFilePath),
])
),
]);
// 将当前节点替换为变量定义节点
p.replaceWith(variableDeclaration);
},
});上面这段代码我们用了很多@babel/types下面的API，比如t.variableDeclaration，t.variableDeclarator，这些都是用来创建对应的节点的，具体的API可以看这里。注意这个代码里面我有很多写死的地方，比如importFilePath生成逻辑，还应该处理多种后缀名的，还有最终生成的变量名_${path.basename(importFile)}__WEBPACK_IMPORTED_MODULE_0__，最后的数字我也是直接写了0，按理来说应该是根据不同的import顺序来生成的，但是本文主要讲webpack的原理，这些细节上我就没花过多时间了。
上面的代码其实是修改了我们的AST，修改后的AST可以用@babel/generator又转换为代码：
const generate = require('@babel/generator').default;
const newCode = generate(ast).code;
console.log(newCode);这个打印结果是：
可以看到这个结果里面import helloWorld from "./helloWorld";已经被转换为var __helloWorld__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__("./src/helloWorld.js");。
替换import进来的变量
前面我们将import语句替换成了一个变量定义，变量名字也改为了__helloWorld__WEBPACK_IMPORTED_MODULE_0__，自然要将调用的地方也改了。为了更好的管理，我们将AST遍历，操作以及最后的生成新代码都封装成一个函数吧。
function parseFile(file) {
// 读取入口文件
const fileContent = fs.readFileSync(file, "utf-8");
// 使用babel parser解析AST
const ast = parser.parse(fileContent, { sourceType: "module" });
let importFilePath = "";
// 使用babel traverse来遍历ast上的节点
traverse(ast, {
ImportDeclaration(p) {
// 跟之前一样的
},
});
const newCode = generate(ast).code;
// 返回一个包含必要信息的新对象
return {
file,
dependcies: [importFilePath],
code: newCode,
};
}然后启动执行的时候就可以调这个函数了
parseFile(config.entry);拿到的结果跟之前的差不多：
好了，现在需要将使用import的地方也替换了，因为我们已经知道了这个地方是将它作为函数调用的，也就是要将
const helloWorldStr = helloWorld();转为这个样子：
const helloWorldStr = (0,_helloWorld__WEBPACK_IMPORTED_MODULE_0__.default)();这行代码的效果其实跟_helloWorld__WEBPACK_IMPORTED_MODULE_0__.default()是一样的，为啥在前面包个(0, )，我也不知道，有知道的大佬告诉下我呗。
所以我们在traverse里面加一个CallExpression：
traverse(ast, {
ImportDeclaration(p) {
// 跟前面的差不多，省略了
},
CallExpression(p) {
// 如果调用的是import进来的函数
if (p.node.callee.name === importVarName) {
// 就将它替换为转换后的函数名字
p.node.callee.name = `${importCovertVarName}.default`;
}
},
});这样转换后，我们再重新生成一下代码，已经像那么个样子了：
递归解析多个文件
现在我们有了一个parseFile方法来解析处理入口文件，但是我们的文件其实不止一个，我们应该依据模块的依赖关系，递归的将所有的模块都解析了。要实现递归解析也不复杂，因为前面的parseFile的依赖dependcies已经返回了：
- 我们创建一个数组存放文件的解析结果，初始状态下他只有入口文件的解析结果
- 根据入口文件的解析结果，可以拿到入口文件的依赖
- 解析所有的依赖，将结果继续加到解析结果数组里面
- 一直循环这个解析结果数组，将里面的依赖文件解析完
- 最后将解析结果数组返回就行
写成代码就是这样：
function parseFiles(entryFile) {
const entryRes = parseFile(entryFile); // 解析入口文件
const results = [entryRes]; // 将解析结果放入一个数组
// 循环结果数组，将它的依赖全部拿出来解析
for (const res of results) {
const dependencies = res.dependencies;
dependencies.map((dependency) => {
if (dependency) {
const ast = parseFile(dependency);
results.push(ast);
}
});
}
return results;
}然后就可以调用这个方法解析所有文件了：
const allAst = parseFiles(config.entry);
console.log(allAst);看看解析结果吧：
这个结果其实跟我们最终需要生成的__webpack_modules__已经很像了，但是还有两块没有处理：
一个是
import进来的内容作为变量使用，比如import hello from './hello'; const world = 'world'; const helloWorld = () => `${hello} ${world}`;- 另一个就是
export语句还没处理
替换import进来的变量(作为变量调用)
前面我们已经用CallExpression处理过作为函数使用的import变量了，现在要处理作为变量使用的其实用Identifier处理下就行了，处理逻辑跟之前的CallExpression差不多：
traverse(ast, {
ImportDeclaration(p) {
// 跟以前一样的
},
CallExpression(p) {
// 跟以前一样的
},
Identifier(p) {
// 如果调用的是import进来的变量
if (p.node.name === importVarName) {
// 就将它替换为转换后的变量名字
p.node.name = `${importCovertVarName}.default`;
}
},
});现在再运行下，import进来的变量名字已经变掉了：
替换export语句
从我们需要生成的结果来看，export需要进行两个处理：
- 如果一个文件有
export default，需要添加一个__webpack_require__.d的辅助方法调用，内容都是固定的，加上就行。 - 将
export语句转换为普通的变量定义。
对应生成结果上的这两个：
要处理export语句，在遍历ast的时候添加ExportDefaultDeclaration就行了：
traverse(ast, {
ImportDeclaration(p) {
// 跟以前一样的
},
CallExpression(p) {
// 跟以前一样的
},
Identifier(p) {
// 跟以前一样的
},
ExportDefaultDeclaration(p) {
hasExport = true; // 先标记是否有export
// 跟前面import类似的，创建一个变量定义节点
const variableDeclaration = t.variableDeclaration("const", [
t.variableDeclarator(
t.identifier("__WEBPACK_DEFAULT_EXPORT__"),
t.identifier(p.node.declaration.name)
),
]);
// 将当前节点替换为变量定义节点
p.replaceWith(variableDeclaration);
},
});然后再运行下就可以看到export语句被替换了：
然后就是根据hasExport变量判断在AST转换为代码的时候要不要加__webpack_require__.d辅助函数：
const EXPORT_DEFAULT_FUN = `
__webpack_require__.d(__webpack_exports__, {
"default": () => (__WEBPACK_DEFAULT_EXPORT__)
});\n
`;
function parseFile(file) {
// 省略其他代码
// ......
let newCode = generate(ast).code;
if (hasExport) {
newCode = `${EXPORT_DEFAULT_FUN} ${newCode}`;
}
}最后生成的代码里面export也就处理好了：
把__webpack_require__.r的调用添上吧
前面说了，最终生成的代码，每个模块前面都有个__webpack_require__.r的调用
这个只是拿来给模块添加一个__esModule标记的，我们也给他加上吧，直接在前面export辅助方法后面加点代码就行了：
const ESMODULE_TAG_FUN = `
__webpack_require__.r(__webpack_exports__);\n
`;
function parseFile(file) {
// 省略其他代码
// ......
let newCode = generate(ast).code;
if (hasExport) {
newCode = `${EXPORT_DEFAULT_FUN} ${newCode}`;
}
// 下面添加模块标记代码
newCode = `${ESMODULE_TAG_FUN} ${newCode}`;
}再运行下看看，这个代码也加上了：
创建代码模板
到现在，最难的一块，模块代码的解析和转换我们其实已经完成了。下面要做的工作就比较简单了，因为最终生成的代码里面，各种辅助方法都是固定的，动态的部分就是前面解析的模块和入口文件。所以我们可以创建一个这样的模板，将动态的部分标记出来就行，其他不变的部分写死。这个模板文件的处理，你可以将它读进来作为字符串处理，也可以用模板引擎，我这里采用ejs模板引擎：
// 模板文件，直接从webpack生成结果抄过来，改改就行
/******/ (() => { // webpackBootstrap
/******/ "use strict";
// 需要替换的__TO_REPLACE_WEBPACK_MODULES__
/******/ var __webpack_modules__ = ({
<% __TO_REPLACE_WEBPACK_MODULES__.map(item => { %>
'<%- item.file %>' :
((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
<%- item.code %>
}),
<% }) %>
});
// 省略中间的辅助方法
/************************************************************************/
/******/ // startup
/******/ // Load entry module
// 需要替换的__TO_REPLACE_WEBPACK_ENTRY
/******/ __webpack_require__('<%- __TO_REPLACE_WEBPACK_ENTRY__ %>');
/******/ // This entry module used 'exports' so it can't be inlined
/******/ })()
;
//# sourceMappingURL=main.js.map生成最终的代码
生成最终代码的思路就是：
- 模板里面用
__TO_REPLACE_WEBPACK_MODULES__来生成最终的__webpack_modules__ - 模板里面用
__TO_REPLACE_WEBPACK_ENTRY__来替代动态的入口文件 webpack代码里面使用前面生成好的AST数组来替换模板的__TO_REPLACE_WEBPACK_MODULES__webpack代码里面使用前面拿到的入口文件来替代模板的__TO_REPLACE_WEBPACK_ENTRY__- 使用
ejs来生成最终的代码
所以代码就是：
// 使用ejs将上面解析好的ast传递给模板
// 返回最终生成的代码
function generateCode(allAst, entry) {
const temlateFile = fs.readFileSync(
path.join(__dirname, "./template.js"),
"utf-8"
);
const codes = ejs.render(temlateFile, {
__TO_REPLACE_WEBPACK_MODULES__: allAst,
__TO_REPLACE_WEBPACK_ENTRY__: entry,
});
return codes;
}大功告成
最后将ejs生成好的代码写入配置的输出路径就行了：
const codes = generateCode(allAst, config.entry);
fs.writeFileSync(path.join(config.output.path, config.output.filename), codes);然后就可以使用我们自己的webpack来编译代码，最后就可以像之前那样打开我们的html看看效果了：
总结
本文使用简单质朴的方式讲述了webpack的基本原理，并自己手写实现了一个基本的支持import和export的default的webpack。
本文可运行代码已经上传GitHub，大家可以拿下来玩玩：https://github.com/dennis-jiang/Front-End-Knowledges/tree/master/Examples/Engineering/mini-webpack
下面再就本文的要点进行下总结：
webpack最基本的功能其实是将JS的高级模块化语句，import和require之类的转换为浏览器能认识的普通函数调用语句。- 要进行语言代码的转换，我们需要对代码进行解析。
- 常用的解析手段是
AST，也就是将代码转换为抽象语法树。 AST是一个描述代码结构的树形数据结构，代码可以转换为AST，AST也可以转换为代码。babel可以将代码转换为AST，但是webpack官方并没有使用babel，而是基于acorn自己实现了一个JavascriptParser。- 本文从
webpack构建的结果入手，也使用AST自己生成了一个类似的代码。 webpack最终生成的代码其实分为动态和固定的两部分，我们将固定的部分写入一个模板，动态的部分在模板里面使用ejs占位。- 生成代码动态部分需要借助
babel来生成AST，并对其进行修改，最后再使用babel将其生成新的代码。 - 在生成
AST时，我们从配置的入口文件开始，递归的解析所有文件。即解析入口文件的时候，将它的依赖记录下来，入口文件解析完后就去解析他的依赖文件，在解析他的依赖文件时，将依赖的依赖也记录下来，后面继续解析。重复这种步骤，直到所有依赖解析完。 - 动态代码生成好后，使用
ejs将其写入模板，以生成最终的代码。 - 如果要支持
require或者AMD，其实思路是类似的，最终生成的代码也是差不多的，主要的差别在AST解析那一块。
参考资料
文章的最后，感谢你花费宝贵的时间阅读本文，如果本文给了你一点点帮助或者启发，请不要吝啬你的赞和GitHub小星星，你的支持是作者持续创作的动力。
欢迎关注我的公众号进击的大前端第一时间获取高质量原创~
“前端进阶知识”系列文章源码地址： https://github.com/dennis-jiang/Front-End-Knowledges
