webpack5高级优化——代码运行性能

Posted 天界程序员

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了webpack5高级优化——代码运行性能相关的知识,希望对你有一定的参考价值。

1. 代码分割(code split)

打包代码时会将所有 js 文件打包到一个文件中,体积太大了。我们如果只要渲染首页,就应该只加载首页的 js 文件,其他文件不应该加载。

所以我们需要将打包生成的文件进行代码分割,生成多个 js 文件,渲染哪个页面就只加载某个 js 文件,这样加载的资源就少,速度就更快。

代码分割(Code Split)主要做了两件事:

  1. 分割文件:将打包生成的文件进行分割,生成多个 js 文件。
  2. 按需加载:需要哪个文件就加载哪个文件。

demo案例演示

1、demo目录结构

├── public
├── src
|   ├── app.js
|   └── main.js
├── package.json
└── webpack.config.js

2、安装demo依赖

先初始化一个package.json文件

npm init -y 

安装webpack所需的依赖

npm i webpack webpack-cli html-webpack-plugin -D

3、新建demo里面的文件

app.js

console.log("hello app");

main.js

console.log("hello main");

4、配置demo的webpack

// webpack.config.js
const path = require("path");
const HtmlWebpackPlugin = require("html-webpack-plugin");

module.exports = 
  // 单入口
  // entry: './src/main.js',
  // 多入口
  entry: 
    main: "./src/main.js",
    app: "./src/app.js",
  ,
  output: 
    path: path.resolve(__dirname, "./dist"),
    // [name]是webpack命名规则,使用chunk的name作为输出的文件名。
    // 什么是chunk?打包的资源就是chunk,输出出去叫bundle。
    // chunk的name是啥呢? 比如: entry中xxx: "./src/xxx.js", name就是xxx。注意是前面的xxx,和文件名无关。
    // 为什么需要这样命名呢?如果还是之前写法main.js,那么打包生成两个js文件都会叫做main.js会发生覆盖。(实际上会直接报错的)
    filename: "js/[name].js",
    clear: true,
  ,
  plugins: [
    new HtmlWebpackPlugin(
      template: "./public/index.html",
    ),
  ],
  mode: "production",
;

5、运行webpack查看打包文件

npx webpack

此时在 dist 目录我们能看到输出了两个 js 文件。

总结:配置了几个入口,至少输出几个 js 文件。


提取重复代码

如果多入口文件中都引用了同一份代码,我们不希望这份代码被打包到两个文件中,导致代码重复,体积更大。

我们需要提取多入口的重复代码,只打包生成一个js文件,其他文件引用它就好。

1、修改文件内容

app.js

import  sum  from "./math";

console.log("hello app");
console.log(sum(1, 2, 3, 4));

main.js

import  sum  from "./math";

console.log("hello main");
console.log(sum(1, 2, 3, 4, 5));

math.js

export const sum = (...args) => 
  return args.reduce((p, c) => p + c, 0);
;

2、修改配置文件

// webpack.config.js
const path = require("path");
const HtmlWebpackPlugin = require("html-webpack-plugin");

module.exports = 
  // 单入口
  // entry: './src/main.js',
  // 多入口
  entry: 
    main: "./src/main.js",
    app: "./src/app.js",
  ,
  output: 
    path: path.resolve(__dirname, "./dist"),
    // [name]是webpack命名规则,使用chunk的name作为输出的文件名。
    // 什么是chunk?打包的资源就是chunk,输出出去叫bundle。
    // chunk的name是啥呢? 比如: entry中xxx: "./src/xxx.js", name就是xxx。注意是前面的xxx,和文件名无关。
    // 为什么需要这样命名呢?如果还是之前写法main.js,那么打包生成两个js文件都会叫做main.js会发生覆盖。(实际上会直接报错的)
    filename: "js/[name].js",
    clean: true,
  ,
  plugins: [
    new HtmlWebpackPlugin(
      template: "./public/index.html",
    ),
  ],
  mode: "production",
  optimization: 
    // 代码分割配置
    splitChunks: 
      chunks: "all", // 对所有模块都进行分割
      // 以下是默认值
      // minSize: 20000, // 分割代码最小的大小
      // minRemainingSize: 0, // 类似于minSize,最后确保提取的文件大小不能为0
      // minChunks: 1, // 至少被引用的次数,满足条件才会代码分割
      // maxAsyncRequests: 30, // 按需加载时并行加载的文件的最大数量
      // maxInitialRequests: 30, // 入口js文件最大并行请求数量
      // enforceSizeThreshold: 50000, // 超过50kb一定会单独打包(此时会忽略minRemainingSize、maxAsyncRequests、maxInitialRequests)
      // cacheGroups:  // 组,哪些模块要打包到一个组
      //   defaultVendors:  // 组名
      //     test: /[\\\\/]node_modules[\\\\/]/, // 需要打包到一起的模块
      //     priority: -10, // 权重(越大越高)
      //     reuseExistingChunk: true, // 如果当前 chunk 包含已从主 bundle 中拆分出的模块,则它将被重用,而不是生成新的模块
      //   ,
      //   default:  // 其他没有写的配置会使用上面的默认值
      //     minChunks: 2, // 这里的minChunks权重更大
      //     priority: -20,
      //     reuseExistingChunk: true,
      //   ,
      // ,
      // 修改配置
      cacheGroups: 
        // 组,哪些模块要打包到一个组
        // defaultVendors:  // 组名
        //   test: /[\\\\/]node_modules[\\\\/]/, // 需要打包到一起的模块
        //   priority: -10, // 权重(越大越高)
        //   reuseExistingChunk: true, // 如果当前 chunk 包含已从主 bundle 中拆分出的模块,则它将被重用,而不是生成新的模块
        // ,
        default: 
          // 其他没有写的配置会使用上面的默认值
          minSize: 0, // 我们定义的文件体积太小了,所以要改打包的最小文件体积
          minChunks: 2,
          priority: -20,
          reuseExistingChunk: true,
        ,
      ,
    ,
  ,
;

3、运行webpack

npx webpack

此时我们会发现生成 3 个 js 文件,其中有一个就是提取的公共模块

其他代码分割配置:webpack-codeSplit文档


按需加载,动态导入

按需加载就是:浏览器初始化时不加载,当我需要执行该逻辑时,才加载这段代码或者资源。

想要实现按需加载,动态导入模块。还需要额外配置:

1、修改文件

app.js

console.log("hello app");

main.js

console.log("hello main");

document.getElementById("btn").onclick = function () 
  // 动态导入 --> 实现按需加载
  // 即使只被引用了一次,也会代码分割
  import("./math.js").then(( sum ) => 
    alert(sum(1, 2, 3, 4, 5));
  );
;

public/index.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>代码分割 Code Split</title>
  </head>
  <body>
    <h1>hello webpack</h1>
    <button id="btn">点击按钮</button>
  </body>
</html>

2、运行webpack

npx webpack

我们可以发现,一旦通过 import 动态导入语法导入模块,模块就被代码分割,同时也能按需加载了.

具体可以在浏览器的network观察效果。


单入口

开发时我们可能是单页面应用(SPA),只有一个入口(单入口)。那么我们需要这样配置:

const path = require("path");
const HtmlWebpackPlugin = require("html-webpack-plugin");

module.exports = 
  // 单入口
  entry: "./src/main.js",
  // 多入口
  // entry: 
  //   main: "./src/main.js",
  //   app: "./src/app.js",
  // ,
  output: 
    path: path.resolve(__dirname, "./dist"),
    // [name]是webpack命名规则,使用chunk的name作为输出的文件名。
    // 什么是chunk?打包的资源就是chunk,输出出去叫bundle。
    // chunk的name是啥呢? 比如: entry中xxx: "./src/xxx.js", name就是xxx。注意是前面的xxx,和文件名无关。
    // 为什么需要这样命名呢?如果还是之前写法main.js,那么打包生成两个js文件都会叫做main.js会发生覆盖。(实际上会直接报错的)
    filename: "js/[name].js",
    clean: true,
  ,
  plugins: [
    new HtmlWebpackPlugin(
      template: "./public/index.html",
    ),
  ],
  mode: "production",
  optimization: 
    // 代码分割配置
    splitChunks: 
      chunks: "all", // 对所有模块都进行分割
      // 以下是默认值
      // minSize: 20000, // 分割代码最小的大小
      // minRemainingSize: 0, // 类似于minSize,最后确保提取的文件大小不能为0
      // minChunks: 1, // 至少被引用的次数,满足条件才会代码分割
      // maxAsyncRequests: 30, // 按需加载时并行加载的文件的最大数量
      // maxInitialRequests: 30, // 入口js文件最大并行请求数量
      // enforceSizeThreshold: 50000, // 超过50kb一定会单独打包(此时会忽略minRemainingSize、maxAsyncRequests、maxInitialRequests)
      // cacheGroups:  // 组,哪些模块要打包到一个组
      //   defaultVendors:  // 组名
      //     test: /[\\\\/]node_modules[\\\\/]/, // 需要打包到一起的模块
      //     priority: -10, // 权重(越大越高)
      //     reuseExistingChunk: true, // 如果当前 chunk 包含已从主 bundle 中拆分出的模块,则它将被重用,而不是生成新的模块
      //   ,
      //   default:  // 其他没有写的配置会使用上面的默认值
      //     minChunks: 2, // 这里的minChunks权重更大
      //     priority: -20,
      //     reuseExistingChunk: true,
      //   ,
      // ,
  ,
;


更新我们原来项目的生产环境配置

文件名:webpack.prod.js

最终我们会使用单入口+代码分割+动态导入方式来进行配置。更新之前的配置文件

// webpack.prod.js
const os = require("os");
const path = require("path");
const ESLintWebpackPlugin = require("eslint-webpack-plugin");
const HtmlWebpackPlugin = require("html-webpack-plugin");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
const CssMinimizerPlugin = require("css-minimizer-webpack-plugin");
const TerserPlugin = require("terser-webpack-plugin");
const ImageMinimizerPlugin = require("image-minimizer-webpack-plugin");

// cpu核数
const threads = os.cpus().length;

// 获取处理样式的Loaders
const getStyleLoaders = (preProcessor) => 
  return [
    MiniCssExtractPlugin.loader,
    "css-loader",
    
      loader: "postcss-loader",
      options: 
        postcssOptions: 
          plugins: [
            "postcss-preset-env", // 能解决大多数样式兼容性问题
          ],
        ,
      ,
    ,
    preProcessor,
  ].filter(Boolean);
;

module.exports = 
  entry: "./src/main.js",
  output: 
    path: path.resolve(__dirname, "../dist"), // 生产模式需要输出
    filename: "static/js/main.js", // 将 js 文件输出到 static/js 目录中
    clean: true,
  ,
  module: 
    rules: [
      
        oneOf: [
          
            // 用来匹配 .css 结尾的文件
            test: /\\.css$/,
            // use 数组里面 Loader 执行顺序是从右到左
            use: getStyleLoaders(),
          ,
          
            test: /\\.less$/,
            use: getStyleLoaders("less-loader"),
          ,
          
            test: /\\.s[ac]ss$/,
            use: getStyleLoaders("sass-loader"),
          ,
          
            test: /\\.styl$/,
            use: getStyleLoaders("stylus-loader"),
          ,
          
            test: /\\.(png|jpe?g|gif|svg)$/,
            type: "asset",
            parser: 
              dataUrlCondition: 
                maxSize: 10 * 1024, // 小于10kb的图片会被base64处理
              ,
            ,
            generator: 
              // 将图片文件输出到 static/imgs 目录中
              // 将图片文件命名 [hash:8][ext][query]
              // [hash:8]: hash值取8位
              // [ext]: 使用之前的文件扩展名
              // [query]: 添加之前的query参数
              filename: "static/imgs/[hash:8][ext][query]",
            ,
          ,
          
            test: /\\.(ttf|woff2?)$/,
            type: "asset/resource",
            generator: 
              filename: "static/media/[hash:8][ext][query]",
            ,
          ,
          
            test: /\\.js$/,
            // exclude: /node_modules/, // 排除node_modules代码不编译
            include: path.resolve(__dirname, "../src"), // 也可以用包含
            use: [
              
                loader: "thread-loader", // 开启多进程
                options: 
                  workers: threads, // 数量
                ,
              ,
              
                loader: "babel-loader",
                options: 
                  cacheDirectory: true, // 开启babel编译缓存
                  cacheCompression: false, // 缓存文件不要压缩
                  plugins: ["@babel/plugin-transform-runtime"], // 减少代码体积
                ,
              ,
            ],
          ,
        ],
      ,
    ],
  ,
  plugins: [
    new ESLintWebpackPlugin(
      // 指定检查文件的根目录
      context: path.resolve(__dirname, "../src"),
      exclude: "node_modules", // 默认值
      cache: true, // 开启缓存
      // 缓存目录
      cacheLocation: path.resolve(
        __dirname,
        "../node_modules/.cache/.eslintcache"
      ),
      threads, // 开启多进程
    ),
    new HtmlWebpackPlugin(
      // 以 public/index.html 为模板创建文件
      // 新的html文件有两个特点:1. 内容和源文件一致 2. 自动引入打包生成的js等资源
      template: path.resolve(__dirname, "../public/index.html"),
    ),
    // 提取css成单独文件
    new MiniCssExtractPlugin(
      // 定义输出文件名和目录
      filename: "static/css/main.css",
    ),
    // css压缩
    // new CssMinimizerPlugin(),
  ],
  optimization: 
    minimizer: [
      // css压缩也可以写到optimization.minimizer里面,效果一样的
      new CssMinimizerPlugin(),
      // 当生产模式会默认开启TerserPlugin,但是我们需要进行其他配置,就要重新写了
      new TerserPlugin(
        parallel: threads, // 开启多进程
      ),
      // 压缩图片
      new ImageMinimizerPlugin(
        minimizer: 
          implementation: ImageMinimizerPlugin.imageminGenerate,
          options: 
            plugins: [
              ["gifsicle",  interlaced: true ],
              ["jpegtran",  progressive: true ],
              ["optipng",  optimizationLevel: 5 ],
              [
                "svgo",
                
                  plugins: [
                    "preset-default",
                    "prefixIds",
                    
                      name: "sortAttrs",
                      params: 
                        xmlnsOrder: "alphabetical",
                      ,
                    ,
                  ],
                ,
              ],
            ],
          ,
        ,
      ),
    ],
    // 代码分割配置
    splitChunks: 
      chunks: "all", // 对所有模块都进行分割
      // 其他内容用默认配置即可
    ,
  ,
  // devServer: 
  //   host: "localhost", // 启动服务器域名
  //   port: "3000", // 启动服务器端口号
  //   open: true, // 是否自动打开浏览器
  // ,
  mode: "production",
  devtool: "source-map",
;


给动态导入文件命名

1、修改文件

main.js

import sum from "./js/sum";
// 引入资源,Webpack才会对其打包
import "./css/iconfont.css";
import "./css/index.css";
import "./less/index.less";
import "./sass/index.sass";
import "./sass/index.scss";
import "./styl/index.styl";

const result2 = sum以上是关于webpack5高级优化——代码运行性能的主要内容,如果未能解决你的问题,请参考以下文章

webpack5高级优化——减少代码体积

webpack5高级优化——提升打包速度

webpack5高级优化——提升开发体验

趁webpack5还没出,我们优化一下性能,先升个webpack4吧

webpack构建优化

webpack构建优化