Webpack5入门到原理18：Plugin 原理

Plugin 的作用

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

Plugin 工作原理

webpack 就像一条生产线，要经过一系列处理流程后才能将源文件转换成输出结果。 这条生产线上的每个处理流程的职责都是单一的，多个流程之间有存在依赖关系，只有完成当前处理后才能交给下一个流程去处理。
插件就像是一个插入到生产线中的一个功能，在特定的时机对生产线上的资源做处理。webpack 通过 Tapable 来组织这条复杂的生产线。 webpack 在运行过程中会广播事件，插件只需要监听它所关心的事件，就能加入到这条生产线中，去改变生产线的运作。
webpack 的事件流机制保证了插件的有序性，使得整个系统扩展性很好。
——「深入浅出 Webpack」

站在代码逻辑的角度就是：webpack 在编译代码过程中，会触发一系列 Tapable 钩子事件，插件所做的，就是找到相应的钩子，往上面挂上自己的任务，也就是注册事件，这样，当 webpack 构建的时候，插件注册的事件就会随着钩子的触发而执行了。

Webpack 内部的钩子

什么是钩子

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

Tapable

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

// https://github.com/webpack/tapable/blob/master/lib/index.js
exports.SyncHook = require("./SyncHook");
exports.SyncBailHook = require("./SyncBailHook");
exports.SyncWaterfallHook = require("./SyncWaterfallHook");
exports.SyncLoopHook = require("./SyncLoopHook");
exports.AsyncParallelHook = require("./AsyncParallelHook");
exports.AsyncParallelBailHook = require("./AsyncParallelBailHook");
exports.AsyncSeriesHook = require("./AsyncSeriesHook");
exports.AsyncSeriesBailHook = require("./AsyncSeriesBailHook");
exports.AsyncSeriesLoopHook = require("./AsyncSeriesLoopHook");
exports.AsyncSeriesWaterfallHook = require("./AsyncSeriesWaterfallHook");
exports.HookMap = require("./HookMap");
exports.MultiHook = require("./MultiHook");

Plugin 构建对象

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 文档

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 文档

开发一个插件

最简单的插件

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");// 必须返回promisereturn 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 对象数据情况。

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"}
}

运行指令

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.jsDebugger listening on ws://127.0.0.1:9229/629ea097-7b52-4011-93a7-02f83c75c797
For help, see: https://nodejs.org/en/docs/inspecto

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

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

调试控制台

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

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

BannerWebpackPlugin

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

开发思路:

需要打包输出前添加注释：需要使用 compiler.hooks.emit 钩子, 它是打包输出前触发。

如何获取打包输出的资源？compilation.assets 可以获取所有即将输出的资源文件。

实现：

// 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

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

开发思路：

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

实现：

// 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

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

开发思路:

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

实现：

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

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

开发思路:

1、我们需要借助 html-webpack-plugin 来实现

  • 在 html-webpack-plugin 输出 index.html 前将内联 runtime 注入进去
  • 删除多余的 runtime 文件

2、如何操作 html-webpack-plugin？官方文档

实现：

// 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;

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/637538.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

VScode新增设备实现无感接入（不需要输入密码）

VScode新增设备实现无感接入（不需要输入密码）

VScode远程开发接入设备，默认是需要输入密码的，但是日常开发中刷新就需要重新输入密码，很烦人。配置ssh的RSA密钥后会，就可以直接系统级别验证接入，对开发人员来说验证步骤就透明了，实现无感接入&#xff0…
阅读更多...
多线程

多线程

Linux系统的多线程 1. Linux线程概念1.1 什么是线程1.2 页表的概念1.2.1 一级页表的缺点1.2.2 二级页表 1.3 线程的优缺点1.4 线程异常1.5 线程用途1.6 Linux进程VS线程 2. Linux线程控制2.1 创建线程2.2 线程ID及地址空间布局2.3 线程终止2.3.1 线程函数处进行return2.3.2 使用…
阅读更多...
数据结构---队列(Queue)

数据结构---队列(Queue)

一、基本概念 队列是一种线性数据结构 二、特点 队列是"先进先出(FIFO---First In First Out)"(买饭排队:先排队的先买饭,买完饭就退出队列,准备买饭从队尾进入队列排队) 规定只能从一端(队尾)添加元素,从另一端(队首)取出元素 三、基本操作 定义一个接口,里面实…
阅读更多...
Java安全 CC链1分析

Java安全 CC链1分析

Java安全之CC链1分析 什么是CC链环境搭建jdk下载idea配置创建项目 前置知识Transformer接口ConstantTransformer类invokerTransformer类ChainedTransformer类 构造CC链1CC链1核心demo1demo1分析 寻找如何触发CC链1核心TransformedMap类AbstractInputCheckedMapDecorator类readO…
阅读更多...
响应式Web开发项目教程（HTML5+CSS3+Bootstrap）第2版 例4-6 fieldset

响应式Web开发项目教程（HTML5+CSS3+Bootstrap）第2版 例4-6 fieldset

代码 <!doctype html> <html> <head> <meta charset"utf-8"> <title>fieldset</title> </head><body> <form action"#"><fieldset><legend>学生信息</legend>姓名&#xff1a;&…
阅读更多...
2024PMP考试新考纲-【过程领域】近期典型真题和很详细解析（8）

2024PMP考试新考纲-【过程领域】近期典型真题和很详细解析（8）

华研荟继续为您分享【过程Process领域】的新考纲下的真题&#xff0c;今天来看几道关于风险方面的PMP真题&#xff0c;帮助大家体会和理解新考纲下PMP的考试特点和如何应用所学的知识和常识&#xff08;经验&#xff09;来解题&#xff0c;并且举一反三&#xff0c;一次性3A通过…
阅读更多...
WordPress怎么去除jquery和CSS静态文件链接中的版本号？附2种方法

WordPress怎么去除jquery和CSS静态文件链接中的版本号？附2种方法

我们很多WordPress网站默认情况下所加载的jquery和CSS静态文件链接中都会带有相应的版本号&#xff0c;比如boke112百科使用的YIA主题&#xff0c;加载CSS文件时就会在链接地址后面加上?ver2.7&#xff0c;即是style.css?ver2.7 除了CSS文件会加上版本号外&#xff0c;加载主…
阅读更多...
[小程序]样式与配置

[小程序]样式与配置

一、外部样式导入 使用import加外部样式表的相对路径并以 ; 表示语句结束。 import "common.wxss"; 二、全局样式和局部样式 全局样式位于app.wxss中&#xff0c;会作用于整个项目中所有页面中。 局部样式位于对应的wxss文件中&#xff0c;仅作用于当前页面&#x…
阅读更多...
【项目搭建三】SpringBoot引入redis

【项目搭建三】SpringBoot引入redis

添加依赖 本文使用spring data redis访问和操作redis&#xff0c;pom文件中加入以下依赖&#xff1a; <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </depende…
阅读更多...
python入门，文件的编码，读取，写入，追加

python入门，文件的编码，读取，写入，追加

目录 1.文件的编码 2.文件的读取 1.open&#xff08;&#xff09;函数打开文件 2.rede&#xff08;&#xff09;读取文件 3.readlines&#xff08;&#xff09;方法 4.readline&#xff08;&#xff09;方法 5.for循环读取 3.文件的关闭 withopen语法 4.文件的写入 1.…
阅读更多...
基于华为MRS3.2.0实时Flink消费Kafka落盘至HDFS的Hive外部表的调度方案

基于华为MRS3.2.0实时Flink消费Kafka落盘至HDFS的Hive外部表的调度方案

文章目录 1 Kafka1.1 Kerberos安全模式的认证与环境准备1.2 创建一个测试主题1.3 消费主题的接收测试 2 Flink1.1 Kerberos安全模式的认证与环境准备1.2 Flink任务的开发 3 HDFS与Hive3.1 Shell脚本的编写思路3.2 脚本测试方法 4 DolphinScheduler 该需求为实时接收对手Topic&a…
阅读更多...
如何使用callable和future创建异步任务？在Java中如何管理依赖？

如何使用callable和future创建异步任务？在Java中如何管理依赖？

在Python中&#xff0c;可以使用concurrent.futures模块中的Callable和Future类来创建异步任务。以下是一个简单的例子&#xff1a; import concurrent.futures# 定义一个可调用对象&#xff08;Callable&#xff09;def long_running_task(n):return n * n# 创建一个线程池执行…
阅读更多...
使用vscode在wsl2中配置clangd环境

使用vscode在wsl2中配置clangd环境

在vscode中安装这三个插件&#xff08;clangd需要科学上网或者从VSIX安装&#xff09; 之后创建一个空目录并进去。 使用快捷键ctrlshiftp&#xff0c;输入命令 Cmake:Quick Start 根据步骤选择。注意在创建CMakeLists.txt这一步选择跳过&#xff0c;直接输入enter&#xff0c…
阅读更多...
c# 释放所有嵌入资源, 到某个本地文件夹

c# 释放所有嵌入资源, 到某个本地文件夹

版本号 .net 8 代码 using System.Reflection;namespace Demo;internal class Program {static void Main(string[] args){// 获取当前 执行exe 的目录 / 当前命令行所在的目录 var currentDir Directory.GetCurrentDirectory();Console.WriteLine(currentDir);Extract…
阅读更多...
Linux 驱动开发基础知识——认识LED驱动程序 （二）

Linux 驱动开发基础知识——认识LED驱动程序 （二）

个人名片&#xff1a; &#x1f981;作者简介&#xff1a;一名喜欢分享和记录学习的在校大学生 &#x1f42f;个人主页&#xff1a;妄北y &#x1f427;个人QQ&#xff1a;2061314755 &#x1f43b;个人邮箱&#xff1a;2061314755qq.com &#x1f989;个人WeChat&#xff1a;V…
阅读更多...
Linux之进程间通信（管道）

Linux之进程间通信（管道）

目录 一、进程间通信 1、进程间通信的概念 2、进程间通信的目的 3、进程间通信的分类 二、管道 1、管道基本介绍 2、匿名管道 3、命名管道 一、进程间通信 1、进程间通信的概念 什么是进程间通信&#xff1f; 我们在学习了进程的相关知识后&#xff0c;知道&#xff…
阅读更多...
2024 CKA 题库 | 12、查看 pod 日志

2024 CKA 题库 | 12、查看 pod 日志

不等更新题库 文章目录 12、查看 pod 日志题目:考点&#xff1a;参考链接:解答:检查 12、查看 pod 日志 题目: 设置配置环境&#xff1a; [candidatenode-1] $ kubectl config use-context k8sTask 监控 pod foo 的日志并&#xff1a; 提取与错误 RLIMIT_NOFILE 相对应的日志…
阅读更多...
SpringSecurity（07）——JWT整合

SpringSecurity（07）——JWT整合

依赖配置 <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency><groupId>org.springframework.boot</groupId><artifactId>s…
阅读更多...
树的一些经典 Oj题 讲解

树的一些经典 Oj题 讲解

关于树的遍历 先序遍历 我们知道 树的遍历有 前序遍历 中序遍历 后序遍历 然后我们如果用递归的方式去解决&#xff0c;对我们来说应该是轻而易举的吧&#xff01;那我们今天要讲用迭代&#xff08;非递归&#xff09;实现 树的相关遍历 首先呢 我们得知道 迭代解法 本质上也…
阅读更多...
C语言：函数指针的使用

C语言：函数指针的使用

在C语言中&#xff0c;函数指针是指向函数的指针变量。它可以存储函数的地址&#xff0c;使得可以通过该指针来调用函数。以下是函数指针的基本概念和用法&#xff1a; 一、基本概念&#xff1a; 声明函数指针&#xff1a; returnType (*pointerName)(parameterTypes); 这里 r…
阅读更多...
最新文章

Copyright @ 2022~2023