小言_互联网的博客

手写 mini 版 Webpack

468人阅读  评论(0)

目录

1. mini 版 Webpack 打包流程

2. 创建 minipack.js

2.1 需要用到的插件库

2.1.1 babylon —— 解析 JavaScript 语法,生产 AST 语法树

2.1.2 babel-traverse —— 对 AST 进行遍历、转换的工具

2.1.3 transformFromAst —— 将 ES6、ES7 等高级的语法,转化为 ES5 的语法

2.2 读取文件内容,并提取它的依赖关系

2.3 递归获取项目的所有依赖(绘制项目依赖图谱)

2.4 自定义实现 require 方法,找到导出变量的引用逻辑

2.5 创建 dist 目录,将打包的内容写入 main.js 中

3. 测试 minipack.js

3.1 添加 minipack.js 同级文件/文件夹

3.2 初始化测试目录 example

3.3 完善 package.json,安装必要依赖

3.4 完善 index.html,填充打包文件

3.5 项目打包、打包效果展示

4. 分析打包生成的文件 dist/main.js

5. 真正的 Webpack 打包流程

6. Webpack 热更新(Hot Module Replacement)

6.1 什么是 Webpack 热更新?

6.2 热更新原理 —— WebSocket

7. 参考文章


Webpack 是前端最常用的构建工具之一,为了解 Webpack 整体打包流程中:需要做的事,需要输出的结果,因此手写 mini 版 Webpack

深入浅出 Webpack · 深入浅出 Webpackhttp://webpack.wuhaolin.cn/

1. mini 版 Webpack 打包流程

  • 从入口文件开始解析
  • 查找入口文件引入了哪些 JavaScript 文件,找到依赖关系
  • 递归遍历引入的其他 JavaScript 文件,生成最终的依赖关系图谱
  • 将 ES6 语法转化成 ES5
  • 最终生成一个可以在浏览器加载执行的 JavaScript 文件
  • mini 版 Webpack 未涉及 loader、plugin 等复杂功能,只是一个非常简化的例子

2. 创建 minipack.js

2.1 需要用到的插件库

2.1.1 babylon —— 解析 JavaScript 语法,生产 AST 语法树

// babylon 解析 JavaScript 语法,生产 AST 语法树(AST 能把 JavaScript 代码,转化为 JSON 数据结构)

const babylon = require('babylon');

2.1.2 babel-traverse —— 对 AST 进行遍历、转换的工具

// babel-traverse 是一个对 AST 进行遍历、转换的工具

const traverse = require('babel-traverse').default;

2.1.3 transformFromAst —— 将 ES6、ES7 等高级的语法,转化为 ES5 的语法

// 将 es6、es7 等高级的语法,转化为 es5 的语法

const { transformFromAst } = require('babel-core');

2.2 读取文件内容,并提取它的依赖关系


  
  1. // 每一个 JavaScript 文件,对应一个id
  2. let ID = 0;
  3. /**
  4. * 读取文件内容,并提取它的依赖关系
  5. * @param {*} filename 文件路径
  6. * @returns 文件id(唯一)、文件路径、文件的依赖关系、文件代码
  7. */
  8. function createAsset( filename) {
  9. const content = fs. readFileSync(filename, 'utf-8');
  10. // 获取该文件对应的 AST 抽象语法树
  11. const ast = babylon. parse(content, {
  12. sourceType: 'module',
  13. });
  14. // dependencies —— 保存 所依赖模块的 相对路径
  15. const dependencies = [];
  16. // 通过查找 import 节点,找到该文件的依赖关系(也就是文件中 import 的其他文件)
  17. traverse(ast, {
  18. ImportDeclaration: ({ node }) => {
  19. // 查找import节点
  20. dependencies. push(node. source. value);
  21. },
  22. });
  23. // 通过递增计数器,为此模块分配唯一标识符,用于缓存已解析过的文件
  24. const id = ID++;
  25. // 用 '@babel/preset-env' 将 代码 转换为 浏览器可以运行的内容
  26. const { code } = transformFromAst(ast, null, {
  27. // `presets` 选项是一组规则,告诉 `babel` 如何传输我们的代码
  28. presets: [ '@babel/preset-env'],
  29. });
  30. // 返回此模块的相关信息
  31. return {
  32. id, // 文件id(唯一)
  33. filename, // 文件路径
  34. dependencies, // 文件的依赖关系
  35. code, // 文件代码
  36. };
  37. }

2.3 递归获取项目的所有依赖(绘制项目依赖图谱)


  
  1. /**
  2. * 递归获取项目的所有依赖(绘制项目依赖图谱)
  3. * @description 从入口文件开始,递归读取各个依赖文件
  4. * @param {*} entry 项目入口文件
  5. * @returns
  6. */
  7. function createGraph( entry) {
  8. // 读取 入口文件 内容,并提取它的依赖关系
  9. const mainAsset = createAsset(entry);
  10. // 入口文件的信息(文件id(唯一)、文件路径、文件的依赖关系、文件代码),作为第一项放到数组里
  11. const queue = [mainAsset];
  12. for ( const asset of queue) {
  13. asset. mapping = {};
  14. // 获取 这个模块的 所在的目录
  15. const dirname = path. dirname(asset. filename);
  16. // 遍历 这个模块的 文件依赖关系
  17. asset. dependencies. forEach( (relativePath) => {
  18. /**
  19. * 获取 每个依赖文件的 绝对路径
  20. * 通过将相对路径与父资源目录的路径连接,将相对路径转变为绝对路径
  21. */
  22. const absolutePath = path. join(dirname, relativePath);
  23. // 递归解析其中所引入的其他资源
  24. const child = createAsset(absolutePath);
  25. asset. mapping[relativePath] = child. id;
  26. // 将 `child` 推入队列, 通过 递归 实现获取项目所有依赖
  27. queue. push(child);
  28. });
  29. }
  30. // queue这就是最终的依赖关系图谱
  31. return queue;
  32. }

2.4 自定义实现 require 方法,找到导出变量的引用逻辑


  
  1. /**
  2. * 自定义实现 require 方法,找到导出变量的引用逻辑
  3. * @param {*} graph 项目的所有依赖
  4. * @returns
  5. */
  6. function bundle( graph) {
  7. let modules = '';
  8. graph. forEach( (mod) => {
  9. modules += `${mod.id}: [
  10. function (require, module, exports) { ${mod.code} },
  11. ${JSON.stringify(mod.mapping)},
  12. ],`;
  13. });
  14. const result = `
  15. (function(modules) {
  16. function require(id) {
  17. const [fn, mapping] = modules[id];
  18. function localRequire(name) {
  19. return require(mapping[name]);
  20. }
  21. const module = { exports : {} };
  22. fn(localRequire, module, module.exports);
  23. return module.exports;
  24. }
  25. require(0);
  26. })({${modules}})
  27. `;
  28. return result;
  29. }

2.5 创建 dist 目录,将打包的内容写入 main.js 中


  
  1. // ❤️ 通过入口文件,递归获取项目的所有依赖
  2. const graph = createGraph( './example/entry.js');
  3. // 自定义实现 require 方法,找到导出变量的引用逻辑
  4. const result = bundle(graph);
  5. // 创建 dist 目录,将打包的内容写入 main.js 中
  6. fs. mkdir( 'dist', (err) => {
  7. if (!err) {
  8. fs. writeFile( 'dist/main.js', result, (err1) => {
  9. if (!err1) console. log( '打包成功');
  10. });
  11. }
  12. });

3. 测试 minipack.js

3.1 添加 minipack.js 同级文件/文件夹

在 minipack.js 同级的位置,添加:

  • example 文件夹(相当于真实项目文件)
  • package.json(使用 npm init -y 初始化)
  • index.html(引入 minipack 打包后的文件,并展示)

3.2 初始化测试目录 example

name.js

export const name = 'mini Webpack By Lyrelion';

message.js


  
  1. import { name } from './name.js';
  2. export default `hello ${name}!`;

entry.js(项目入口文件)


  
  1. import message from './message.js';
  2. // 创建 <p></p> DOM节点
  3. let p = document. createElement( 'p');
  4. // 将 message 的内容显示到页面中
  5. p. innerHTML = message;
  6. // 追加 DOM 节点
  7. document. body. appendChild(p);

3.3 完善 package.json,安装必要依赖

根据前面写 minipack.js 时用到的依赖,补充 package.json 文件


  
  1. {
  2. "name": "webpack",
  3. "version": "1.0.0",
  4. "description": "",
  5. "main": "entry.js",
  6. "scripts": {
  7. "test": "echo \"Error: no test specified\" && exit 1"
  8. },
  9. "keywords": [],
  10. "author": "",
  11. "license": "ISC",
  12. "dependencies": {
  13. "@babel/core": "^7.20.7",
  14. "@babel/preset-env": "^7.20.2",
  15. "babel-core": "^7.0.0-beta.41",
  16. "babel-traverse": "^6.26.0",
  17. "babylon": "^6.18.0",
  18. "fs": "^0.0.1-security",
  19. "path": "^0.12.7"
  20. }
  21. }

这里强调一下 babel,安装的时候报了很多错

解决方案:我是根据报错提示,调整 babel-core 版本,再重新安装,如下所示 

3.4 完善 index.html,填充打包文件

在 minipack.js 中,写死了打包后输出的文件位置,因此在 index.html 里写死即可


  
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8" />
  5. <title>mini Webpack </title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1" />
  7. </head>
  8. <body>
  9. <!-- 引入打包后的 main.js -->
  10. <script src="./dist/main.js"> </script>
  11. </body>
  12. </html>

3.5 项目打包、打包效果展示

打包前的目录结构:

执行打包命令:node minipack.js

打包成功后的目录结构:

打包效果:

4. 分析打包生成的文件 dist/main.js

main.js 里有一个立即执行函数,接收一个对象,该对象有三个属性

  • 0 代表entry.js;
  • 1 代表message.js;
  • 2 代表name.js

文件执行过程:

  • 从 require(0) 开始执行,调用内置的自定义 require 函数
  • 执行 fn 函数
  • 执行 require('./message.js'),执行 require(mapping['./message.js']),转化为 require(1),获取 modules[1],也就是执行 message.js 的内容
  • 执行 require('./name.js'),转化为 require(2),执行 name.js 的内容
  • 通过递归调用,将代码中导出的属性,放到 exports 对象中,一层层导出到最外层
  • 最终通过 _message["default"] 获取导出的值,页面显示 hello mini Webpack By Lyrelion!


  
  1. // 文件里是一个立即执行函数
  2. ( function ( modules) {
  3. function require( id) {
  4. const [fn, mapping] = modules[id];
  5. // ⬅️ 第四步 跳转到这里 此时 mapping[name] = 1,继续执行 require(1)
  6. // ⬅️ 第六步 又跳转到这里 此时 mapping[name] = 2,继续执行 require(2)
  7. function localRequire( name) {
  8. return require(mapping[name]);
  9. }
  10. const module = { exports: {} };
  11. // ⬅️ 第二步 执行 fn
  12. fn(localRequire, module, module. exports);
  13. return module. exports;
  14. }
  15. // ⬅️ 第一步 执行 require(0)
  16. require( 0);
  17. })({
  18. // entry.js
  19. 0: [
  20. function ( require, module, exports) {
  21. "use strict";
  22. // ⬅️ 第三步 跳转到这里 继续执行 require('./message.js')
  23. var _message = _interopRequireDefault( require( "./message.js"));
  24. function _interopRequireDefault( obj) { return obj && obj. __esModule ? obj : { "default": obj }; }
  25. // 创建 <p></p> DOM节点
  26. var p = document. createElement( 'p');
  27. // ⬅️ 最后一步 将内容写到 p 标签中
  28. // 将 message 的内容显示到页面中
  29. p. innerHTML = _message[ "default"];
  30. // 追加 DOM 节点
  31. document. body. appendChild(p);
  32. },
  33. { "./message.js": 1 },
  34. // message.js
  35. ], 1: [
  36. function ( require, module, exports) {
  37. "use strict";
  38. Object. defineProperty( exports, "__esModule", {
  39. value: true
  40. });
  41. exports[ "default"] = void 0;
  42. // ⬅️ 第五步 跳转到这里 继续执行 require('./name.js')
  43. var _name = require( "./name.js");
  44. var _default = "hello ". concat(_name. name, "!");
  45. // ⬅️ 第八步 跳到这里 此时 _name 为 {name: 'mini Webpack By Lyrelion'}, 在 exports 对象上设置 default 属性,值为 'hello mini Webpack By Lyrelion!'
  46. exports[ "default"] = _default;
  47. },
  48. { "./name.js": 2 },
  49. // name.js
  50. ], 2: [
  51. function ( require, module, exports) {
  52. "use strict";
  53. Object. defineProperty( exports, "__esModule", {
  54. value: true
  55. });
  56. exports. name = void 0;
  57. var name = 'mini Webpack By Lyrelion';
  58. // ⬅️ 第七步 跳到这里 在传入的 exports 对象上添加 name 属性,值为'mini Webpack By Lyrelion'
  59. exports. name = name;
  60. },
  61. {},
  62. ],
  63. })

5. 真正的 Webpack 打包流程

Webpack 从项目的 entry 入口文件开始递归分析,调用 Loader 对不同文件进行编译;因为 Webpack 默认只能识别 JavaScript 代码,所以 .css 文件、.vue 文件等,必须要通过 Loader 解析成 JavaScript 代码,才能被 Webpack 识别

利用 babel(babylon)将 JavaScript 代码转化为 AST 抽象语法树;

通过 babel-traverse 对 AST 抽象语法树 进行遍历,找到文件的 import 引用节点(依赖关系);因为 依赖文件 都是通过 import 的方式引入,所以找到 import 节点,就找到了文件的依赖关系

给 每个模块 生成唯一标识 ID,并将解析过的模块缓存起来;如果其他地方也引入该模块,就无需重新解析

根据依赖关系,生成依赖图谱,递归遍历所有依赖图谱的模块,组装成一个个包含多个模块的 Chunk(块);

最后,将生成的文件,输出到 output 目录中

6. Webpack 热更新(Hot Module Replacement)

刷新一般分为两种:

  • 一种是页面刷新,不保留页面状态,直接 window.location.reload()
  • 一种是基于 WDS(webpack-dev-server)的模块热替换,局部刷新页面上发生变化的模块,同时保留当前页面的状态,比如复选框的选中状态、输入框的输入等

6.1 什么是 Webpack 热更新?

开发过程中,代码改变后,Webpack 会重新编译,编译后浏览器替换修改的模块,无需刷新整个页面,就能进行局部更新,提升开发体验

HMR 作为 Webpack 内置的功能,可以通过 HotModuleReplacementPlugin 或 --hot 开启

6.2 热更新原理 —— WebSocket

基本原理:

  • 通过 WebSocket 实现,建立 本地服务 和 浏览器 的双向通信;
  • 当代码发生变化,并重新编译后,通知浏览器 重新请求 需要更新的模块,替换 原有的模块;

通过 webpack-dev-server 开启 server 服务,本地 server 启动之后,再去启动 WebSocket 服务,建立 本地服务 和 浏览器 的双向通信

Webpack 每次编译后,会生成一个 Hash 值,Hash 代表每一次编译的唯一标识。本次输出的 Hash 值会编译新生成的文件标识,被作为下次热更新的标识

Webpack 监听文件变化(通过 文件的生成时间 判断是否有变化),当文件变化后,重新编译

编译结束后,通知浏览器请求变化的资源,同时将新生成的 Hash 值传给浏览器,用于下次热更新使用

浏览器请求到最新的模块后,用新模块 替换 旧模块,从而实现 局部刷新

轻松理解webpack热更新原理 - 掘金一种是页面刷新,不保留页面状态,就是简单粗暴,直接window.location.reload()。 另一种是基于WDS (Webpack-dev-server)的模块热替换,只需要局部刷新页面上发生变化的模块,同时可以保留当前的页面状态,比如复选框的选中状态、输入框的输入等。…https://juejin.cn/post/6844904008432222215

7. 参考文章

带你深度解锁Webpack系列(基础篇) - 掘金

带你深度解锁Webpack系列(进阶篇) - 掘金

带你深度解锁Webpack系列(优化篇) - 掘金


转载:https://blog.csdn.net/Lyrelion/article/details/128497183
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场