重构人生

外观

Plugin 插件

约 3110 字大约 10 分钟

2025-03-15

深入浅出 webpack

webpack 就像一条生产线，要经过一系列处理流程后才能将源文件转换成输出结果。 这条生产线上的每个处理流程的职责都是单一的，多个流程之间有存在依赖关系，只有完成当前处理后才能交给下一个流程去处理。

Plugin 就像是一个插入到生产线中的一个功能，在特定的时机对生产线上的资源做处理。webpack 通过 Tapable 来组织这条复杂的生产线。 webpack 在运行过程中会广播事件，插件只需要监听它所关心的 Tapable 事件，就能加入到这条生产线中，去改变生产线的运作。

Plugin 的作用

通过插件我们可以扩展 webpack，加入自定义的构建行为，使 webpack 可以执行更广泛的任务，拥有更强的构建能力。

工作原理

webpack 在编译代码过程中，会触发一系列 Tapable 钩子事件，Plugin 所做的，就是找到相应的钩子，挂上对应的处理逻辑，也就是注册事件。然后在 webpack 构建的时候，Plugin 注册的事件就会随着钩子的触发而执行了。

webpack 的事件流机制保证了插件的有序性，使得整个系统扩展性很好。

Tapable（内部钩子）

1、什么是钩子

钩子的本质就是：事件。为了方便我们直接介入和控制编译过程，webpack 把编译过程中触发的各类关键事件封装成事件接口暴露了出来。这些接口被很形象地称做：hooks（钩子）。开发插件，离不开这些钩子。 :::

2、有哪些钩子

Tapable 为 webpack 提供了统一的插件接口（钩子）类型定义，它是 webpack 的核心功能库。webpack 中目前有十种 hooks，他们是：

1、SyncHook（同步钩子）

  • 特点：同步执行，无返回值。
  • 应用场景：简单的事件通知。
const { SyncHook } = require("tapable");
const hook = new SyncHook(["arg"]);
hook.tap("Plugin1", (arg) => console.log(`Plugin1: ${arg}`));
hook.call("Hello"); // 输出: Plugin1: Hello

2. SyncBailHook（同步熔断钩子）

  • 特点：同步执行，若某个监听器返回非 undefined 值，则终止后续执行。
  • 应用场景：条件阻断逻辑（如模块解析）。
const hook = new SyncBailHook(["arg"]);
hook.tap("Plugin1", (arg) => (arg === "stop" ? "Blocked" : undefined));
hook.tap("Plugin2", () => console.log("Never reached"));
const result = hook.call("stop"); // result = 'Blocked'

3. SyncWaterfallHook（同步瀑布钩子）

  • 特点：同步执行，前一个监听器的返回值作为下一个监听器的输入。
  • 应用场景：数据链式处理（如 Loader 传参）。
const hook = new SyncWaterfallHook(["arg"]);
hook.tap("Plugin1", (arg) => arg + " World");
hook.tap("Plugin2", (arg) => arg + "!");
const result = hook.call("Hello"); // result = 'Hello World!'

4. SyncLoopHook（同步循环钩子）

  • 特点：同步执行，若监听器返回非 undefined，则循环执行该监听器。
  • 应用场景：动态重试逻辑（如文件编译失败重试）。
const hook = new SyncLoopHook(["arg"]);
let count = 0;
hook.tap("Plugin1", (arg) => {
  count++;
  return count < 3 ? "Retry" : undefined;
});
hook.call(); // Plugin1 会执行 3 次

5. AsyncParallelHook（异步并行钩子）

  • 特点：异步并行执行所有监听器，通过回调或 Promise 通知完成。
  • 应用场景：并行任务（如多文件压缩）。
const hook = new AsyncParallelHook(["arg"]);
hook.tapAsync("Plugin1", (arg, done) => {
  setTimeout(() => {
    console.log("Plugin1");
    done();
  }, 1000);
});
hook.callAsync(() => console.log("All done"));

6. AsyncParallelBailHook（异步并行熔断钩子）

  • 特点：异步并行执行，任一监听器返回非 undefined 则立即终止。
  • 应用场景：快速失败策略（如资源加载超时）。
const hook = new AsyncParallelBailHook(["arg"]);
hook.tapPromise("Plugin1", async (arg) => {
  return arg === "fail" ? Promise.reject("Error") : undefined;
});
hook.promise("fail").catch(console.log); // 输出: Error

7. AsyncSeriesHook（异步串行钩子）

  • 特点：异步串行执行，按注册顺序依次触发。
  • 应用场景：依赖前序结果的异步操作（如插件初始化）。
const hook = new AsyncSeriesHook(["arg"]);
hook.tapPromise("Plugin1", (arg) => Promise.resolve(arg + 1));
hook.tapPromise("Plugin2", (arg) => Promise.resolve(arg * 2));
hook.promise(1).then(console.log); // 输出: 4 (1+1=2, 2*2=4)

8. AsyncSeriesBailHook（异步串行熔断钩子）

  • 特点：异步串行执行，任一监听器返回非 undefined 则终止。
  • 应用场景：异步条件阻断（如缓存命中检查）。
const hook = new AsyncSeriesBailHook(["arg"]);
hook.tapAsync("Plugin1", (arg, done) => done(null, "Cache Hit"));
hook.callAsync("key", (err, result) => console.log(result)); // 输出: Cache Hit

9. AsyncSeriesWaterfallHook（异步瀑布钩子）

  • 特点：异步串行执行，前一个监听器的结果传递给下一个。
  • 应用场景：链式异步处理（如 Webpack 的模块构建流程）。
const hook = new AsyncSeriesWaterfallHook(["arg"]);
hook.tapPromise("Plugin1", (arg) => Promise.resolve(arg.toUpperCase()));
hook.tapPromise("Plugin2", (arg) => Promise.resolve(arg + "!"));
hook.promise("hello").then(console.log); // 输出: HELLO!

10. AsyncSeriesLoopHook（异步循环钩子）

  • 特点：异步串行循环执行，直到所有监听器返回 undefined。
  • 应用场景：动态重试直到满足条件（如请求重试）。
const hook = new AsyncSeriesLoopHook(["arg"]);
let retry = 0;
hook.tapPromise("Plugin1", async (arg) => {
  retry++;
  return retry < 3 ? "Retry" : undefined;
});
hook.promise().then(() => console.log(`Retried ${retry} times`)); // 输出: Retried 3 times

3、如何注册钩子

Tapable 还统一暴露了三个方法给插件，用于注入不同类型的自定义构建行为：

  • tap：可以注册同步钩子和异步钩子。
  • tapAsync：回调方式注册异步钩子。
  • tapPromise：Promise 方式注册异步钩子。

构建对象

1、Compiler 环境信息

compiler 对象中保存着完整的 Webpack 环境配置，每次启动 webpack 构建时它都是一个独一无二，仅仅会创建一次的对象。

这个对象会在首次启动 Webpack 时创建，我们可以通过 compiler 对象上访问到 Webapck 的主环境配置，比如 loader 、 plugin 等等配置信息。

它有以下主要属性：

  • compiler.options：可以访问本次启动 webpack 时候所有的配置文件，包括但不限于 loaders 、 entry 、 output 、 plugin 等等完整配置信息。
  • compiler.inputFileSystem 和 compiler.outputFileSystem：可以进行文件操作，相当于 Nodejs 中 fs。
  • compiler.hooks：可以注册 tapable 的不同种类 Hook，从而可以在 compiler 生命周期中植入不同的逻辑。

compiler hooks 文档

2、Compilation 构建上下文

compilation 对象代表一次资源的构建，compilation 实例能够访问所有的模块和它们的依赖。

一个 compilation 对象会对构建依赖图中所有模块，进行编译。 在编译阶段，模块会被加载(load)、封存(seal)、优化(optimize)、 分块(chunk)、哈希(hash)和重新创建(restore)。

它有以下主要属性：

  • compilation.modules：可以访问所有模块，打包的每一个文件都是一个模块。
  • compilation.chunks：chunk 即是多个 modules 组成而来的一个代码块。入口文件引入的资源组成一个 chunk，通过代码分割的模块又是另外的 chunk。
  • compilation.assets：可以访问本次打包生成所有文件的结果。
  • compilation.hooks：可以注册 tapable 的不同种类 Hook，用于在 compilation 编译模块阶段进行逻辑添加以及修改。

compilation hooks 文档

生命周期简图

Webpack 插件生命周期

开发一个插件

最简单的插件

  • plugins/test-plugin.js
class TestPlugin {
  constructor() {
    console.log("TestPlugin constructor()");
  }
  // 1. webpack读取配置时，new TestPlugin() ，会执行插件 constructor 方法
  // 2. webpack创建 compiler 对象
  // 3. 遍历所有插件，调用插件的 apply 方法
  apply(compiler) {
    console.log("TestPlugin apply()");
  }
}

module.exports = TestPlugin;

注册 hook

class TestPlugin {
  constructor() {
    console.log("TestPlugin constructor()");
  }
  // 1. webpack读取配置时，new TestPlugin() ，会执行插件 constructor 方法
  // 2. webpack创建 compiler 对象
  // 3. 遍历所有插件，调用插件的 apply 方法
  apply(compiler) {
    console.log("TestPlugin apply()");

    // 从文档可知, compile hook 是 SyncHook, 也就是同步钩子, 只能用tap注册
    compiler.hooks.compile.tap("TestPlugin", (compilationParams) => {
      console.log("compiler.compile()");
    });

    // 从文档可知, make 是 AsyncParallelHook, 也就是异步并行钩子, 特点就是异步任务同时执行
    // 可以使用 tap、tapAsync、tapPromise 注册。
    // 如果使用tap注册的话，进行异步操作是不会等待异步操作执行完成的。
    compiler.hooks.make.tap("TestPlugin", (compilation) => {
      setTimeout(() => {
        console.log("compiler.make() 111");
      }, 2000);
    });

    // 使用tapAsync、tapPromise注册，进行异步操作会等异步操作做完再继续往下执行
    compiler.hooks.make.tapAsync("TestPlugin", (compilation, callback) => {
      setTimeout(() => {
        console.log("compiler.make() 222");
        // 必须调用
        callback();
      }, 1000);
    });

    compiler.hooks.make.tapPromise("TestPlugin", (compilation) => {
      console.log("compiler.make() 333");
      // 必须返回promise
      return new Promise((resolve) => {
        resolve();
      });
    });

    // 从文档可知, emit 是 AsyncSeriesHook, 也就是异步串行钩子，特点就是异步任务顺序执行
    compiler.hooks.emit.tapAsync("TestPlugin", (compilation, callback) => {
      setTimeout(() => {
        console.log("compiler.emit() 111");
        callback();
      }, 3000);
    });

    compiler.hooks.emit.tapAsync("TestPlugin", (compilation, callback) => {
      setTimeout(() => {
        console.log("compiler.emit() 222");
        callback();
      }, 2000);
    });

    compiler.hooks.emit.tapAsync("TestPlugin", (compilation, callback) => {
      setTimeout(() => {
        console.log("compiler.emit() 333");
        callback();
      }, 1000);
    });
  }
}

module.exports = TestPlugin;

启动调试

通过调试查看 compiler 和 compilation 对象数据情况。

  1. package.json 配置指令

    {
  "name": "source",
  "version": "1.0.0",
  "scripts": {
    "debug": "node --inspect-brk ./node_modules/webpack-cli/bin/cli.js"
  },
  "keywords": [],
  "author": "xiongjian",
  "license": "ISC",
  "devDependencies": {
    "@babel/core": "^7.17.10",
    "@babel/preset-env": "^7.17.10",
    "css-loader": "^6.7.1",
    "loader-utils": "^3.2.0",
    "webpack": "^5.72.0",
    "webpack-cli": "^4.9.2"
  }
}

  2. 运行指令

    npm run debug

    此时控制台输出以下内容：

    PS C:\Users\86176\Desktop\source> npm run debug

> source@1.0.0 debug
> node --inspect-brk ./node_modules/webpack-cli/bin/cli.js

Debugger listening on ws://127.0.0.1:9229/629ea097-7b52-4011-93a7-02f83c75c797
For help, see: https://nodejs.org/en/docs/inspecto

  3. 打开 Chrome 浏览器，F12 打开浏览器调试控制台。

    此时控制台会显示一个绿色的图标

    调试控制台

  4. 点击绿色的图标进入调试模式。

  5. 在需要调试代码处用 debugger 打断点，代码就会停止运行，从而调试查看数据情况。

案例

BannerWebpackPlugin

  1. 作用：给打包输出文件添加注释。

  2. 开发思路:

    • 需要打包输出前添加注释：需要使用 compiler.hooks.emit 钩子, 它是打包输出前触发。
    • 如何获取打包输出的资源？compilation.assets 可以获取所有即将输出的资源文件。

  3. 实现：

    // plugins/banner-webpack-plugin.js
class BannerWebpackPlugin {
  constructor(options = {}) {
    this.options = options;
  }

  apply(compiler) {
    // 需要处理文件
    const extensions = ["js", "css"];

    // emit是异步串行钩子
    compiler.hooks.emit.tapAsync(
      "BannerWebpackPlugin",
      (compilation, callback) => {
        // compilation.assets包含所有即将输出的资源
        // 通过过滤只保留需要处理的文件
        const assetPaths = Object.keys(compilation.assets).filter((path) => {
          const splitted = path.split(".");
          return extensions.includes(splitted[splitted.length - 1]);
        });

        assetPaths.forEach((assetPath) => {
          const asset = compilation.assets[assetPath];

          const source = `/*
* Author: ${this.options.author}
*/\n${asset.source()}`;

          // 覆盖资源
          compilation.assets[assetPath] = {
            // 资源内容
            source() {
              return source;
            },
            // 资源大小
            size() {
              return source.length;
            },
          };
        });

        callback();
      }
    );
  }
}

module.exports = BannerWebpackPlugin;

CleanWebpackPlugin

  1. 作用：在 webpack 打包输出前将上次打包内容清空。

  2. 开发思路：

    • 如何在打包输出前执行？需要使用 compiler.hooks.emit 钩子, 它是打包输出前触发。
    • 如何清空上次打包内容？
      • 获取打包输出目录：通过 compiler 对象。
      • 通过文件操作清空内容：通过 compiler.outputFileSystem 操作文件。

  3. 实现：

// plugins/clean-webpack-plugin.js
class CleanWebpackPlugin {
  apply(compiler) {
    // 获取操作文件的对象
    const fs = compiler.outputFileSystem;
    // emit是异步串行钩子
    compiler.hooks.emit.tapAsync(
      "CleanWebpackPlugin",
      (compilation, callback) => {
        // 获取输出文件目录
        const outputPath = compiler.options.output.path;
        // 删除目录所有文件
        const err = this.removeFiles(fs, outputPath);
        // 执行成功err为undefined，执行失败err就是错误原因
        callback(err);
      }
    );
  }

  removeFiles(fs, path) {
    try {
      // 读取当前目录下所有文件
      const files = fs.readdirSync(path);

      // 遍历文件，删除
      files.forEach((file) => {
        // 获取文件完整路径
        const filePath = `${path}/${file}`;
        // 分析文件
        const fileStat = fs.statSync(filePath);
        // 判断是否是文件夹
        if (fileStat.isDirectory()) {
          // 是文件夹需要递归遍历删除下面所有文件
          this.removeFiles(fs, filePath);
        } else {
          // 不是文件夹就是文件，直接删除
          fs.unlinkSync(filePath);
        }
      });

      // 最后删除当前目录
      fs.rmdirSync(path);
    } catch (e) {
      // 将产生的错误返回出去
      return e;
    }
  }
}

module.exports = CleanWebpackPlugin;

AnalyzeWebpackPlugin

  1. 作用：分析 webpack 打包资源大小，并输出分析文件。

  2. 开发思路:

    • 在哪做? compiler.hooks.emit, 它是在打包输出前触发，我们需要分析资源大小同时添加上分析后的 md 文件。

  3. 实现：

// plugins/analyze-webpack-plugin.js
class AnalyzeWebpackPlugin {
  apply(compiler) {
    // emit是异步串行钩子
    compiler.hooks.emit.tap("AnalyzeWebpackPlugin", (compilation) => {
      // Object.entries将对象变成二维数组。二维数组中第一项值是key，第二项值是value
      const assets = Object.entries(compilation.assets);

      let source = "# 分析打包资源大小 \n| 名称 | 大小 |\n| --- | --- |";

      assets.forEach(([filename, file]) => {
        source += `\n| ${filename} | ${file.size()} |`;
      });

      // 添加资源
      compilation.assets["analyze.md"] = {
        source() {
          return source;
        },
        size() {
          return source.length;
        },
      };
    });
  }
}

module.exports = AnalyzeWebpackPlugin;

InlineChunkWebpackPlugin

  1. 作用：webpack 打包生成的 runtime 文件太小了，额外发送请求性能不好，所以需要将其内联到 js 中，从而减少请求数量。

  2. 开发思路:

    • 我们需要借助 html-webpack-plugin 来实现
      • 在 html-webpack-plugin 输出 index.html 前将内联 runtime 注入进去
      • 删除多余的 runtime 文件
    • 如何操作 html-webpack-plugin？官方文档

  3. 实现：

// plugins/inline-chunk-webpack-plugin.js
const HtmlWebpackPlugin = require("safe-require")("html-webpack-plugin");

class InlineChunkWebpackPlugin {
  constructor(tests) {
    this.tests = tests;
  }

  apply(compiler) {
    compiler.hooks.compilation.tap(
      "InlineChunkWebpackPlugin",
      (compilation) => {
        const hooks = HtmlWebpackPlugin.getHooks(compilation);

        hooks.alterAssetTagGroups.tap("InlineChunkWebpackPlugin", (assets) => {
          assets.headTags = this.getInlineTag(
            assets.headTags,
            compilation.assets
          );
          assets.bodyTags = this.getInlineTag(
            assets.bodyTags,
            compilation.assets
          );
        });

        hooks.afterEmit.tap("InlineChunkHtmlPlugin", () => {
          Object.keys(compilation.assets).forEach((assetName) => {
            if (this.tests.some((test) => assetName.match(test))) {
              delete compilation.assets[assetName];
            }
          });
        });
      }
    );
  }

  getInlineTag(tags, assets) {
    return tags.map((tag) => {
      if (tag.tagName !== "script") return tag;

      const scriptName = tag.attributes.src;

      if (!this.tests.some((test) => scriptName.match(test))) return tag;

      return {
        tagName: "script",
        innerHTML: assets[scriptName].source(),
        closeTag: true,
      };
    });
  }
}

module.exports = InlineChunkWebpackPlugin;

更新日志

2025/8/24 08:17
查看所有更新日志
  • e7112-1于