如何编写一个Plugin

webpack的源码里,大概有80%都是基于Plugin的机制编写的,webpack 自身的多数功能都使用Plugin这个插件接口。这个插件接口使 webpack 变得极其灵活。Plugin可以说是webpack的灵魂
Plugin的核心机制是发布订阅的设计模式,代码之间的执行是通过事件来驱动的

我们来试着写一个Plugin

  • 我们先来创建一个项目
mkdir plugin    // 创建一个文件夹
npm init -y   //初始化项目,生成package.json文件,package.json记录项目的信息,以及依赖包
mkdir src   //根目录下创建src文件夹,并写入任意代码
npm install webpack webpack-cli --save-dev  // 安装 webpack
touch webpack.config.js  // 创建webpack配置文件并配置
  • src下创建index.js


    image.png
  • 配置webpack.config.js
    image.png
  • 然后安装webpack npm install webpack webpack-cli --save-dev
  • 之后配置打包命令


    image.png
  • 运行打包命令npm run build,至此没有问题
    image.png
现在我们的需求是,当整个打包过程结束的时候,希望生成一个版权文件,比如叫copyright.txt,里边写一些版权信息,那么我们要怎么写这个插件呢?
  • 创建文件夹plugins
  • 创建copyright-webpack-plugin.js ,(插件通常都是这种格式的名称)
  • loader本质上是一个方法,而插件本质上是一个类


    image.png
  • 我们先在插件里打印一句话,看看这个插件能不能用。插件写好后,我们要使用这个插件


    image.png
  • 然后我们运行打包,发现我们的插件是可以正常使用的


    image.png
  • 当然了,我们在new一个插件实例的时候,还可以传递一些参数,然后我们可以在constructor里接受这些参数
    image.png

    image.png

    image.png
  • 接受参数就是constructor的作用,如果不需要接受参数,也可以不写constructor
  • apply里的compiler参数,指的是webpack的实例,这个实例里存储了webpack相关的各种配置文件和打包过程等一系列内容,我们可以在webpack官网看到它的相关信息
    image.png
  • 在webpack的打包过程中,某些时刻,要做一些事情,具体有哪些时刻呢,compiler的hooks定义了一些具体的时刻值(类似于vue的钩子函数)


    image.png
  • 比如我们常用的 emit钩子,它执行的时刻是生成资源到 output 目录之前,在我们的例子里就是当我们打包结束后,准备把东西放在dist目录的时候,我们就用到了 emit,它是异步时刻(AsyncSeriesHook)
    image.png

tapAsync 函数接收两个参数,第一个参数是我们的插件名称,第二个参数是一个箭头函数,这个函数接收两个参数,第一个是compilation,第二个参数是cb回调,当我们调用tapAsync 异步函数的时候,一定要手动执行一下cb回调 ,compilation存放的是跟这一次打包相关的内容

  • 然后我们运行打包命令npm run build,我们写的插件就帮我们生成了我们想要的版权文件
    image.png
  • 我们再来看一个同步的时刻 compile,它代表的时刻是 `一个新的编译(compilation)创建之后,钩入(hook into) compiler。
class CopyRightWebpackPlugin {
    
    apply(compiler) {
        // compile 是同步的时刻,这个时候,不需要传入cb参数
        compiler.hooks.compile.tap('CopyRightWebpackPlugin', (compilation) => {
            console.log('compiler')
        })
        // emit 是异步的时刻,这个时候,需要传入cb参数,并手动执行
        compiler.hooks.emit.tapAsync('CopyRightWebpackPlugin',(compilation, cb) => {
            compilation.assets['copyright.txt'] = {
                source: function () {
                    return 'copyright by LEE YANG'
                },
                size: function () {
                    return 21
                }
            }
            cb();
        })
    }
}
module.exports = CopyRightWebpackPlugin
  • 运行打包命令,发现执行了


    image.png
我们在写插件的时候,怎么知道compilation下边有一个assets呢?
  • 我们先新配置一个命令


    image.png
  • 这两个命令运行的时候,做的事情是 一样的。那为什么我们还要多此一举写一个debug命令呢? 是因为当我们显式的用node去执行webpack.js这个文件的时候,是因为我们可以在node运行webpack.js的时候,传递一些node的参数进去。
    image.png
  • 第一个参数--inspect意思是,我要开启node的调试工具,第二个参数--inspect-brk的意思是,我在运行webpack.js做调试的时候,我在webpack命令执行的时候,它的第一行上面打一个断点
  • 然后我们运行npm run debug,控制台告诉我们,Debugger已经被开启了
    image.png
  • 然后我们怎么做node的调试呢?我们打开chrome浏览器,打开https://webpack.js.org/,然后点击控制台,当我们开启了node的调试工具后,我们可以看到一个图标
    image.png
  • 我们点击图标 ,就会自动跳出这样一个窗口


    image.png
  • 这个弹窗里的代码,起始就是webpack的代码,它在第一行打了一个断点,我们可以点击按钮,让打包代码一步一步往下执行,我们直接让代码执行完,然后看下我们的打包过程,已经结束


    image.png
  • 如果我们在做插件调试的时候,想去看compliation里都有什么参数,我们可以在这里打一个断点
    image.png
  • 然后我们再运行debug命令,我们可以看到debugger又开启了,我们就可以再打开浏览器,打开控制台


    image.png
  • 然后我们可以点击图标让默认的断点,直接执行过去


    image.png
  • 默认断点执行过去之后,进入了下一个断点,也就是我们在插件代码里手写的断点这里


    image.png
  • 我们想看compliation里都有什么参数,有两种方法,第一个就是直接把鼠标放到compliation
    image.png
  • 还有一种方式就是通过右侧提供给我们的工具 watch,然后在watch里添加我们想要看的变量


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

推荐阅读更多精彩内容

  • 一、Loader和Plugin的区别 当我们在源代码中引入一个js或者其他格式的文件的时候,我们可以使用Loade...
    指尖跳动阅读 340评论 0 0
  • 当我们去打包一个大型项目的时候,有的时候完成打包需要非常多的时间,遇到这种问题的时候,我们就要考虑用一些方法来提升...
    泡杯感冒灵阅读 7,060评论 0 3
  • 目录第1章 webpack简介 11.1 webpack是什么? 11.2 官网地址 21.3 为什么使用 web...
    lemonzoey阅读 1,731评论 0 1
  • 可以结合慕课网的视频来读这篇文章,地址:http://www.imooc.com/learn/802 Webpac...
    哈哈腾飞阅读 1,870评论 0 7
  • 时间磨去了太多东西, 以前却从不相信, 直到琐碎、忙碌、波折、慵懒的生活。 让信念模糊、分裂, 勇气、锐气消失殆尽...
    青空空的眉小甜阅读 163评论 0 0