webpack原理篇(五十三):Tapable插件架构与Hooks设计

简介: webpack原理篇(五十三):Tapable插件架构与Hooks设计

说明

玩转 webpack 学习笔记



compiler

上一节里面有个重要的东西就是 compiler

07cf31749c0a4ee18b6a330fabfd7876.png


下面找一下这个东东,在 my-project\node_modules\webpack\lib\webpack.js 里面可以看到


6de28b6f1ec84ce3af948e5d17161868.png


这里的 Compiler 跟 MultiCompiler 分别引用了不同的 js

const Compiler = require("./Compiler");
const MultiCompiler = require("./MultiCompiler");


找到 my-project\node_modules\webpack\lib\Compiler.js

adf75c1f0bce476db39374039788ea3a.png


可以看到 Compiler 继承了 Tapable

469c41f40bf54005aca08c30927d1a27.png


Webpack 的本质

Webpack 可以将其理解是一种基于事件流的编程范例,一系列的插件运行。

核心对象 Compiler 继承 Tapable:


class Compiler extends Tapable {
  // ... 
}


核心对象 Compilation 继承 Tapable

class Compilation extends Tapable {
  // ... 
}


727997d0a4e04dbc89f99b249c2c0fab.png



Tapable 是什么?

Tapable 是一个类似于 Node.js 的 EventEmitter 的库, 主要是控制钩子函数的发布与订阅,控制着 webpack 的插件系统。

Tapable 库暴露了很多 Hook(钩子)类,为插件提供挂载的钩子

const {
  SyncHook, // 同步钩子
  SyncBailHook, // 同步熔断钩子(遇到 return 直接返回)
  SyncWaterfallHook, // 同步流水钩子(结果可以传递给下一个插件)
  SyncLoopHook, // 同步循环钩子
  AsyncParallelHook, // 异步并发钩子
  AsyncParallelBailHook, // 异步并发熔断钩子
  AsyncSeriesHook, // 异步串行钩子
  AsyncSeriesBailHook, // 异步串行熔断钩子
  AsyncSeriesWaterfallHook // 异步串行流水钩子
} = require("tapable");


Tapable hooks 类型

image.png



Tapable 的使用:new Hook 新建钩子

Tapable 暴露出来的都是类方法,new 一个类方法获得我们需要的钩子


class 接受数组参数 options ,非必传。类方法会根据传参,接受同样数量的参数。

const hook1 = new SyncHook(["arg1", "arg2", "arg3"]);



Tapable 的使用:钩子的绑定与执行

Tabpack 提供了同步 & 异步绑定钩子的方法,并且他们都有绑定事件和执行事件对应的方法。


Async* Sync*
绑定: tapAsync/tapPromise/tap 绑定: tap
执行: callAsync/promise 执行: call



Tapable 的使用:hook 基本用法示例

const hook1 = new SyncHook(["arg1", "arg2", "arg3"]);
// 绑定事件到webapck事件流
hook1.tap('hook1', (arg1, arg2, arg3) => console.log(arg1, arg2, arg3)) //1,2,3
// 执行绑定的事件
hook1.call(1,2,3)


Tapable 的使用:实际例子演示


新建项目

1、我们先新建一个项目 tapable-kaimo,然后执行下面命令

npm init -y
npm i tapable



4900b738b28a4903a66e745e9c42262b.png


先添加一个 index.js 文件,输入下面代码

const {
    SyncHook
} = require('tapable');
const hook = new SyncHook(["arg1", "arg2", "arg3"]);
hook.tap("hook1", (arg1, arg2, arg3) => {
    console.log(arg1, arg2, arg3);
});
hook.call(1, 2, 3);



运行 node index.js 结果如下


99d5e67048e6404db24782b2081ae71f.png



实现下面例子


定义一个 Car 方法,在内部 hooks 上新建钩子。分别是同步钩子 accelerate、brake( accelerate 接受一个参数)、异步钩子 calculateRoutes。

使用钩子对应的绑定和执行方法

calculateRoutes 使用 tapPromise 可以返回一个 promise 对象

新建一个 car.js 文件,添加下面代码


const {
    SyncHook,
    AsyncSeriesHook
} = require('tapable');
// 创建 Car 类
class Car {
    constructor() {
        this.hooks = {
            accelerate: new SyncHook(['newSpeed']), // 加速 hook
            brake: new SyncHook(), // 刹车 hook
            calculateRoutes: new AsyncSeriesHook(['source', 'target', 'routesList']) // 计算路径 hook
        }
    }
}
// 实例化 Car
const kaimoCar = new Car();
// 绑定同步钩子
kaimoCar.hooks.brake.tap('WarningLampPlugin', () => {
    console.log('WarningLampPlugin');
})
// 绑定同步钩子 并传参
kaimoCar.hooks.accelerate.tap('LoggerPlugin', newSpeed => {
    console.log(`Accelerate to ${newSpeed}`);
})
// 绑定一个异步 Promise 钩子
kaimoCar.hooks.calculateRoutes.tapPromise('calculateRoutes tapPromise', (source, target, routesList, callback) => {
    return new Promise((resolve, reject) => {
        setTimeout(() => {
            console.log(`tapPromise to ${source} ${target} ${routesList}`);
            resolve()
        }, 1000)
    })
})
/*****************下面开始执行***************/ 
kaimoCar.hooks.brake.call();
kaimoCar.hooks.accelerate.call(313);
console.time('kaimoCar cost');
kaimoCar.hooks.calculateRoutes.promise('Async', 'hook', 'kaimo demo').then(() => {
    console.timeEnd('kaimoCar cost');
}, err => {
    console.error(err);
    console.timeEnd('kaimoCar cost');
})


运行命令执行 node car.js,结果如下


ebb20b0ae3624e41b8d3ec1e1447e893.png








目录
相关文章
|
4月前
|
机器学习/深度学习 自然语言处理 监控
23_Transformer架构详解:从原理到PyTorch实现
Transformer架构自2017年Google发表的论文《Attention Is All You Need》中提出以来,彻底改变了深度学习特别是自然语言处理领域的格局。在短短几年内,Transformer已成为几乎所有现代大型语言模型(LLM)的基础架构,包括BERT、GPT系列、T5等革命性模型。与传统的RNN和LSTM相比,Transformer通过自注意力机制实现了并行化训练,极大提高了模型的训练效率和性能。
|
7月前
|
存储 监控 算法
园区导航系统技术架构实现与原理解构
本文聚焦园区导航场景中室内外定位精度不足、车辆调度路径规划低效、数据孤岛难以支撑决策等技术痛点,从架构设计到技术原理,对该系统从定位到数据中台进行技术拆解。
356 0
园区导航系统技术架构实现与原理解构
|
8月前
|
存储 消息中间件 canal
zk基础—2.架构原理和使用场景
ZooKeeper(ZK)是一个分布式协调服务,广泛应用于分布式系统中。它提供了分布式锁、元数据管理、Master选举及分布式协调等功能,适用于如Kafka、HDFS、Canal等开源分布式系统。ZK集群采用主从架构,具有顺序一致性、高性能、高可用和高并发等特点。其核心机制包括ZAB协议(保证数据一致性)、Watcher监听回调机制(实现通知功能)、以及基于临时顺序节点的分布式锁实现。ZK适合小规模集群部署,主要用于读多写少的场景。
|
10月前
|
消息中间件 存储 设计模式
RocketMQ原理—5.高可用+高并发+高性能架构
本文主要从高可用架构、高并发架构、高性能架构三个方面来介绍RocketMQ的原理。
3124 21
RocketMQ原理—5.高可用+高并发+高性能架构
|
Java Linux C语言
《docker基础篇:2.Docker安装》包括前提说明、Docker的基本组成、Docker平台架构图解(架构版)、安装步骤、阿里云镜像加速、永远的HelloWorld、底层原理
《docker基础篇:2.Docker安装》包括前提说明、Docker的基本组成、Docker平台架构图解(架构版)、安装步骤、阿里云镜像加速、永远的HelloWorld、底层原理
984 90
|
9月前
|
机器学习/深度学习 算法 测试技术
图神经网络在信息检索重排序中的应用:原理、架构与Python代码解析
本文探讨了基于图的重排序方法在信息检索领域的应用与前景。传统两阶段检索架构中,初始检索速度快但结果可能含噪声,重排序阶段通过强大语言模型提升精度,但仍面临复杂需求挑战
305 0
图神经网络在信息检索重排序中的应用:原理、架构与Python代码解析
|
9月前
|
Java 开发者 Spring
Spring框架 - 深度揭秘Spring框架的基础架构与工作原理
所以,当你进入这个Spring的世界,看似一片混乱,但细看之下,你会发现这里有个牢固的结构支撑,一切皆有可能。不论你要建设的是一座宏大的城堡,还是个小巧的花园,只要你的工具箱里有Spring,你就能轻松搞定。
359 9