讲师中心 微信公众号
AI工具推荐 视频效率加速

JavaScript 中 Webpack 怎么编写自定义 Plugin 监听钩子

阿涛同学_6896

阿涛同学_6896

发布时间:2026-08-20 17:16:27

|

211人浏览过

|

来源于php中文网

原创

Webpack自定义Plugin的核心是通过监听compiler和compilation的钩子介入构建流程:compiler代表全局构建环境,适合run、done等全局事件;compilation代表单次构建实例,适合操作assets、chunks等资源。

javascript 中 webpack 怎么编写自定义 plugin 监听钩子

Webpack 自定义 Plugin 的核心是通过监听编译生命周期中的钩子(Hooks)来介入构建流程。Plugin 本质是一个带有 apply 方法的对象,Webpack 在编译不同阶段会调用注册的钩子回调,你只需在 apply 中使用 compiler.hooks.xxx.tap 或 compilation.hooks.xxx.tap 绑定逻辑即可。

理解 compiler 和 compilation 两个关键对象

compiler 是 Webpack 启动时创建的全局实例,代表整个构建环境,生命周期长(一次构建只一个),适合监听全局事件如 run、done、emit。
compilation 是每次构建(含增量构建)生成的实例,包含当前构建的所有资源、模块、依赖等信息,生命周期短,适合操作资源、修改 assets、处理 chunk 等。

  • 在 compiler.hooks.run.tap 中可做构建前初始化(如清空目录、读取配置)
  • 在 compilation.hooks.seal.tap 中可访问已生成但未输出的 chunk 和 modules
  • 在 compilation.hooks.processAssets.tap 中可读写最终输出的 assets(推荐用 Compilation.PROCESS_ASSETS_STAGE_ADDITIONAL 等阶段常量控制时机)

编写一个基础 Plugin 示例:注入构建时间到 HTML

假设你想在每个 HTML 输出文件开头插入一行构建时间,可用 compilation.hooks.processAssets 钩子:

class InjectBuildTimePlugin {
  apply(compiler) {
    compiler.hooks.thisCompilation.tap('InjectBuildTimePlugin', (compilation) => {
      compilation.hooks.processAssets.tap(
        {
          name: 'InjectBuildTimePlugin',
          stage: compilation.constructor.PROCESS_ASSETS_STAGE_ADDITIONAL
        },
        () => {
          for (const filename of Object.keys(compilation.assets)) {
            if (filename.endsWith('.html')) {
              const originalSource = compilation.assets[filename].source();
              const now = new Date().toISOString();
              const newSource = `<!-- Build time: ${now} -->\n${originalSource}`;
              compilation.assets[filename] = {
                source: () => newSource,
                size: () => newSource.length
              };
            }
          }
        }
      );
    });
  }
}

注意:必须用 thisCompilation 钩子获取 compilation 实例;processAssets 需指定 stage 保证执行顺序;修改 assets 要重写 source() 和 size() 方法。

立即学习“Java免费学习笔记(深入)”;

常用钩子与适用场景对照

不必死记所有钩子,按目的选常用几个即可:

  • compiler.hooks.run → 构建开始前(如检查环境变量、连接远程服务)
  • compiler.hooks.emit → 所有 assets 生成完毕、写入磁盘前(适合最后校验或添加文件)
  • compilation.hooks.optimizeChunks → Chunk 优化阶段(可合并、拆分 chunk)
  • compilation.hooks.chunkAsset → 每个 chunk 生成 asset 后(适合按 chunk 注入 runtime)
  • compilation.hooks.afterSeal → Seal 完成后(此时 modules/chunks 已确定,适合统计分析)

调试 Plugin 的实用技巧

Plugin 逻辑不易调试,建议:

  • 在回调函数里加 console.log,配合 webpack --watch 观察触发时机
  • 用 debugger 断点,启动时加 node --inspect node_modules/webpack/bin/webpack.js
  • 打印关键对象结构,例如 console.dir(compilation.chunks, { depth: 2 })
  • 优先使用 tap 而非 tapAsync 或 tapPromise,除非真需异步(如请求 API),否则易出错

热门AI工具

更多
讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

相关专题

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

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

4866

2023.06.20

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

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

1209

2023.07.04

js四舍五入
js四舍五入

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

4784

2023.07.04

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

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

940

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

1876

2023.09.04

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

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

3445

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

4473

2023.09.12

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

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

2940

2023.09.20

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

0

2026.10.15

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn