[FE] webpack群俠傳(五):hooks原理

上一篇我們經(jīng)歷了一次頭腦爆炸,一口氣看完了從webpack-cli到babel-loader的全流程宽闲。
這一篇可以放松一下了悲雳,
來(lái)看看hooks中到底包含了什么秘密。

1. hooks回顧

我們知道在webpack Compiler.js中第536行陈哑,
this.compile中調(diào)用了hooks.make

compile(callback) {
    const params = this.newCompilationParams();
    this.hooks.beforeCompile.callAsync(params, err => {
        if (err) return callback(err);

        this.hooks.compile.call(params);

        const compilation = this.newCompilation(params);

        this.hooks.make.callAsync(compilation, err => {
            if (err) return callback(err);

            compilation.finish();

            compilation.seal(err => {
                if (err) return callback(err);

                this.hooks.afterCompile.callAsync(compilation, err => {
                    if (err) return callback(err);

                    return callback(null, compilation);
                });
            });
        });
    });
}

結(jié)果 this.hooks.make.callAsync(compilation, err => {
居然會(huì)跳轉(zhuǎn)到伸眶,SingleEntryPlugin.js 文件中芥颈。

compiler.hooks.make.tapAsync(
    "SingleEntryPlugin",
    (compilation, callback) => {
        const { entry, name, context } = this;

        const dep = SingleEntryPlugin.createDependency(entry, name);
        compilation.addEntry(context, dep, name, callback);
    }
);

這其中發(fā)生了什么?
為了理解這一點(diǎn)赚抡,我們還得從webpack plugin說(shuō)起。

2. webpack插件的編寫(xiě)方式

我認(rèn)為從用例中學(xué)習(xí)代碼庫(kù)纠屋,會(huì)把事情變簡(jiǎn)單涂臣,
因?yàn)榇a的設(shè)計(jì)目的,就是為它的使用場(chǎng)景服務(wù)的售担。

所以赁遗,一開(kāi)始我們不宜直接研究hooks是如何實(shí)現(xiàn)的,
而是看看hooks的設(shè)計(jì)者們族铆,期望它被如何使用岩四。

hooks最常見(jiàn)的使用場(chǎng)景,就是當(dāng)我們?cè)诮owebpack編寫(xiě)插件的時(shí)候哥攘,
插件中會(huì)實(shí)現(xiàn)compilercompilation對(duì)象的多個(gè)hooks剖煌,
下面我們來(lái)創(chuàng)建一個(gè)webpack 插件材鹦。

2.1 test-plugin.js

在我們的debug-webpack工程中,我們?cè)诟夸浿行陆ㄒ粋€(gè)test-plugin.js文件耕姊。

module.exports = class Plugin {
    apply(compiler) {
        compiler.hooks.make.tapAsync('TestPlugin', (compilation, callback) => {
            compilation.hooks.buildModule.tap('TestPlugin', module => {
                console.log('module.resource', module.resource);
                console.log('module.loaders', module.loaders);
                console.time('TestPlugin');
            });

            compilation.hooks.succeedModule.tap('TestPlugin', module => {
                console.timeEnd('TestPlugin');
            });

            callback();
        });
    }
};

它導(dǎo)出了一個(gè)類桶唐,這個(gè)類必須實(shí)現(xiàn)apply方法。

其中茉兰,apply方法的形參是compiler尤泽,
就是webpack-cli中調(diào)用的compiler.run的那個(gè)compiler
至于更細(xì)節(jié)的問(wèn)題规脸,我們以后可以再慢慢看坯约。

(1)compiler.hooks.make.tapAsync
compiler.hooks.make.tapAsync實(shí)現(xiàn)了compiler.hooks.make
如果我們?cè)黾恿诉@個(gè)實(shí)現(xiàn)莫鸭,
webpack Compiler.js 第536行 build 調(diào)用 this.hooks.make.callAsync(compilation, err => {
會(huì)額外觸發(fā)我們這里的實(shí)現(xiàn)闹丐。

因?yàn)樗钱惒降模晕覀冏詈笠{(diào)用 callback 來(lái)完成調(diào)用黔龟。

compiler.hooks.make.tapAsync('TestPlugin', (compilation, callback) => {
    ...
    
    callback();
});

(2)compilation.hooks.buildModule.tap
compilation.hooks.buildModule.tap 實(shí)現(xiàn)了compilation.hooks.buildModule妇智,
它會(huì)在webpack Compilation.js 第617行buildModule中氏身,
執(zhí)行this.hooks.buildModule.call(module); 時(shí)被調(diào)用巍棱。

buildModule(module, optional, origin, dependencies, thisCallback) {
    ...

    this.hooks.buildModule.call(module);
    module.build(
    ...
}

因此,通過(guò)將compiler.hookscompilation.hooks調(diào)用和實(shí)現(xiàn)分離蛋欣,
相當(dāng)于在webpack執(zhí)行過(guò)程中航徙,添加了多個(gè)切面(面向切面編程AOP)。
在這些切面中陷虎,webpack插件可以做自己想做的任何事情到踏。

以上test-plugin.js插件,我們只是統(tǒng)計(jì)了一下尚猿,
compilation.buildModulecompilation.succeedModule 所經(jīng)歷的時(shí)間窝稿。

注:compilation.hooks.succeedModuleCompilation.js 第652行調(diào)用。

this.hooks.succeedModule.call(module);

2.2 在webpack.config.js中使用插件

const path = require('path');
const TestPlugin = require('./test-plugin');

module.exports = {
    entry: {
        index: path.resolve(__dirname, 'src/index.js'),
    },
    output: {
        path: path.resolve(__dirname, 'dist/'),
    },
    module: {
        rules: [
            { test: /\.js$/, use: { loader: 'babel-loader', query: { presets: ['@babel/preset-env'] } } },
        ]
    },
    plugins:[
        new TestPlugin(),
    ],
};

我們?cè)趙ebpack.config.js中引入了test-plugin.js凿掂,
然后在導(dǎo)出對(duì)象中增加了plugins屬性伴榔。

這樣我們的webpack插件就編寫(xiě)完了。

2.3 查看插件的調(diào)用效果

直接調(diào)用npm run build庄萎,

$ npm run build
module.resource ~/Test/debug-webpack/src/index.js
module.loaders [ { options: { presets: [Array] },
    ident: 'ref--4',
    loader: '~/Test/debug-webpack/node_modules/_babel-loader@8.0.4@babel-loader/lib/index.js' } ]
TestPlugin: 213.301ms

我們統(tǒng)計(jì)出來(lái)踪少,build ./src/index.js 源文件,
compilation.hooks.buildModulecompilation.hooks.succeedModule糠涛,
總共花費(fèi)了 213.301ms援奢。

3. Tapable

上文中我們通過(guò)hooks的用例,了解了它的使用方式忍捡,
它為Compiler和Compilation兩個(gè)類實(shí)現(xiàn)了多個(gè)切面集漾,
下面我們來(lái)看一下原理切黔。

我們打開(kāi)Compiler類的源碼,位于Compiler.js 第40行帆竹,
它是Tapable的子類绕娘,它是從tapable模塊中導(dǎo)出的,
tapable是一個(gè)獨(dú)立的代碼庫(kù)(v1.1.0)栽连。

直接閱讀tapable源碼會(huì)發(fā)現(xiàn)非常難懂险领,
HookCodeFactory.js 中使用了大量的元編程手段new Function

fn = new Function(
    this.args(),
    '"use strict";\n' +
    this.header() +
    this.content({
        onError: err => `throw ${err};\n`,
        onResult: result => `return ${result};\n`,
        onDone: () => "",
        rethrowIfPossible: true
    })
);

我認(rèn)為在這種情況下秒紧,要想更好的理解它绢陌,最好的辦法是從動(dòng)機(jī)入手,
在tapable倉(cāng)庫(kù)README.md中熔恢,
我們看到脐湾,tapable實(shí)現(xiàn)了interception(攔截器)。

const { SyncHook } = require('tapable');

const hook = new SyncHook(['x', 'y']);

hook.intercept({
    register(...args) {
        console.log('2. in: register', args);
    },
    call(...args) {
        console.log('4. in: call', args);
    },
});

console.log('1. start: register');
hook.tap('some-message', (...args) => {
    console.log('5. in: tap', args);
});

console.log('3. start: call');
hook.call(1, 2, 3);

日志信息如下叙淌,

1. start: register
2. in: register [ { type: 'sync', fn: [Function], name: 'some-message' } ]
3. start: call
4. in: call [ 1, 2 ]
5. in: tap [ 1, 2 ]

注:
hooks在構(gòu)造時(shí)設(shè)置了兩個(gè)參數(shù)(xy)秤掌,
但是在調(diào)用時(shí)用了三個(gè)參數(shù)(123)鹰霍,結(jié)果第三個(gè)參數(shù)丟失了闻鉴。

我們看到,每一個(gè)hooks在被調(diào)用的時(shí)候它都可以攔截到茂洒,被添加新的實(shí)現(xiàn)時(shí)也是如此孟岛。
我們知道ES6 proxy也可以用來(lái)實(shí)現(xiàn)攔截功能,
但是IE卻一直是不支持的督勺。

因此渠羞,tapable中采用了兼容性的做法,對(duì)實(shí)現(xiàn)hooks的代碼進(jìn)行了動(dòng)態(tài)修改智哀,
在其前后增加了攔截器次询,最后再通過(guò)new Function生成一個(gè)函數(shù)。

具體的源碼解析瓷叫,我們以后慢慢補(bǔ)充渗蟹。


參考

webpack: plugins
Aspect-oriented programming
tapable v1.1.0

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市赞辩,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌授艰,老刑警劉巖辨嗽,帶你破解...
    沈念sama閱讀 206,378評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異淮腾,居然都是意外死亡糟需,警方通過(guò)查閱死者的電腦和手機(jī)屉佳,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,356評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)洲押,“玉大人武花,你說(shuō)我怎么就攤上這事¤菊剩” “怎么了体箕?”我有些...
    開(kāi)封第一講書(shū)人閱讀 152,702評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)挑童。 經(jīng)常有香客問(wèn)我累铅,道長(zhǎng),這世上最難降的妖魔是什么站叼? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 55,259評(píng)論 1 279
  • 正文 為了忘掉前任娃兽,我火速辦了婚禮,結(jié)果婚禮上尽楔,老公的妹妹穿的比我還像新娘投储。我一直安慰自己,他們只是感情好阔馋,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,263評(píng)論 5 371
  • 文/花漫 我一把揭開(kāi)白布玛荞。 她就那樣靜靜地躺著,像睡著了一般垦缅。 火紅的嫁衣襯著肌膚如雪冲泥。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 49,036評(píng)論 1 285
  • 那天壁涎,我揣著相機(jī)與錄音凡恍,去河邊找鬼。 笑死怔球,一個(gè)胖子當(dāng)著我的面吹牛嚼酝,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播竟坛,決...
    沈念sama閱讀 38,349評(píng)論 3 400
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼闽巩,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了担汤?” 一聲冷哼從身側(cè)響起涎跨,我...
    開(kāi)封第一講書(shū)人閱讀 36,979評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎崭歧,沒(méi)想到半個(gè)月后隅很,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,469評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡率碾,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,938評(píng)論 2 323
  • 正文 我和宋清朗相戀三年叔营,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了屋彪。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,059評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡绒尊,死狀恐怖畜挥,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情婴谱,我是刑警寧澤蟹但,帶...
    沈念sama閱讀 33,703評(píng)論 4 323
  • 正文 年R本政府宣布,位于F島的核電站勘究,受9級(jí)特大地震影響矮湘,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜口糕,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,257評(píng)論 3 307
  • 文/蒙蒙 一缅阳、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧景描,春花似錦十办、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,262評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至棠绘,卻和暖如春件相,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背氧苍。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來(lái)泰國(guó)打工夜矗, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人让虐。 一個(gè)月前我還...
    沈念sama閱讀 45,501評(píng)論 2 354
  • 正文 我出身青樓紊撕,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親赡突。 傳聞我的和親對(duì)象是個(gè)殘疾皇子对扶,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,792評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容