当前位置： 首页 > article >正文

webpack 执行流程 — 实现 myWebpack

article 2024/11/13 19:10:42

前言

实现 myWebpack 主要是为了更好的理解，webpack 中的工作流程，一切都是最简单的实现，不包含细节内容和边界处理，涉及到 ast 抽象语法树和编译代码部分，最好可以打印出来观察一下，方便后续的理解。

react 项目中的 webapck

为了更好的了解 Webpack 的执行流程，我们可以先通过观察 react 项目结构中，有关 webpack 的一些内容。当然我们得先拥有一个新的项目，可以通过下面的步骤得到：

  • 使用 【create-react-app 项目名称】命令创建项目
  • 进入对应的项目目录，运行 npm run eject 命令拉取，react 项目中和 webapck 相关的配置
    相比于正常的 react 项目，会多出来两个文件目录分别是 config 和 scripts

image.png

config 目录下主要存放的是 webpack 相关的配置内容：

image.png

scripts 目录下主要存放的是在 pakage.json 中存放的 3 个默认 script 脚本相关的内容:

image.png
image.png

主要看 scripts 目录下的 build.js 文件，这里面引入了 webpack 并且调用 webpack(config) 得到了 compiler 对象，最后使用了 compiler.run(callback) 的方式开始进行打包，代码中具体位置如下：

在这里插入图片描述

image.png

Webpack 执行流程

通过 react 项目中的目录结构结合以及 webpack 中的 Node 接口相关内容，可得到以下几个阶段：

  • 解析配置参数 —— 合并 shell 传入和 webpack.config.js 文件配置参数
  • 初始化 Compiler —— 通过 webpack(config) 得到 Compiler 对象，并注册所有配置插件，插件监听 webpack 构建生命周期的事件节点，做出相应处理
  • 开始编译 —— 调用 Compiler 对象 run() 方法开始执行编译
  • 确定入口 —— 根据配置的 entry 找出所有入口文件，开始解析文件，并构建 AST 语法树，找出依赖模块，进行递归处理
  • 编译模块 —— 递归中根据文件类型和 loader 配置，调用所有配置的 loader 对文件进行转换，再找出该模块依赖的模块，再递归本步骤，直到所有入口依赖的文件都经过了本步骤的处理
  • 完成模块编译 —— 模块编译结束后，得到每个文件结果，包含每个模块以及他们之间的依赖关系
  • 输出资源 —— 根据 entry 或分包配置生成代码块 chunk，再把每个 chunk 转换成一个单独的文件加入到输出列表

    PS：输出资源 这一步是修改输出内容的最后机会

  • 输出完成 —— 根据配置确定输出路径和命名，输出所有 chunk 到文件系统

核心流程图示：

实现 myWebpack

准备工作

根据 react 项目中的目录结构，可以得到一个简单 my-webpac 的项目结构：

  • config 目录 —— 存放的是 webpack.config.js 相关配置
  • script 目录 —— 存放的是 script 脚本需要执行的 js 文件
  • lib 目录 —— 存放的就是 myWebpack 库（需要自己实现）
  • src 目录 —— 就是 webpack.config.js 中默认的入口文件目录，其中的 index.js 为入口文件，其他的 js 文件均属于要测试打包的 js 模块

在后面的内容中为了更好的实现模块化，目录结构可能会稍微进行修改，最初的文件结构如下：

my-webpack
├─ config
│  └─ webpack.config.js
├─ lib
│  └─ myWebpack
│     └─ index.js
├─ package-lock.json
├─ package.json
├─ script
│  └─ build.js
└─ src
   ├─ add.js
   ├─ desc.js
   └─ index.js

开始实现

简单配置 config 目录下的 webpack.config.js

// config/webpack.config.js

module.exports = {
    entry: "./src/index.js",
    output: {
        path: 'dist',
        filename: 'index.js'
    }
};

实现 script 目录下的 build.js

这里只需要引入 myWebpack.js 和 webapck.config.js 文件，通过把配置内容 config 传入 myWebpack() 方法，并执行得到 compiler 对象，最终通过 compiler.run() 开始执行打包的处理程序

// script/build.js

const myWebpack  = require('../lib/myWebpack'); // 这里相当于 require('../lib/myWebpack/index.js')
const config  = require('../config/webpack.config.js');

//  获得 compiler 对象
const compiler = myWebpack(config);

// 开始打包
compiler.run();

实现 lib 目录下的 myWebpack 的具体内容（即其目录下的 index.js）

根据 build.js 中对 myWebpack 使用方式，可以知道在 myWebpack 必然是一个 function 且，其返回值必须是 Compiler 类的实例对象，毕竟被称为 compiler 对象。在这就出现了一个 Compiler 类的相关内容，为了更好的模块化，我们在 lib/myWebpack 目录下新建 compiler.js 文件，里面专门实现 Compiler 类的相关逻辑。

所以，在 lib/myWebpack/index.js 中的处理就是实现 myWebpack 函数，引入 Compiler 类并把 new Compiler(config) 的结果进行返回即可：

// lib/myWebpack/index.js

const Compiler = require('./Compiler.js')

function myWebpack(config) {
  return new Compiler(config)
}

module.exports = myWebpack

实现 lib 目录下 myWebpack 中的 compiler.js 内容

根据 build.js 中对 compiler 对象的使用方式，compiler.js 中必然会存在 Compiler 类 ，并且肯定存在 run() 方法，而且 run() 方法中需要处理的几件事可以归纳为：

  • 根据 entry 配置中的路径，将文件解析成 ast 抽象语法树
  • 根据 ast 收集依赖存放自定义 deps 对象上
  • 根据 ast 编译成可以在浏览器上正常运行的 code 内容
  • 以及把编译好的 code 通过 output 配置中的 path 和 filename 写入到文件系统
    其中，前三步属于编译解析的内容，因此，具体逻辑我们可以抽离到 lib/myWebpack/parser.js 中实现并向外暴露对应内容即可，并且放在 Compiler 类里面的 build()方法统一处理，最后一步输出资源可以抽离到 Compiler 类里面的 generate()方法中。
// lib/myWebpack/compiler.js

const { getAst, getDeps, getCode } = require('./parser.js')
const fs = require('fs')
const path = require('path')

class Compiler {
  constructor(options = {}) {
    // webpack 配置对象
    this.options = options
    // 所有依赖的容器
    this.modules = []
  }

  // 启动打包
  run() {
    // 获取 options 中的路径
    const filePath = this.options.entry

    // 首次构建，获取入口文件信息
    const fileInfo = this.build(filePath)

    // 保存文件信息
    this.modules.push(fileInfo)

    // 遍历所有依赖
    this.modules.forEach((fileInfo) => {

      // 获取当前文件所有依赖: { relativePath: absolutePath }
      const deps = fileInfo.deps
      for (const relativePath in deps) {
        // 获取对应绝对路径
        const absolutePath = deps[relativePath]
        // 对依赖文件进行打包处理
        const fileInfo = this.build(absolutePath)
        // 将打包后的结果保存到 modules 中，方便后面进行处理
        this.modules.push(fileInfo)
      }
      
    })

    // 将 modules 数组整理成更好的依赖关系图
    /*
      {
        'index.js': {
            'code': 'xxx',
             'deps': {
                [relativePath]: [absolutePath]
             } 
        }
      }
    */
    const depsGraph = this.modules.reduce(function (graph, module) {
      return {
        ...graph,
        [module.filePath]: {
          code: module.code,
          deps: module.deps,
        },
      }
    }, {})

    // 根据依赖关系图构建输出内容
    this.generate(depsGraph)
  }

  // 开始构建
  build(filePath) {
    // 将文件解析成 ast 抽象语法树
    const ast = getAst(filePath)

    // 根据 ast 收集依赖：{ relativePath: absolutePath }
    const deps = getDeps(ast, filePath)

    // 根据 ast 编译成 code
    const code = getCode(ast)

    return {
      filePath, // 当前文件路径
      deps, // 当前文件的所有依赖
      code, // 当前文件解析过的代码
    }
  }

  // 生成输出资源
  generate(depsGraph) {
    const bundle = `
        (function(depsGraph){

            // require 加载入口文件
            function require(module){

                // 定义暴露对象
                var exports = {};

                // require 内部在定义 localRequire 是为了让 require 递归
                function localRequire(relativePath){
                    // 找到引入模块的绝对路径，通过 require 进行加载
                    return require(depsGraph[module].deps[relativePath]);
                }

                (function(require, exports, code){
                    eval(code);
                })(localRequire, exports, depsGraph[module].code);

                // 作为 require 的返回值 —— 让后面的 require 函数能得到被暴露的内容
                return exports;
            }

            require('${this.options.entry}');

        })(${JSON.stringify(depsGraph)});
      `
    const { output } = this.options
    const dirPath = path.resolve(output.path)
    const filePath = path.join(dirPath, output.filename)

    // 如果指定目录不存在就创建目录
    if (!fs.existsSync(dirPath)) {
      fs.mkdirSync(dirPath)
    }

    // 写入文件
    fs.writeFileSync(filePath, bundle.trim(), 'utf-8')
  }
}

module.exports = Compiler
generate() 方法中 bundle 变量内容的解释
  • 外部包裹一个立即执行的匿名函数，主要就是为了生成独立作用域，实现 js 的模块化
  • 其中的 require() 方法，就是通过 eval 函数去执行，被编译后的 code，因为被编译后的 code 是字符串形式的 js 代码
  • require() 方法中的 localRequire () 方法实际上执行的还是 require() 方法本身，但对当前模块路径做了一定处理，这里其实就是递归
  • require() 方法中还有一个立即执行的匿名函数，接收三个参数：require, exports, code，其中 code 参数容易理解，但是为什么我们需要传递 require, exports 参数呢？
    • 这一点我们可以通过看被编译之后的 code 的内容就知道了，例如入口文件 index.js 和它里面引入 add.js 的编译结果 code 如下:
// index.js 内容编译结果 => 这里需要使用到 require 方法，因此外部必须传入
"'use strict';
var _add = _interopRequireDefault(require('./add.js'));
var _desc = _interopRequireDefault(require('./desc.js'));
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
console.log('add = ', (0, _add['default'])(1, 2));
console.log('desc = ', (0, _desc['default'])(3, 1));"

// add.js 内容编译结果 => 这里需要使用到 exports 对象，因此外部必须传入
"'use strict';
Object.defineProperty(exports, '__esModule', {  value: true});
exports['default'] = void 0;
function add(x, y) {  return x + y;}
var _default = add;
exports['default'] = _default;"

实现 lib 目录下 myWebpack 中的 parser.js 内容

这里需要做的就是下面的三件事：

  • 根据 entry 配置中的路径，将文件解析成 ast 抽象语法树，需要借助 @babel/parser 中的 parse 方法
  • 根据 ast 收集依赖存放自定义 deps 对象上，借助 @babel/traverse 遍历 ast 中的 program.body，方便在特定时机收集依赖
  • 根据 ast 编译成可以在浏览器上正常运行的 code 内容，需要借助 @babel/core 中的 transformFromAst 方法
// lib/myWebpack/parser.js

const babelParser = require('@babel/parser')
const { transformFromAst } = require('@babel/core')
const babelTraverse = require('@babel/traverse').default
const path = require('path')
const fs = require('fs')

const parser = {
  getAst(filePath) {
    // 通过 options.entry 读入口文件
    const file = fs.readFileSync(filePath, 'utf-8')

    // 将入口文件内容解析成 ast —— 抽象语法树
    const ast = babelParser.parse(file, {
      sourceType: 'module', // 处理被解析文件中的 ES module
    })

    return ast
  },

  getDeps(ast, filePath) {
    // 获取到文件所在文件夹的路径
    const dirname = path.dirname(filePath)
    // 存储依赖的容器
    const deps = {}

    // 根据 ast 收集依赖
    babelTraverse(ast, {
      // 内部会遍历 ast 中的 program.body，根据对应的语句类型进行执行
      // ImportDeclaration(code) 方法会在 type === "ImportDeclaration" 时触发
      ImportDeclaration({ node }) {
        // 获取当前文件的相对路径
        const relativePath = node.source.value
        // 添加依赖：{ relativePath: absolutePath }
        deps[relativePath] = path.resolve(dirname, relativePath)
      },
    })
    return deps
  },

  getCode(ast) {
    // 编译代码: 将浏览器中不能被识别的语法进行编译
    const { code } = transformFromAst(ast, null, {
      presets: ['@babel/preset-env'],
    })
    return code
  },
}

module.exports = parser

最终的目录结构

my-webpack
├─ config
│  └─ webpack.config.js
├─ lib
│  └─ myWebpack
│     ├─ compiler.js
│     ├─ index.js
│     └─ parser.js
├─ package-lock.json
├─ package.json
├─ README.md
├─ script
│  └─ build.js
└─ src
   ├─ add.js
   ├─ desc.js
   └─ index.js

http://www.kler.cn/a/387852.html

相关文章：

  • Android中桌面小部件的开发流程及常见问题和解决方案
  • Java的dto,和多表的调用
  • java模拟键盘实现selenium上下左右键 table中的左右滚动条实现滚动
  • 使用 Visual Studio Installer 彻底卸载 Visual Studio方法与下载
  • springboot项目中，使用ProGuard 对代码进行混淆
  • Linux设置socks代理
  • L1-4【例7-4①】 求最小值及其下标
  • ArrayList扩容机制
  • vue链接跳转
  • bert-base-uncased使用
  • 阐述对于鸿蒙生态未来的发展趋势的看法
  • 智慧教学资源管理：SpringBoot与Vue的强强联合
  • 15分钟学 Go 第 42 天：RESTful API设计
  • 【入门篇】确定字符串是否包含唯一字符——多语言版本
  • 机器学习系列----深入理解Transformer模型
  • C++顶层const与底层const
  • 【需求变更】使用 Redis 和 Lua 脚本实现变更后方案编号的生成
  • Linux下通过sqlplus连Oracle提示字符是乱码▒▒▒[
  • 什么是 eCPRI，它对 5G 和 Open RAN 有何贡献？
  • 设计模式-七个基本原则之一-迪米特法则 + 案例
  • 【WRF模拟】全过程总结：WPS预处理及WRF运行
  • Mybatis拦截器中获取@RequestBody表单的值修改查询SQL
  • redis的部署方式详解
  • 「QT」几何数据类 之 QLine 整型直线类
  • IP可用端口扫描器工具（bun + typescript）
  • Debezium系列之：Debezium 中的增量快照