JavaScript 中 Webpack 怎么编写自定义 Plugin 介入编译生命周期钩子执行自动化任务

落婷同学_4041

落婷同学_4041

2026-08-24

579人浏览

原创

webpack自定义plugin核心是通过tapable钩子系统在编译生命周期注入逻辑,必须实现apply方法并在compiler/compilation合适钩子上注册回调,理解其执行时机与参数。

javascript 中 webpack 怎么编写自定义 plugin 介入编译生命周期钩子执行自动化任务

Webpack 自定义 Plugin 的核心是通过 tapable 提供的钩子系统,在编译生命周期中注入逻辑,比如修改资源、生成文件、校验代码、清理目录等。它不是靠“写个类就行”,而是要正确声明 apply 方法 + 在合适钩子上注册回调,并理解钩子的执行时机和参数。

Plugin 基础结构:必须实现 apply 方法

所有 Webpack Plugin 都是一个带有 apply 方法的对象(函数或类实例均可),Webpack 在启动时会调用它,并传入 compiler 实例:

class MyPlugin {
  apply(compiler) {
    // 在这里监听 compiler 或 compilation 的钩子
  }
}

注意:apply 只执行一次,且发生在 Webpack 初始化阶段,此时还未开始读取入口、解析模块。

关键钩子分两类:Compiler 和 Compilation

Compiler 钩子全局生效,贯穿整个构建过程(如启动、完成、失败);Compilation 钩子在每次构建(含增量/热更新)中新建一个实例,用于操作模块、资源、chunk 等细节:

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载
  • Compiler 钩子示例:
    • run:构建开始前(可异步拦截,比如检查环境变量)
    • done:构建完全结束(含成功/失败),适合发通知、上传产物
    • emit:即将把资源写入输出目录前,可增删改 compilation.assets
  • Compilation 钩子示例:
    • buildModule:模块开始构建时(可读取源码、打日志)
    • succeedModule:模块构建成功后(适合分析 AST 或收集依赖)
    • optimizeChunks:chunk 优化阶段(可合并、拆分、标记 chunk)

在 emit 钩子中修改/注入资源(最常用场景)

想自动生成 version.json 或插入构建时间,应在 compiler.hooks.emit.tapAsync 中操作 compilation.assets:

class VersionPlugin {
  apply(compiler) {
    compiler.hooks.emit.tapAsync('VersionPlugin', (compilation, callback) => {
      const versionData = JSON.stringify({
        timestamp: new Date().toISOString(),
        hash: compilation.hash,
        version: '1.2.0'
      }, null, 2);

      // 注入虚拟文件(不会真实读磁盘,只参与输出)
      compilation.assets['version.json'] = {
        source: () => versionData,
        size: () => versionData.length
      };

      callback();
    });
  }
}

注意:tapAsync 表示钩子支持异步(需调用 callback);若同步逻辑用 tap 即可。

访问模块信息与 AST(需配合 Compilation 钩子)

如果要在打包时分析某个 JS 模块是否用了 eval 或 with,可在 compilation.hooks.succeedModule 中获取模块源码并解析:

compiler.hooks.thisCompilation.tap('AnalyzePlugin', (compilation) => {
  compilation.hooks.succeedModule.tap('AnalyzePlugin', (module) => {
    if (module.resource && module.resource.endsWith('.js')) {
      const source = module.originalSource?.source?.() || '';
      if (/eval\s*\(/.test(source)) {
        console.warn(`[Analyze] eval found in ${module.resource}`);
      }
    }
  });
});

⚠️ 注意:模块源码可能被 loader 处理过(如 Babel),如需原始内容,优先用 module.originalSource?.source();AST 分析建议用 @babel/parser 或 acorn,避免正则误判。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4386

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1109

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4284

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

880

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1756

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3165

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4113

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2660

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

868

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习