参考答案:
前面两节我们有提到Loader
与Plugin
对应的概念,先来回顾下
从整个运行时机上来看,如下图所示:
可以看到,两者在运行时机上的区别:
在 Webpack
运行的生命周期中会广播出许多事件,Plugin
可以监听这些事件,在合适的时机通过Webpack
提供的 API
改变输出结果
对于loader
,实质是一个转换器,将A文件进行编译形成B文件,操作的是文件,比如将A.scss
或A.less
转变为B.css
,单纯的文件转换过程
在编写 loader
前,我们首先需要了解 loader
的本质
其本质为函数,函数中的 this
作为上下文会被 webpack
填充,因此我们不能将 loader
设为一个箭头函数
函数接受一个参数,为 webpack
传递给 loader
的文件源内容
函数中 this
是由 webpack
提供的对象,能够获取当前 loader
所需要的各种信息
函数中有异步操作或同步操作,异步操作通过 this.callback
返回,返回值要求为 string
或者 Buffer
代码如下所示:
1// 导出一个函数,source为webpack传递给loader的文件源内容 2module.exports = function(source) { 3 const content = doSomeThing2JsString(source); 4 5 // 如果 loader 配置了 options 对象,那么this.query将指向 options 6 const options = this.query; 7 8 // 可以用作解析其他模块路径的上下文 9 console.log('this.context'); 10 11 /* 12 * this.callback 参数: 13 * error:Error | null,当 loader 出错时向外抛出一个 error 14 * content:String | Buffer,经过 loader 编译后需要导出的内容 15 * sourceMap:为方便调试生成的编译后内容的 source map 16 * ast:本次编译生成的 AST 静态语法树,之后执行的 loader 可以直接使用这个 AST,进而省去重复生成 AST 的过程 17 */ 18 this.callback(null, content); // 异步 19 return content; // 同步 20}
一般在编写loader
的过程中,保持功能单一,避免做多种功能
如less
文件转换成 css
文件也不是一步到位,而是 less-loader
、css-loader
、style-loader
几个 loader
的链式调用才能完成转换
由于webpack
基于发布订阅模式,在运行的生命周期中会广播出许多事件,插件通过监听这些事件,就可以在特定的阶段执行自己的插件任务
在之前也了解过,webpack
编译会创建两个核心对象:
如果自己要实现plugin
,也需要遵循一定的规范:
apply
方法的对象,这样才能访问compiler
实例compiler
和 compilation
对象都是同一个引用,因此不建议修改Webpack
进入下一个流程,不然会卡住实现plugin
的模板如下:
1class MyPlugin { 2 // Webpack 会调用 MyPlugin 实例的 apply 方法给插件实例传入 compiler 对象 3 apply (compiler) { 4 // 找到合适的事件钩子,实现自己的插件功能 5 compiler.hooks.emit.tap('MyPlugin', compilation => { 6 // compilation: 当前打包构建流程的上下文 7 console.log(compilation); 8 9 // do something... 10 }) 11 } 12}
在 emit
事件发生时,代表源文件的转换和组装已经完成,可以读取到最终将输出的资源、代码块、模块及其依赖,并且可以修改输出资源的内容
最近更新时间:2024-01-25