作為前端最火的構建工具,是前端自動化工具鏈 最重要的部分 ,使用門檻較高。本系列是筆者自己的學習記錄,比較基礎,希望通過 問題 + 解決方式 的模式,以前端構建中遇到的具體需求為出發點,學習 工具中相應的處理辦法。(本篇中的參數配置及使用方式均基於 ) 一. plugin概述 1.1 Plugin的 ...
webpack
作為前端最火的構建工具,是前端自動化工具鏈最重要的部分,使用門檻較高。本系列是筆者自己的學習記錄,比較基礎,希望通過問題 + 解決方式的模式,以前端構建中遇到的具體需求為出發點,學習webpack
工具中相應的處理辦法。(本篇中的參數配置及使用方式均基於webpack4.0版本
)
一. plugin概述
1.1 Plugin的作用
plugin
機制是webpack
中另一個核心概念,它基於事件流框架tapable
,你可以參考瀏覽器環境中的【DOM事件模型】,【SPA模型中的生命周期鉤子】或是node環境中的【EventEmitter模塊】來理解其作用。plugin
系統提供給開發者監聽webpack
生命周期併在特定事件觸發時執行指定操作的能力。
當然,要寫一個真正能實現一定功能的插件,你還需要瞭解Compiler和Compilation這兩個概念,網上可以找到非常多相關的文章(《webpack-docs/plugin》)。
1.2 Compiler
從表現上看,Compiler暴露了和webpack
整個生命周期相關的鉤子,通過如下的方式訪問:
//基本寫法
compiler.hooks.someHook.tap(...)
//如果希望在entry配置完畢後執行某個功能
compiler.hooks.entryOption.tap(...)
//如果希望在生成的資源輸出到output指定目錄之前執行某個功能
compiler.hooks.emit.tap(...)
webpack
在重要的生命周期節點上都提供了事件鉤子,我們可以藉此加入一些自定義的功能。我們來編寫一個插件,直觀地看看webpack
中涉及的鉤子:
//check-compiler-hooks-plugin.js
const pluginName = 'checkCompilerHooksPlugin';
module.exports = class checkCompilerHooksPlugin {
apply(compiler){
//列印出entryOption執行完畢時Compiler暴露的鉤子
for(var hook of Object.keys(compiler.hooks)){
console.log(hook);
}
}
}
可以看到Compiler
上可以使用的鉤子(當然這種方式看到的鉤子和實際觸發順序無關):
註意上圖中Compiler.hooks暴露的事件鉤子中有一個compilation,下一小節將解釋它。
1.3 Compilation
Compilation暴露了與模塊
和依賴
有關的粒度更小的事件鉤子,官方文檔中的說法是模塊會經歷載入(loaded),封存(sealed),優化(optimized),分塊(chunked),哈希(hashed)和重新創建(restored)這幾個典型步驟,從上面的示例可以看到,compilation是Compiler生命周期中的一個步驟,使用compilation
相關鉤子的通用寫法為:
compiler.hooks.compilation.tap('SomePlugin',function(compilation, callback){
compilation.hooks.someOtherHook.tap('SomeOtherPlugin',function(){
....
})
});
我們仿照上面的方法就可以查看到compilation
對象上(compilation事件觸發時,在回調函數中取得的引用)暴露的事件鉤子。
Compiler和Compilation暴露的事件鉤子總數超過30個,具體信息可以直接在官方文檔直接查詢API,在特定的階段鉤入想要添加的自定義功能。想要更好地理解
plugin
的作用機制,還需要瞭解webpack
的整個生命周期以及事件流框架tapable
.
二. 如何寫一個plugin
根據webpack
官方文檔的說明,一個自定義的plugin
需要包含:
- 一個javascript命名函數
- 插件函數的prototype上要有一個
apply
方法 - 指定一個綁定到webpack自身的事件鉤子
- 註冊一個回調函數來處理webpack實例中的指定數據
- 處理完成後調用webpack提供的回調
官網給出了一個基本的結構示例:
//console-log-on-build-webpack-plugin.js
const pluginName = 'ConsoleLogOnBuildWebpackPlugin';
class ConsoleLogOnBuildWebpackPlugin {
apply(compiler){
compiler.hooks.run.tap(pluginName, compilation=>{
console.log('webpack構建過程開始');
});
}
}
將其添加到webpack插件中後可以看到運行中觸發了傳入的回調函數:
四. 實戰
在《webpack4.0各個擊破(4)——javascript & splitChunks》一文中,我們使用splitChunks
功能對初始模塊進行代碼分割,在為多頁面應用模型的html入口插入script標簽時遇到了無法自動插入的問題,那麼本節我們用一個webpack-dispatch-chunk-plugin
來解決一下這個問題。
處理的邏輯就是利用html-webpack-plugin
暴露的更改資源標簽的事件鉤子htmlWebpackPluginAlterAssetTags
來進行資源處理,此時資源已經離過模塊化和代碼分割並已經在名稱中加入了hash標記,只需要此時過濾掉名稱中含有vendors
且不包含相應入口名稱的新的chunk
即可,當然這隻是一個基本功能,想要動態實現功能,還需要將上例中checkMap
部分變為對Compiler或是Compilation上對應屬性的引用,本篇不再贅述。
【參考】
[1] webpack之內部運行機制》