前端工程化之：webpack1-9(plugin)

news2024/11/15 7:18:03

一、plugin

loader 的功能定位是转换代码，而一些其他的操作难以使用 loader 完成，比如：

当 webpack 生成文件时，顺便多生成一个说明描述文件；
当 webpack 编译启动时，控制台输出一句话表示 webpack 启动了；
当 xxxx 时， xxxx 。

这种类似的功能需要把功能嵌入到 webpack 的编译流程中，而这种事情的实现是依托于 plugin 的。

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

var plugin = {
    apply: function(compiler){
        
    }
}

通常，习惯上，我们会将该对象写成构造函数的模式。

class MyPlugin{
    apply(compiler){

    }
}
var plugin = new MyPlugin();

要将插件应用到 webpack ，需要把插件对象配置到 webpack 的 plugins 数组中，如下：

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

webpack.config.js ：

var MyPlugin = require("./plugins/MyPlugin");
module.exports = {
    mode: "development",
    watch: true,
    plugins: [
        new MyPlugin()
    ]
}

apply 函数会在 webpack 编译的初始化阶段，创建好 Compiler 对象后运行。

compiler 对象是在初始化阶段构建的，也就是编译器。整个 webpack 打包期间只有一个 compiler 对象，后续完成打包工作的是 compiler 对象内部创建的 compilation 。

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

compiler 对象提供了大量的钩子函数（ hooks ，可以理解为事件）， plugin 的开发者可以注册这些钩子函数，参与 webpack 编译和生成。

你可以在 apply 方法中使用下面的代码注册钩子函数：

class MyPlugin{
    apply(compiler){
        compiler.hooks.事件名称.事件类型(name, function(compilation){
            //事件处理函数
        })
    }
}

./plugins/MyPlugin

module.exports = class MyPlugin {
    apply(compiler) {
        //在这里注册事件，类似于window.onload  $(function(){})
        compiler.hooks.done.tap("MyPlugin-done", function(compilation){
            //事件处理函数
            console.log("编译完成");
        })
    }
}

如果使用 watch 实时监测需打包的文件内容是否改变，每次改变后打包时都会触发该注册事件。