plugins

plugin 可以看作是对 webpack 功能的一个扩展

比如:当 webpack 生成文件时,顺便多生成一个说明描述文件
再比如:当 webpack 编译启动时,控制台输出一句话 表示 webpack 启动了

就是,当 xxx 的时候,我们要做 xxx 事情的时候,就需要 plugin

如图:


红点可以看作是一个个事件触发点, 这些事件可以对 plugin 进行监听

plugin 本质是一个带有 apply 方法的对象

var plugin = {
    apply: function(compiler) {
        // 在这里注册事件,类似于 window.onload
    }
}

通常,我们将该对象写成构造函数的模式

class MyPlugin {
    apply(compiler) {
        // 在这里注册事件,类似于 window.onload
    }
}
var plugin = new MyPlugin();

要将插件应用到 webpack,需要把插件对象配置到 webpack 的 plugins 数组中

var MyPlugin = require("./plugins/MyPlugin");

module.exports = {
    plugins: [
        new MyPlugin();
    ]
}

介绍下 plugin 的 apply 方法的 compiler 参数:

compiler 是一个对象,是在初始化阶段构建的,整个 webpack 打包期间只有一个 compiler 对象

后续完成打包工作的事 compiler 对象内部创建的 compilation

apply 方法会在创建好 compiler 对象后调用,并向方法传入一个 compiler 对象

注意:在整个构建过程中 compiler 对象只会创建一次,所以 plugin 的 apply 方法也只会被调用一次

compiler 对象提供了大量的钩子函数(hooks,可以理解为事件),plugin 的开发者可以注册这些钩子函数

class MyPlugin{
    apply(compiler){
        compiler.hooks.事件名称.事件类型(name, function(compilation){
            //事件处理函数
        })
    }
}
  • 事件名称:即要监听的事件名,即钩子名,所有的钩子:https://www.webpackjs.com/api/compiler-hooks
  • 事件类型:这一部分使用的是 Tapable API,这个小型的库是一个专门用于钩子函数监听的库
    • tap:注册一个同步的钩子函数,函数运行完毕则表示事件处理结束
    • tapAsync:注册一个基于回调的异步的钩子函数,函数通过调用一个回调表示事件处理结束
    • tapPromise:注册一个基于 Promise 的异步的钩子函数,函数通过返回的 Promise 进入已决状态表示事件处理结束
  • 处理函数:处理函数有一个事件参数 compilation
module.exports = class MyPlugin {
    apply(compiler) {
        // 注册事件
        compiler.hooks.done.tap("MyPlugin-done", function(compilation) {
            // 事件处理函数
            console.log("编译完成");
        })
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容