webpack 自定义loader与插件

最新推荐文章于 2023-04-13 00:03:49 发布
最新推荐文章于 2023-04-13 00:03:49 发布
阅读量435 收藏 2
点赞数
分类专栏： 11.webpack相关 文章标签： javascript css css3
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/a2274001782/article/details/126027464
版权

Loader 原理

#loader 概念

帮助 webpack 将不同类型的文件转换为 webpack 可识别的模块。(webpack只能识别js文件 loader能帮助他识别css等文件)

#loader 执行顺序

  1. 分类
  • pre： 前置 loader
  • normal： 普通 loader
  • inline： 内联 loader
  • post： 后置 loader
  1. 执行顺序
  • 4 类 loader 的执行优级为：pre > normal > inline > post 。
  • 相同优先级的 loader 执行顺序为：从右到左，从下到上。

例如：

// 此时loader执行顺序：loader3 - loader2 - loader1
module: {
  rules: [
    {
      test: /\.js$/,
      loader: "loader1",
    },
    {
      test: /\.js$/,
      loader: "loader2",
    },
    {
      test: /\.js$/,
      loader: "loader3",
    },
  ],
},

// 此时loader执行顺序：loader1 - loader2 - loader3
module: {
  rules: [
    {
      enforce: "pre",
      test: /\.js$/,
      loader: "loader1",
    },
    {
      // 没有enforce就是normal
      test: /\.js$/,
      loader: "loader2",
    },
    {
      enforce: "post",
      test: /\.js$/,
      loader: "loader3",
    },
  ],
},
  1. 使用 loader 的方式
  • 配置方式：在 webpack.config.js 文件中指定 loader。（pre、normal、post loader）
  • 内联方式：在每个 import 语句中显式指定 loader。（inline loader）
  1. inline loader

用法：import Styles from 'style-loader!css-loader?modules!./styles.css';

含义：

  • 使用 css-loader 和 style-loader 处理 styles.css 文件
  • 通过 ! 将资源中的 loader 分开

inline loader 可以通过添加不同前缀，跳过其他类型 loader。

  • ! 跳过 normal loader。
import Styles from '!style-loader!css-loader?modules!./styles.css';
  • -! 跳过 pre 和 normal loader。
import Styles from '-!style-loader!css-loader?modules!./styles.css';
  • !! 跳过 pre、 normal 和 post loader。
import Styles from '!!style-loader!css-loader?modules!./styles.css';

#开发一个 loader

#1. 最简单的 loader

/*
  loader就是一个函数
  当webpack解析资源时，会调用相应的loader去处理
  loader接受到文件内容作为参数，返回内容出去
    content 文件内容
    map SourceMap
    meta 别的loader传递的数据
*/
// loaders/loader1.js
module.exports = function loader1(content) {
  console.log("hello loader");
  return content;
};

它接受要处理的源码作为参数，输出转换后的 js 代码。

#2. loader 接受的参数

  • content 源文件的内容
  • map SourceMap 数据
  • meta 数据，可以是任何内容

#loader 分类

#1. 同步 loader

同步loader中不能处理异步 会报错

module.exports = function (content, map, meta) {
  return content;
};

this.callback 方法则更灵活，因为它允许传递多个参数，而不仅仅是 content。

module.exports = function (content, map, meta) {
  // 传递map，让source-map不中断
  // 传递meta，让下一个loader接收到其他参数
  /*
    第一个参数：err 代表是否有错误
    第二个参数：content 处理后的内容
    第三个参数：source-map 继续传递source-map
    第四个参数：meta 给下一个loader传递参数
  */  
  this.callback(null, content, map, meta);
  return; // 当调用 callback() 函数时，总是返回 undefined
};

#2. 异步 loader

module.exports = function (content, map, meta) {
  const callback = this.async();
  // 进行异步操作
  setTimeout(() => {
    callback(null, result, map, meta);
  }, 1000);
};

由于同步计算过于耗时，在 Node.js 这样的单线程环境下进行此操作并不是好的方案，我们建议尽可能地使你的 loader 异步化。但如果计算量很小，同步 loader 也是可以的。

#3. Raw Loader

默认情况下，资源文件会被转化为 UTF-8 字符串，然后传给 loader。通过设置 raw 为 true，loader 可以接收原始的 Buffer。

module.exports = function (content) {
  // content是一个Buffer数据
  return content;
};
module.exports.raw = true; // 开启 Raw Loader

#4. Pitching Loader

module.exports = function (content) {
  return content;
};
module.exports.pitch = function (remainingRequest, precedingRequest, data) {
  console.log("do somethings");
};

webpack 会先从左到右执行 loader 链中的每个 loader 上的 pitch 方法（如果有），然后再从右到左执行 loader 链中的每个 loader 上的普通 loader 方法。

image-20220724214502871

loader执行流程

在这个过程中如果任何 pitch 有返回值，则 loader 链被阻断。webpack 会跳过后面所有的的 pitch 和 loader，直接进入上一个 loader （这里是pitch2发生了退出）。

loader执行流程

#loader API

方法名含义用法
this.async异步回调 loader。返回 this.callback 作用是将loader变为异步函数const callback = this.async()
this.callback可以同步或者异步调用的并返回多个结果的函数this.callback(err, content, sourceMap?, meta?)
this.getOptions(schema)获取 loader 的 options schema是规则this.getOptions(schema)
this.emitFile产生一个文件this.emitFile(name, content, sourceMap)
this.utils.contextify返回一个相对路径this.utils.contextify(context, request) request表示处理的路径
this.utils.absolutify返回一个绝对路径this.utils.absolutify(context, request)

更多文档，请查阅 webpack 官方 loader api 文档open in new window

#手写 clean-log-loader

作用：用来清理 js 代码中的console.log

// loaders/clean-log-loader.js
module.exports = function cleanLogLoader(content) {
  // 将console.log替换为空
  return content.replace(/console\.log\(.*\);?/g, "");
};

#手写 banner-loader

作用：给 js 代码添加文本注释

  • loaders/banner-loader/index.js
const schema = require("./schema.json");

module.exports = function (content) {
  // 获取loader的options，同时对options内容进行校验
  // schema是options的校验规则（符合 JSON schema 规则）
  const options = this.getOptions(schema);

  const prefix = `
    /*
    * Author: ${options.author}
    */
  `;

  return `${prefix} \n ${content}`;
};
  • loaders/banner-loader/schema.json
{
  "type": "object",
  "properties": {
    "author": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

#手写 babel-loader （完成了一部分）

作用：编译 js 代码，将 ES6+语法编译成 ES5-语法。

  • 下载依赖 babel的预设
npm i @babel/core @babel/preset-env -D

  • webpack.config,js

    module: {
    rules: [
      // {
      //   test: /\.js$/,
      //   loader: "./loaders/test-loader.js",
      // },
      {
        test: /\.js$/,
        // 执行顺序：从右到左，从下到上
        // use: ["./loaders/demo/test1", "./loaders/demo/test2"],
        // use: ["./loaders/demo/test2", "./loaders/demo/test1"],
        // loader: "./loaders/demo/test3.js",
        // use: ["./loaders/demo/test4", "./loaders/demo/test5", "./loaders/demo/test6"],
        loader: "./loaders/clean-log-loader",
      },
      // {
      //   test: /\.js$/,
      //   loader: "./loaders/banner-loader",
      //   options: {
      //     author: "老王",
      //     // age: 18, // 不能新增字段，不然会报错
      //   },
      // },
      {
        test: /\.js$/,
        loader: "./loaders/babel-loader",
        options: {
          presets: ["@babel/preset-env"],
        },
      },

  • loaders/babel-loader/index.js

const schema = require("./schema.json");
const babel = require("@babel/core");

module.exports = function (content) {
  const options = this.getOptions(schema);
  // 使用异步loader
  const callback = this.async();
  // 使用babel对js代码进行编译
  babel.transform(content, options, function (err, result) {
    if (err) callback(err);
    else callback(null, result.code);
  });
};
  • loaders/banner-loader/schema.json （验证规则）
{
  "type": "object",
  "properties": {
    "presets": {
      "type": "array"
    }
  },
  "additionalProperties": true
}

#手写 file-loader

作用：将文件原封不动输出出去

  • 下载包
npm i loader-utils -D
  • loaders/file-loader.js
const loaderUtils = require("loader-utils");

module.exports = function (content) {
  // 1. 根据文件内容生成带hash值文件名
  let interpolatedName = loaderUtils.interpolateName(this, "[hash].[ext][query]", {
    content,
  });
  interpolatedName = `images/${interpolatedName}`
  // console.log(interpolatedName);
  // 2. 将文件输出出去
  this.emitFile(interpolatedName, content);
  // 3. 返回：module.exports = "文件路径（文件名）"
  return `module.exports = "${interpolatedName}"`;
};

// 需要处理图片、字体等文件。它们都是buffer数据
// 需要使用raw loader才能处理
module.exports.raw = true;


const loaderUtils = require("loader-utils");

function fileLoader(content) {
  // 根据文件内容生产一个新的文件名称
  const filename = loaderUtils.interpolateName(this, "[hash].[ext]", {
    content,
  });
  // 输出文件
  this.emitFile(filename, content);
  // 暴露出去，给js引用。
  // 记得加上''
  return `export default '${filename}'`;
}

// loader 解决的是二进制的内容
// 图片是 Buffer 数据
fileLoader.raw = true;

module.exports = fileLoader;
  • loader 配置
{
  test: /\.(png|jpe?g|gif)$/,
  loader: "./loaders/file-loader.js",
  type: "javascript/auto", // 解决图片重复打包问题  阻止webpack默认处理图片资源,
},

#手写 style-loader

作用：动态创建 style 标签，插入 js 中的样式代码，使样式生效。

  • loaders/style-loader.js

    module.exports = function (content) {
  /*
    1. 直接使用style-loader，只能处理样式
      不能处理样式中引入的其他资源

      use: ["./loaders/style-loader"],

    2. 借助css-loader解决样式中引入的其他资源的问题

      use: ["./loaders/style-loader", "css-loader"],

      问题是css-loader暴露了一段js代码，style-loader需要执行js代码，得到返回值，再动态创建style标签，插入到页面上
      不好操作

    3. style-loader使用pitch loader用法
  */
  // const script = `
  //   const styleEl = document.createElement('style');
  //   styleEl.innerHTML = ${JSON.stringify(content)};
  //   document.head.appendChild(styleEl);
  // `;
  // return script;
};

module.exports.pitch = function (remainingRequest) {
  // remainingRequest 剩下还需要处理的loader
  // console.log(remainingRequest); // C:\Users\86176\Desktop\webpack\source\node_modules\css-loader\dist\cjs.js!C:\Users\86176\Desktop\webpack\source\src\css\index.css

  // 1. 将 remainingRequest 中绝对路径改成相对路径（因为后面只能使用相对路径操作）
  const relativePath = remainingRequest
    .split("!")
    .map((absolutePath) => {
      // 返回相对路径
      return this.utils.contextify(this.context, absolutePath);
    })
    .join("!");

  // console.log(relativePath); // ../../node_modules/css-loader/dist/cjs.js!./index.css

  // 2. 引入css-loader处理后的资源
  // 3. 创建style，将内容插入页面中生效
  const script = `
    import style from "!!${relativePath}";
    const styleEl = document.createElement('style');
    styleEl.innerHTML = style;
    document.head.appendChild(styleEl);
  `;

  // 中止后面loader执行
  return script;
};


const styleLoader = () => {};

styleLoader.pitch = function (remainingRequest) {
  /*
    remainingRequest: C:\Users\86176\Desktop\source\node_modules\css-loader\dist\cjs.js!C:\Users\86176\Desktop\source\src\css\index.css
      这里是inline loader用法，代表后面还有一个css-loader等待处理

    最终我们需要将remainingRequest中的路径转化成相对路径，webpack才能处理
      希望得到：../../node_modules/css-loader/dist/cjs.js!./index.css

    所以：需要将绝对路径转化成相对路径
    要求：
      1. 必须是相对路径
      2. 相对路径必须以 ./ 或 ../ 开头
      3. 相对路径的路径分隔符必须是 / ，不能是 \
  */
  const relativeRequest = remainingRequest
    .split("!")
    .map((part) => {
      // 将路径转化为相对路径
      const relativePath = this.utils.contextify(this.context, part);
      return relativePath;
    })
    .join("!");

  /*
    !!${relativeRequest} 
      relativeRequest：../../node_modules/css-loader/dist/cjs.js!./index.css
      relativeRequest是inline loader用法，代表要处理的index.css资源, 使用css-loader处理
      !!代表禁用所有配置的loader，只使用inline loader。（也就是外面我们style-loader和css-loader）,它们被禁用了，只是用我们指定的inline loader，也就是css-loader

    import style from "!!${relativeRequest}"
      引入css-loader处理后的css文件
      为什么需要css-loader处理css文件，不是我们直接读取css文件使用呢？
      因为可能存在@import导入css语法，这些语法就要通过css-loader解析才能变成一个css文件，否则我们引入的css资源会缺少
    const styleEl = document.createElement('style')
      动态创建style标签
    styleEl.innerHTML = style
      将style标签内容设置为处理后的css代码
    document.head.appendChild(styleEl)
      添加到head中生效
  */
  const script = `
    import style from "!!${relativeRequest}"
    const styleEl = document.createElement('style')
    styleEl.innerHTML = style
    document.head.appendChild(styleEl)
  `;

  // style-loader是第一个loader, 由于return导致熔断，所以其他loader不执行了（不管是normal还是pitch）
  return script;
};

module.exports = styleLoader;

Plugin 原理

#Plugin 的作用

通过插件我们可以扩展 webpack，加入自定义的构建行为，使 webpack 可以执行更广泛的任务，拥有更强的构建能力。

#Plugin 工作原理

webpack 就像一条生产线，要经过一系列处理流程后才能将源文件转换成输出结果。 这条生产线上的每个处理流程的职责都是单一的，多个流程之间有存在依赖关系，只有完成当前处理后才能交给下一个流程去处理。 插件就像是一个插入到生产线中的一个功能，在特定的时机对生产线上的资源做处理。webpack 通过 Tapable 来组织这条复杂的生产线。 webpack 在运行过程中会广播事件，插件只需要监听它所关心的事件，就能加入到这条生产线中，去改变生产线的运作。 webpack 的事件流机制保证了插件的有序性，使得整个系统扩展性很好。 ——「深入浅出 Webpack」

站在代码逻辑的角度就是：webpack 在编译代码过程中，会触发一系列 Tapable 钩子事件，插件所做的，就是找到相应的钩子，往上面挂上自己的任务，也就是注册事件，这样，当 webpack 构建的时候，插件注册的事件就会随着钩子的触发而执行了。

#Webpack 内部的钩子

#什么是钩子

钩子的本质就是：事件。为了方便我们直接介入和控制编译过程，webpack 把编译过程中触发的各类关键事件封装成事件接口暴露了出来。这些接口被很形象地称做：hooks（钩子）。开发插件，离不开这些钩子。

#Tapable

Tapable 为 webpack 提供了统一的插件接口（钩子）类型定义，它是 webpack 的核心功能库。webpack 中目前有十种 hooks，在 Tapable 源码中可以看到，他们是：

// https://github.com/webpack/tapable/blob/master/lib/index.js
exports.SyncHook = require("./SyncHook");
exports.SyncBailHook = require("./SyncBailHook");
exports.SyncWaterfallHook = require("./SyncWaterfallHook");
exports.SyncLoopHook = require("./SyncLoopHook");
exports.AsyncParallelHook = require("./AsyncParallelHook");
exports.AsyncParallelBailHook = require("./AsyncParallelBailHook");
exports.AsyncSeriesHook = require("./AsyncSeriesHook");
exports.AsyncSeriesBailHook = require("./AsyncSeriesBailHook");
exports.AsyncSeriesLoopHook = require("./AsyncSeriesLoopHook");
exports.AsyncSeriesWaterfallHook = require("./AsyncSeriesWaterfallHook");
exports.HookMap = require("./HookMap");
exports.MultiHook = require("./MultiHook");

Tapable 还统一暴露了三个方法给插件，用于注入不同类型的自定义构建行为：

  • tap：可以注册同步钩子和异步钩子。
  • tapAsync：回调方式注册异步钩子。
  • tapPromise：Promise 方式注册异步钩子。

#Plugin 构建对象

#Compiler

compiler 对象中保存着完整的 Webpack 环境配置，每次启动 webpack 构建时它都是一个独一无二，仅仅会创建一次的对象。

这个对象会在首次启动 Webpack 时创建，我们可以通过 compiler 对象上访问到 Webapck 的主环境配置，比如 loader 、 plugin 等等配置信息。

它有以下主要属性：

  • compiler.options 可以访问本次启动 webpack 时候所有的配置文件，包括但不限于 loaders 、 entry 、 output 、 plugin 等等完整配置信息。
  • compiler.inputFileSystem 和 compiler.outputFileSystem 可以进行文件操作，相当于 Nodejs 中 fs。
  • compiler.hooks 可以注册 tapable 的不同种类 Hook，从而可以在 compiler 生命周期中植入不同的逻辑。

compiler hooks 文档open in new window

#Compilation

compilation 对象代表一次资源的构建，compilation 实例能够访问所有的模块和它们的依赖。

一个 compilation 对象会对构建依赖图中所有模块，进行编译。 在编译阶段，模块会被加载(load)、封存(seal)、优化(optimize)、 分块(chunk)、哈希(hash)和重新创建(restore)。

它有以下主要属性：

  • compilation.modules 可以访问所有模块，打包的每一个文件都是一个模块。
  • compilation.chunks chunk 即是多个 modules 组成而来的一个代码块。入口文件引入的资源组成一个 chunk，通过代码分割的模块又是另外的 chunk。
  • compilation.assets 可以访问本次打包生成所有文件的结果。
  • compilation.hooks 可以注册 tapable 的不同种类 Hook，用于在 compilation 编译模块阶段进行逻辑添加以及修改。

compilation hooks 文档open in new window

#生命周期简图

Webpack 插件生命周期

#开发一个插件

#最简单的插件

  • plugins/test-plugin.js
/*
  1. webpack加载webpack.config.js中所有配置，此时就会new TestPlugin(), 执行插件的constructor
  2. webpack创建compiler对象
  3. 遍历所有plugins中插件，调用插件的apply方法
  4. 执行剩下编译流程（触发各个hooks事件）
*/
class TestPlugin {
  constructor() {
    console.log("TestPlugin constructor()");
  }
  apply(compiler) {
    console.log("TestPlugin apply()");
  }
}

module.exports = TestPlugin;

#注册 hook

类似于

class TestPlugin {
  constructor() {
    console.log("TestPlugin constructor()");
  }
  // 1. webpack读取配置时，new TestPlugin() ，会执行插件 constructor 方法
  // 2. webpack创建 compiler 对象
  // 3. 遍历所有插件，调用插件的 apply 方法
  apply(compiler) {
    console.log("TestPlugin apply()");

    // 从文档可知, compile hook 是 SyncHook, 也就是同步钩子, 只能用tap注册
    compiler.hooks.compile.tap("TestPlugin", (compilationParams) => {
      console.log("compiler.compile()");
    });

    // 从文档可知, make 是 AsyncParallelHook, 也就是异步并行钩子, 特点就是异步任务同时执行
    // 可以使用 tap、tapAsync、tapPromise 注册。
    // 如果使用tap注册的话，进行异步操作是不会等待异步操作执行完成的。
    compiler.hooks.make.tap("TestPlugin", (compilation) => {
      setTimeout(() => {
        console.log("compiler.make() 111");
      }, 2000);
    });

    // 使用tapAsync、tapPromise注册，进行异步操作会等异步操作做完再继续往下执行
    compiler.hooks.make.tapAsync("TestPlugin", (compilation, callback) => {
      setTimeout(() => {
        console.log("compiler.make() 222");
        // 必须调用
        callback();
      }, 1000);
    });

    compiler.hooks.make.tapPromise("TestPlugin", (compilation) => {
      console.log("compiler.make() 333");
      // 必须返回promise
      return new Promise((resolve) => {
        resolve();
      });
    });

    // 从文档可知, emit 是 AsyncSeriesHook, 也就是异步串行钩子，特点就是异步任务顺序执行
    compiler.hooks.emit.tapAsync("TestPlugin", (compilation, callback) => {
      setTimeout(() => {
        console.log("compiler.emit() 111");
        callback();
      }, 3000);
    });

    compiler.hooks.emit.tapAsync("TestPlugin", (compilation, callback) => {
      setTimeout(() => {
        console.log("compiler.emit() 222");
        callback();
      }, 2000);
    });

    compiler.hooks.emit.tapAsync("TestPlugin", (compilation, callback) => {
      setTimeout(() => {
        console.log("compiler.emit() 333");
        callback();
      }, 1000);
    });
  }
}

module.exports = TestPlugin;

#启动调试

通过调试查看 compiler 和 compilation 对象数据情况。

  1. package.json 配置指令

    关键在于添加这一项

    “scripts”: {
    “debug”: “node --inspect-brk ./node_modules/webpack-cli/bin/cli.js”
    },

{
  "name": "source",
  "version": "1.0.0",
  "scripts": {
    "debug": "node --inspect-brk ./node_modules/webpack-cli/bin/cli.js"
  },
  "keywords": [],
  "author": "xiongjian",
  "license": "ISC",
  "devDependencies": {
    "@babel/core": "^7.17.10",
    "@babel/preset-env": "^7.17.10",
    "css-loader": "^6.7.1",
    "loader-utils": "^3.2.0",
    "webpack": "^5.72.0",
    "webpack-cli": "^4.9.2"
  }
}
  1. 运行指令
npm run debug

此时控制台输出以下内容：

PS C:\Users\86176\Desktop\source> npm run debug

> source@1.0.0 debug
> node --inspect-brk ./node_modules/webpack-cli/bin/cli.js

Debugger listening on ws://127.0.0.1:9229/629ea097-7b52-4011-93a7-02f83c75c797
For help, see: https://nodejs.org/en/docs/inspecto
  1. 打开 Chrome 浏览器，F12 打开浏览器调试控制台。

此时控制台会显示一个绿色的图标

调试控制台

  1. 点击绿色的图标进入调试模式。
  2. 在需要调试代码处用 debugger 打断点，代码就会停止运行，从而调试查看数据情况。

#BannerWebpackPlugin

  1. 作用：给打包输出文件添加注释。
  2. 开发思路:
  • 需要打包输出前添加注释：需要使用 compiler.hooks.emit 钩子, 它是打包输出前触发。
  • 如何获取打包输出的资源？compilation.assets 可以获取所有即将输出的资源文件。
  1. 实现：

image-20220725215857296

class BannerWebpackPlugin {
  constructor(options = {}) {
    this.options = options;
  }

  apply(compiler) {
    // 在资源输出之前触发
    compiler.hooks.emit.tap("BannerWebpackPlugin", (compilation) => {
      // debugger;
      const extensions = ["css", "js"];
      // 1. 获取即将输出的资源文件：compilation.assets
      // 2. 过滤只保留js和css资源
      const assets = Object.keys(compilation.assets).filter((assetPath) => {
        // 将文件名切割 ['xxxx', 'js'] ['xxxx', 'css']
        const splitted = assetPath.split(".");
        // 获取最后一个文件扩展名
        const extension = splitted[splitted.length - 1];
        // 判断是否包含
        return extensions.includes(extension);
      });

      const prefix = `/*
* Author: ${this.options.author}
*/
`;
      // 3. 遍历剩下资源添加上注释
      // console.log(assets);
      assets.forEach((asset) => {
        // 获取原来内容
        const source = compilation.assets[asset].source();
        // 拼接上注释
        const content = prefix + source;

        // 修改资源
        compilation.assets[asset] = {
          // 最终资源输出时，调用source方法，source方法的返回值就是资源的具体内容
          source() {
            return content;
          },
          // 资源大小
          size() {
            return content.length;
          },
        };
      });
    });
  }
}

module.exports = BannerWebpackPlugin;

#CleanWebpackPlugin

  1. 作用：在 webpack 打包输出前将上次打包内容清空。
  2. 开发思路：
  • 如何在打包输出前执行？需要使用 compiler.hooks.emit 钩子, 它是打包输出前触发。
  • 如何清空上次打包内容？
    • 获取打包输出目录：通过 compiler 对象。
    • 通过文件操作清空内容：通过 compiler.outputFileSystem 操作文件。
  1. 实现：
// plugins/clean-webpack-plugin.js
class CleanWebpackPlugin {
  apply(compiler) {
    // 2. 获取打包输出的目录
    const outputPath = compiler.options.output.path;
    const fs = compiler.outputFileSystem;
    // 1. 注册钩子：在打包输出之前 emit
    compiler.hooks.emit.tap("CleanWebpackPlugin", (compilation) => {
      // 3. 通过fs删除打包输出的目录下的所有文件
      this.removeFiles(fs, outputPath);
    });
  }

  removeFiles(fs, filepath) {
    // 想要删除打包输出目录下所有资源，需要先将目录下的资源删除，才能删除这个目录
    // 1. 读取当前目录下所有资源
    const files = fs.readdirSync(filepath);
    // console.log(files); // [ 'images', 'index.html', 'js' ]
    // 2. 遍历一个个删除
    files.forEach((file) => {
      // 2.1 遍历所有文件，判断是文件夹还是文件
      const path = `${filepath}/${file}`;
      const fileStat = fs.statSync(path);
      // console.log(fileStat);
      if (fileStat.isDirectory()) {
        // 2.2 是文件夹，就得删除下面所有文件，才能删除文件夹
        this.removeFiles(fs, path);
      } else {
        // 2.3 是文件，直接删除
        fs.unlinkSync(path);
      }
    });
  }
}

module.exports = CleanWebpackPlugin;

#AnalyzeWebpackPlugin

  1. 作用：分析 webpack 打包资源大小，并输出分析文件。
  2. 开发思路:
  • 在哪做? compiler.hooks.emit, 它是在打包输出前触发，我们需要分析资源大小同时添加上分析后的 md 文件。
  1. 实现：
class AnalyzeWebpackPlugin {
  apply(compiler) {
    compiler.hooks.emit.tap("AnalyzeWebpackPlugin", (compilation) => {
      // 1. 遍历所有即将输出文件，得到其大小
      /*
        将对象变成一个二维数组：
          对象：
            {
              key1: value1,
              key2: value2 
            }
          二维数组：
            [
              [key1, value1],
              [key2, value2]
            ]
      */
      const assets = Object.entries(compilation.assets);

      /*
          md中表格语法：
            | 资源名称 | 资源大小 |
            | --- | --- |
            | xxx.js | 10kb |
      */
      let content = `| 资源名称 | 资源大小 |
| --- | --- |`;

      assets.forEach(([filename, file]) => {
        content += `\n| ${filename} | ${Math.ceil(file.size() / 1024)}kb |`;
      });

      // 2. 生成一个md文件
      compilation.assets["analyze.md"] = {
        source() {
          return content;
        },
        size() {
          return content.length;
        },
      };
    });
  }
}

module.exports = AnalyzeWebpackPlugin;

image-20220725222725091

#InlineChunkWebpackPlugin

  1. 作用：webpack 打包生成的 runtime 文件太小了，额外发送请求性能不好，所以需要将其内联到 js 中，从而减少请求数量。
  2. 开发思路:

  • 我们需要借助html-webpack-plugin来实现

    • 在 html-webpack-plugin 输出 index.html 前将内联 runtime 注入进去
    • 删除多余的 runtime 文件

  • 如何操作 html-webpack-plugin？官方文档open in new window

  1. 实现：
// plugins/inline-chunk-webpack-plugin.js
const HtmlWebpackPlugin = require("safe-require")("html-webpack-plugin");

class InlineChunkWebpackPlugin {
  constructor(tests) {
    this.tests = tests;
  }

  apply(compiler) {
    compiler.hooks.compilation.tap("InlineChunkWebpackPlugin", (compilation) => {
      const hooks = HtmlWebpackPlugin.getHooks(compilation);

      hooks.alterAssetTagGroups.tap("InlineChunkWebpackPlugin", (assets) => {
        assets.headTags = this.getInlineTag(assets.headTags, compilation.assets);
        assets.bodyTags = this.getInlineTag(assets.bodyTags, compilation.assets);
      });

      hooks.afterEmit.tap("InlineChunkHtmlPlugin", () => {
        Object.keys(compilation.assets).forEach((assetName) => {
          if (this.tests.some((test) => assetName.match(test))) {
            delete compilation.assets[assetName];
          }
        });
      });
    });
  }

  getInlineTag(tags, assets) {
    return tags.map((tag) => {
      if (tag.tagName !== "script") return tag;

      const scriptName = tag.attributes.src;

      if (!this.tests.some((test) => scriptName.match(test))) return tag;

      return { tagName: "script", innerHTML: assets[scriptName].source(), closeTag: true };
    });
  }
}

module.exports = InlineChunkWebpackPlugin;
xjt_0901
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
custom-plugin:webpack自定义插件
05-11
顾名思义，webpack plugin是作为webpack的一个插件机制存在，将webpack提供的处理方法暴露给第三方（开发者）来开发。在整个项目架构中，往往起宏观上的作用。例如HtmlWebpackPlugin，修改一些文件，inject一些用户...
webpack的自定义插件学习
qq_43568455的博客
01-11 929
webpack自定义插件
webpack开发自定义功能插件
问白的博客
03-27 3677
webpack 插件开发 简介 使用webpack开发一些自定义功能的插件，最主要的目的是了解webpack工作流的方式，更深层次的认识和了解webpack工作原理，这样以后如有需要，也可结合自身所在业务去定制不同的插件，来提高开发效率。 webpack提供的hook(钩子) 在webpack整个工作流中在不同的阶段对外提供了不同的hook,使得开发者可以利用这些钩子做一些自己定制化功能的plug...
【webpack自定义插件】实现一个webpack自定义插件
lei_wang_lei的博客
03-28 629
如何开发一个webpack自定义插件
webpack自定义plugin
我的博客简介
08-24 219
常见的Plugin：这些Plugin是如何被注册到webpack的生命周期中的呢第一：在webpack函数的createCompiler方法中，注册了所有的插件第二：在注册插件时，会调用插件函数或者插件对象的apply方法第三：插件方法会接收compiler对象，我们可以通过compiler对象来注册Hook的事件第四：某些插件也会传入一个compilation的对象，我们也可以监听compilation的Hook事件。
自定义一个webpack一个插件
weixin_41904683的博客
03-06 387
自定义实现一个webapck插件（no-console-plugin）
mini-program-webpack-loader:基于 webpack 的小程序构建工具
05-17
webpack 的所有能力支持在 wxml, wxss, wxs, json 文件中使用模块别名支持全局注册自定义组件支持多小程序项目合并支持小程序项目分析插件使用 const MiniPlugin = require('mini-program-webpack-loader').plugin;...
phaser-webpack-loader：Phaser + Webpack的资产加载器
02-03
与Webpack集成以实现自动缓存清除。 支持所有文件类型。 支持视网膜支持的资产后缀（“ @ 2x”，“ @ 3x”等）。 自定义事件，用于跟踪每个文件的加载情况（包括字体）。 安装 通过NPM（或Yarn）安装插件： npm...
vue-separate-files-webpack-loader：用于Webpack的Vue分隔组件加载器
02-24
Vue单独的文件Webpack加载器 快速创建.vue...安装npm i -D vue-separate-files-webpack-loader 或者yarn add -D vue-separate-files-webpack-loader用法VueLoader v15及更高版本由于在版本15中引入了强制性插件用法，
Webpack全面实战企业级项目搭建视频.zip
07-06
目录网盘文件永久链接 01_1_1_课程介绍 ...16_2_15_loader_自定义图片打包目录和打包名称 17_2_16_loader_处理js文件之babel的基本使用 18_2_17_loader_处理js文件之转换更高级的语法 19_2_18_loade.........
如何用webpack开发一个插件
qq_37833745的博客
08-09 997
目标： 我没想要开发一个插件，用来删除 打包文件 (dist/*.js) 的注释 前言： webpack 要求插件，必须是一个函数或者是一个包含 apply 方法的对象 emit 钩子：是 webpack即将往输出目录输出时执行的钩子函数 1：在 webpack.config.js 里面定义 插件 并 加载插件 我们自定义一个插件。插件名字叫 MyPlugin // 定义插件：MyPlugin class MyPlugin { // apply()在...
Webpack 自定义插件编写
weixin_45032067的博客
05-19 2239
当编写一个自定义插件时，需要知道webpack 插件由以下组成： 一个 JavaScript 命名函数或 JavaScript 类。 在插件函数的 prototype 上定义一个apply方法。 指定一个绑定到 webpack 自身的事件钩子。 处理 webpack 内部实例的特定数据。 功能完成后调用 webpack 提供的回调。 基本插件架构 插件是由「具有apply方法的 prototype 对象」所实例化出来的。这个apply方法在安装插件时，会被 webpack compi......
3. webpack 自定义模板 html-webpack-plugin插件 （多页面多入口文件打包）
黄彪博客
01-20 5480
文章目录文章参考问题描述html-webpack-plugin的作用安装插件webpack.config.js 默认配置参数配置说明hashHTML如何让 title 变为配置的信息inject 文章参考 HtmlWebpackPlugin 中文文档 HtmlWebpackPlugin github webpack4 之html-webpack-plugin html-webpack-plugi...
webpack配置（超全loader和插件）
weixin_42574100的博客
04-13 1639
webpack webpack中的loader webpack 插件
webpack 编写插件，webpack 自定义插件
qq_41974199的博客
05-27 663
webpack 编写插件，webpack 自定义插件 文章目录webpack 编写插件，webpack 自定义插件1：安装 webpack2：创建装载机与主文件 index.js3：创建自定义插件4：使用插件5：做一些有趣的事情，另外生成一个描述文件 1：安装 webpack 安装webpack: npm install --save-dev webpack npm install --save-dev webpack-cli 2：创建装载机与主文件 index.js 新建主文件 index.js: c
需要了解的常用Webpack插件配置-loader加载器
世界和我们都不该止步于此
04-22 1319
我们都知道通过安装和配置第三方插件，可以使我们的webpack拓展更多的功能，虽然之后开发项目不需要我们自己去进行这些繁琐的配置，但是我们需要知道这些，在必要时我们可以去做出修改 比如我们在初识webpack中提到的webpack-dev-server(每当我们修改了源代码，webpack就会自动的进行项目打包和构建)以及html-webpack-plugin（自定制index页面内容，将存在于内存中的页面克隆一份到项目根目录） 不需要会-但是一定要知道的简单配置Webpack操作_Developer小
webpack中的loader与各插件
weixin_67398884的博客
05-12 587
一、前端工程化与webpack 1.1 前端工程化解决方案 1.2 webpack的基本使用、 1.2.1 安装配置及运行webpack 实现列表隔行变色的效果步骤（jquery） 第一步生成一个package.json以便于以后安装的包都放进在里面 第四步在终端输入命令就可以在package包里安装jquery使用了 vscode里面直接ctrl+~键可以打开终端 正常来说需要导入jquery需要在html文件中script src=，但是es6中可在js文件中导入jquery，语法、 1、从jque
webpack的loader和插件plugin
郊眠寺
06-30 242
在webpack看来 一切皆模块，图片，样式文件，js文件… 。 但是webpack默认只能处理js模块，对于非js的内容，例如css, less文件，图片文件等等 它就需要一些帮手来处理了。这些帮手就是loader。 两个css文件里随便写点div样式,html里面写个divstyle.css使用 @import “public.css” 引入public.css文件算了我还是写一下简单点的代码吧style.css内容: 在.js中导入css 自已的main.js，在 src/js/main.js中，引入
vue-cli Webpack之Loader原理及自定义Loader
細水、長流√的专栏
11-08 1957
Webpack之Loader原理及自定义Loader
webpack里loader和plugun
最新发布
05-13
插件可以在Webpack运行的各个阶段执行，包括打包前、打包中、打包后等。 总的来说，loader是用于加载和转换文件的，而plugin则是用于增强Webpack的功能和扩展其能力的。两者的作用不同，但都是为了让Webpack更加...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值