探索webpack源码(三)--- Tapable插件使用 2018-04-10

上次说是准备探索Compiler.js,但是我看了一下Compiler.js里面最主要的也就是用的Tapable,所以就先鸽大家一下了[手动笑哭]。

这里不得不先吐槽一下,之前学习Tapable的时候,基本只有Tapable 0.2的教学版本,而webpack4.x用的又是Tapable 1.x,学起来真的是有种学医救不了中国人的感觉…但是最近webpack中文文档更新的很快,好像半个月就更新了3个版本webpack v4.2 -> webpack v4.5,总算是开始维护自己的文档了。

不废话那么多了,进入主题吧。


Tapable

按照上一次我们说的Compiler.js,这次我们还是过一下吧,不过只到定义类的那一行:

class Compiler extends Tapable {
  // something code ...
}

好的,这里的Compiler继承了Tapable,然后再往上找一下就能发现一段引入代码:

const Tapable = require('tapable').tapable

今天探索就是讲这一部分,只是探索怎么使用而不是探索源码,因为tapable体系特别复杂,没办法一次性讲清楚。

其实用法主要就只有以下三种:

针对于同步:
  tap对应call
针对于异步:
  tapSync对应promise
  tapAsync对应callAsync

而使用方法基本就是这样,以同步为例:

const { SyncHook } = require('tapable');
const hook = new SyncHook();
hook.tap('my-hook', () => {
  console.log('我的hook。')
});
hook.call(); 
// 我的hook

而需要给hook添加参数:

const { SyncHook } = require('tapable');
const hook = new SyncHook(['参数1', '参数2', '参数3']);
hook.tap('my-hook', (arg1, arg2, arg3) => {
  console.log(arg1, arg2, arg3)
});
hook.call('小红', '小绿', '小蓝')
// 小红 小绿 小蓝

原本是没有打算写Async的,但是自己也经常忘记Async的用法,懒得老是去写代码测试,就在这里也补上吧。

const { AsyncSeriesHook } = require('tapable');
const hook1 = new AsyncSeriesHook(['arg']);
const hook2 = new AsyncSeriesHook(['arg']);
const hook3 = new AsyncSeriesHook(['arg']);

hook1.tapPromise('asyncHook', (arg) => {
  console.log(arg)
  return Promise.resolve();
})

hook1.promise('exec promise tap hook!').then(() => {
  // then函数这里似乎无法接收从tapPromise的resolve传过来的内容。
  // 所以then接收的匿名函数没有传参。
  console.log('执行后续内容。')
});
// 打印:
// exec promise tap hook!
// 执行后续内容。

hook2.tapAsync('asyncHook', (arg) => {
  console.log(arg);
})

hook2.callAsync('exec async tap hook!');
// 打印:
// exec async tap hook!

// 这里还有个隐藏技能,可能是我没去仔细tapable看源码的缘故吧
// 用tap绑定的AsyncSeriesHook,在callAsync的时候还会接收一个err-first格式的回调。
hook3.tap('asyncHook', (arg) => {
  console.log(arg);
})

hook3.callAsync('exec tap hook!', err => { console.log(123) })

由于tapAsync比tapPromise简单,所以内容也比较少,但是他们似乎不可覆盖使用,也就是一个AsyncSeriesHook不能同时绑定async和promise,否则promise似乎会不生效,这里我没有仔细往下试,我想设计的人也不会想我们这么用的吧(笑哭)。


以上就是hook的使用方式,除了SyncHook和AsyncSeriesHook以外,还有以下的Hook:

name desciption
SyncHook 同步钩子
SyncBailHook 同步保留钩子(有返回值)
SyncWaterfallHook 同步瀑布流钩子(执行完call以后,以最后一个返回值为准)
SyncLoopHook 暂时没见过
AsyncParallelHook 异步并行钩子
AsyncParallelBailHook 异步并行保留值钩子
AsyncSeriesHook 异步串行钩子
AsyncSeriesBailHook 异步串行保留值钩子
AsyncSeriesWaterfallHook 异步串行瀑布流钩子

以上就是 Tapable 钩子的探索,这里只讲了同步调用的办法,异步的用法在开头也已经说了有对应的方法,接下来就可以开始讲Compiler.js了。:)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,026评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,655评论 1 296
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,726评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,204评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,558评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,731评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,944评论 2 314
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,698评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,438评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,633评论 2 247
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,125评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,444评论 3 255
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,137评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,103评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,888评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,772评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,669评论 2 271

推荐阅读更多精彩内容

  • 说在前面:这些文章均是本人花费大量精力研究整理,如有转载请联系作者并注明引用,谢谢本文的受众人群不是webpack...
    RockSAMA阅读 6,804评论 2 7
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,571评论 25 707
  • 写在开头 先说说为什么要写这篇文章, 最初的原因是组里的小朋友们看了webpack文档后, 表情都是这样的: (摘...
    Lefter阅读 5,234评论 4 31
  • 我们走了停,停了走,曾像傻缺一样认真地执着,也曾自以为是变成矫情狗,早就有N个人用N种方式跟你描绘世界是什么样,你...
    鹿小秋阅读 759评论 38 17
  • 生活推着我们向前走,走着走着,我们就变了,再也找不回那个单纯的自己,十八岁了,可我不承认自己历经沧桑,很多时候,我...
    柚子暴发户阅读 348评论 1 3