TypeScript 中 Webpack 怎么编写自定义 Plugin 监控构建生命周期

冬浩君_6733

冬浩君_6733

2026-07-31

266人浏览

原创

TypeScript 中编写 Webpack 自定义 Plugin 的核心是实现符合 Plugin API 的类并在关键钩子中插入逻辑:启动阶段(environment、entryOption)、编译阶段(compile、buildModule)、生成阶段(processAssets)、完成阶段(done、failed),需借助 @types/webpack 类型声明并注意钩子同步/异步用法及作用域差异。

typescript 中 webpack 怎么编写自定义 plugin 监控构建生命周期

在 TypeScript 中编写 Webpack 自定义 Plugin 来监控构建生命周期,核心是实现一个符合 Webpack Plugin API 的类或对象,并在合适钩子(Hook)中插入逻辑。关键不是“写个插件”,而是理解 Webpack 的编译流程和钩子触发时机,再用 TypeScript 类型安全地接入。

理解 Webpack 构建生命周期的关键钩子

Webpack 的构建过程由 Compiler 和 Compilation 两个核心对象驱动。监控通常关注以下阶段:

  • 启动阶段:如 compiler.hooks.environment、compiler.hooks.entryOption —— 配置解析完成、入口确定前
  • 编译阶段:如 compiler.hooks.compile(新 Compilation 开始)、compilation.hooks.buildModule(模块开始构建)
  • 生成阶段:如 compilation.hooks.processAssets(资产处理,推荐用于监控输出前状态)
  • 完成阶段:如 compiler.hooks.done(整个构建成功结束)、compiler.hooks.failed(构建出错)

用 TypeScript 编写基础监控插件

定义一个类,实现 apply 方法,在其中订阅所需钩子。TypeScript 提供了 webpack 包中的类型声明(需安装 @types/webpack):

import type { Compiler, Compilation, WebpackPluginInstance } from 'webpack';
<p>class BuildMonitorPlugin implements WebpackPluginInstance {
apply(compiler: Compiler) {
console.log('[BuildMonitor] 插件已加载');</p><pre class="brush:php;toolbar:false;">compiler.hooks.environment.tap('BuildMonitor', () => {
  console.log('[BuildMonitor] 环境初始化完成');
});

compiler.hooks.compile.tap('BuildMonitor', (params) => {
  console.log(`[BuildMonitor] 开始新编译(时间戳:${Date.now()})`);
});

compiler.hooks.done.tap('BuildMonitor', (stats) => {
  const time = stats.endTime - stats.startTime;
  console.log(`[BuildMonitor] 构建完成,耗时 ${time}ms`);
  console.log(`[BuildMonitor] 输出资源数:${stats.toJson().assets?.length || 0}`);
});

compiler.hooks.failed.tap('BuildMonitor', (error) => {
  console.error('[BuildMonitor] 构建失败:', error.message);
});

} }

export default BuildMonitorPlugin;

注意:tap 是同步钩子;若需异步逻辑(如写日志文件),可改用 tapAsync 或 tapPromise,并配合回调或 Promise。

监控模块级细节(如依赖图、资源大小)

想深入到每个模块的处理过程,需监听 compilation 实例上的钩子。在 compiler.hooks.compilation 中获取 compilation 引用:

Browser Js
Browser Js

轻量级CDP浏览器控制,适用于AI代理。相较于内置浏览器工具,token消耗降低3‑10倍,仅在浏览时使用。

下载
[BuildMonitor] 当前资产总大小:${(totalSize / 1024).toFixed(2)} KB

这里用到了 compilation.getAssets() 获取最终资源,比旧版 compilation.assets 更可靠(后者可能包含中间态内容)。

在 webpack.config.ts 中使用插件

确保配置文件是 TypeScript 格式(webpack.config.ts),并正确导入插件:

// webpack.config.ts
import type { Configuration } from 'webpack';
import BuildMonitorPlugin from './plugins/BuildMonitorPlugin';
<p>const config: Configuration = {
// ...其他配置
plugins: [new BuildMonitorPlugin()],
};</p><p>export default config;
</p>

如果使用 ESM,注意 Webpack 当前(v5)默认仍以 CommonJS 方式加载配置,建议导出为 module.exports 或确保 tsconfig 中 module 设置兼容(如 "module": "CommonJS")。

不复杂但容易忽略的是钩子执行顺序和作用域——compiler 钩子全局生效,compilation 钩子只对当次编译有效;多个插件间无默认顺序,需靠 tap 名称或 stage 控制优先级。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

typescript js vite javascript

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.06.20

4646

5

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

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

2023.07.04

1169

3

js四舍五入
js四舍五入

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

2023.07.04

4584

6

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

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

2023.09.01

920

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1836

5

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

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

2023.09.04

3325

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4313

6

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

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

2023.09.20

2820

5

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

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

2023.09.20

908

7

热门下载

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

精品课程

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

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.7万人学习