一篇带给你 webpack 优秀实践

开发 前端
本文讲述的最佳实践是从日常业务中总结而出的,不一定适合所有项目。毕竟每个公司或个人的项目不同,最佳实践也会有所不同。但是可以从这篇文章借鉴吸收一点有用的东西。

[[410033]]

前言

本文讲述的最佳实践是从日常业务中总结而出的,不一定适合所有项目。毕竟每个公司或个人的项目不同,最佳实践也会有所不同。但是可以从这篇文章借鉴吸收一点有用的东西。

为了避免出现 我这明明可以,你那怎么不行 的尴尬情况,这里列一下文章涉及到依赖的版本号。

  1. ├── webpack           5.39.1 
  2. ├── webpack-cli       4.7.2 
  3. ├── node              12.8.0 
  4. ├── npm               6.10.2 

正文

初始化项目

  1. 1. mkdir test-app && cd test-app 
  2. 2. npm init 

首先添加一个入口文件 /src/index.js 和 webpack 配置文件 webpack.config.js,现在我们的目录结构如下

  1. test-app 
  2.     ├── src 
  3.     |    └── index.js 
  4.     ├── package.json 
  5.     ├── webpack.config.js 

安装 webpack

  1. npm install webpack webpack-cli -D 

开始搞事情

在 src/index.js 中随便写点东西

  1. class Test { 
  2.   constructor() { 
  3.     document.writeTest('hello world'
  4.   } 
  5.  
  6. new Test() 

先来打个包看看啥效果, 执行命令 npx webpack

[[410034]]

等待一段时间后,看到目录有了变化, 新增了一个 dist 目录,该目录下有一个 main.js 文件

  1. test-app 
  2.   + ├── dist 
  3.   + |    └── main.js 
  4.     ├── src 
  5.     |    └── index.js 
  6.     ├── package.json 
  7.     ├── webpack.config.js 

让我们来看看 main.js 里有点啥

  1. new class{constructor(){document.writeTest("hello world")}}; 

这玩意都不用试,肯定不得行啊,得将 js 代码转成 es5 才行。首先安装下babel-loader及几个相关的依赖

配置 babelbabel-loader

  • @babel/core
  • @babel/preset-env
  • @babel/plugin-transform-runtime
  • @babel/plugin-proposal-decorators
  • @babel/plugin-proposal-class-properties
  • @babel/plugin-proposal-private-methods
  • @babel/runtime
  • @babel/runtime-corejs3
  1. npm install babel-loader @babel/core @babel/preset-env @babel/plugin-transform-runtime  @babel/plugin-proposal-decorators  @babel/plugin-proposal-class-properties @babel/plugin-proposal-private-methods -D 
  2. npm install @babel/runtime @babel/runtime-corejs3 -s 

修改 webpack.config.js 文件, 添加 babel-loader 配置

  1. const path = require('path'); 
  2.  
  3. module.exports = { 
  4.   entry: './src/index.js'
  5.   output: { 
  6.     path: path.resolve(__dirname, 'dist'), 
  7.     filename: 'bundle.[contenthash:8].js'
  8.   }, 
  9.   module: { 
  10.     rules: [ 
  11.       { 
  12.         test: /\.(jsx|js)$/, 
  13.         use: 'babel-loader'
  14.         exclude: /node_modules/, 
  15.       }, 
  16.     ] 
  17.   } 

根目录下添加相应的 .babelrc 配置文件

  1.     "presets": ["@babel/preset-env"], 
  2.     "plugins": [ 
  3.         ["@babel/plugin-transform-runtime", {"corejs": 3}], 
  4.         ["@babel/plugin-proposal-decorators", { "legacy"true }], 
  5.         ["@babel/plugin-proposal-class-properties", { "loose"true }], 
  6.         ["@babel/plugin-proposal-private-methods", { "loose"true }] 
  7.     ] 

再次执行命令 npx webpack 来打个包。完成后查看目录结构

  1. test-app 
  2.     ├── dist 
  3.   + |    ├── bundle.b8ba1739.js 
  4.     |    ├── main.js 
  5.     ├── src 
  6.     |    └── index.js 
  7.   + ├── .babelrc 
  8.     ├── package.json 
  9.     ├── webpack.config.js 

查看构建后的 bundle.b8ba1739.js 文件

  1. (()=>{"use strict";new function n(){!function(n,t){if(!(n instanceof t))throw new TypeError("Cannot call a class as a function")}(this,n),document.writeTest("hello world")}})(); 

构建产物看着没什么问题了,接下来看下在浏览器中的实际效果。要看效果,肯定离不开 html 文件。

浏览器中观看效果

作为一个伸手党直接从社区嫖来一个插件 html-webpack-plugin,这个插件的作用是将打包产物引入到我们提前准备好的模板 .html 文件中,我们访问这个文件就能直观的看到效果了

先来安装下插件

  1. npm install html-webpack-plugin -D 

接着创建一个 public 目录, 用来存放静态资源。新增一个 index.html 模板,放在 public 目录下

  1. test-app 
  2.     ├── dist 
  3.     |    ├── bundle.b8ba1739.js 
  4.     |    ├── main.js 
  5.     ├── src 
  6.     |    └── index.js 
  7.   + ├── public 
  8.   + |    └── index.html 
  9.     ├── .babelrc 
  10.     ├── package.json 
  11.     ├── webpack.config.js 

在 webpack.config.js 中配置 html-webpack-plugin

  1. // 省略 ... 
  2. const HtmlWebpackPlugin = require('html-webpack-plugin'); 
  3.  
  4. module.exports = { 
  5.   // 省略 ... 
  6.   plugins: [ 
  7.     new HtmlWebpackPlugin({ 
  8.       template: path.resolve(__dirname, './public/index.html'), 
  9.       inject: 'body'
  10.       scriptLoading: 'blocking'
  11.     }), 
  12.   ] 

再次执行命令 npx webpack 来打个包。打完包发现 dist 目录下多了一个 index.html 文件。浏览器中打开 index.html 看看对不对

作为一个 api 工程师,连 api 都能记错。

修改下 src/index.js 代码

  1. class Test { 
  2.   constructor() { 
  3.     document.write('hello world'
  4.   } 
  5.  
  6. new Test() 

再次执行命令 npx webpack 来打个包。老步骤,先检查下打包产物对不对

  1. test-app 
  2.     ├── dist 
  3.     |    ├── bundle.b8ba1739.js 
  4.  +  |    ├── bundle.dc044571.js 
  5.     |    ├── index.html 
  6.     |    ├── main.js 
  7.     ├── src 
  8.     |    └── index.js 
  9.     ├── public 
  10.     |    └── index.html 
  11.     ├── .babelrc 
  12.     ├── package.json 
  13.     ├── webpack.config.js 

看样子应该没错,代码修改了,打包后多了个 .js 文件。再看看效果对不对

界面上也出现了 hello world。到这里为止,算是利用 webpack 走通了一个最小流程。

为什么说是最小,因为到目前为止这个配置在实际工作中 基本没卵用 实用性不大。细心一点的人已经看出来了,上面存在三个问题

  1. 每修改一次代码,都要走一遍打包流程,然后自己手动打开 html 文件,预览效果
  2. 第一次调用错误 api 的时候,报错信息定位不精确
  3. 打包目录下面 上次构建产物 也仍旧存在,时间长了会存在越来越多的无用代码

作为一个懒人,第三点可以忍,第一点和第二点忍不了。我们一个个来解决

实时更新并预览效果针对第一点,查阅 webpack 官网,发现官网就给指了一条明路

按照官网教程,首先安装下 webpack-dev-server

  1. npm install webpack-dev-server -D 

再在 webpack.config.js 中添加相应的配置

  1. // 省略 ... 
  2. module.exports = { 
  3.   // 省略 ... 
  4.   devServer: { 
  5.     port: '3001', // 默认是 8080 
  6.     hot: true
  7.     stats: 'errors-only', // 终端仅打印 error 
  8.     compress: true, // 是否启用 gzip 压缩 
  9.     proxy: { 
  10.       '/api': { 
  11.         target: 'http://0.0.0.0:80'
  12.         pathRewrite: { 
  13.           '/api'''
  14.         }, 
  15.       }, 
  16.     }, 
  17.   }, 

在 package.json > script 中添加一个命令

  1. "dev""webpack serve  --open"

执行 npm run dev,这个时候在动在浏览器中打开了 http://localhost:3001/ 页面。光自动打开还不够啊,我们的目标是每次修改后不用构建就能在浏览器中实时查看。为了测试这个功能是否生效,我们任意修改 src/index.js 文件并保存。发现浏览器中内容自动刷新生效了。

想了解更多关于 devServer 的可以阅读以下两篇文章

  • 【Webpack】devServer 实验报告
  • 120 行代码帮你了解 Webpack 下的 HMR 机制

sourcemap 配置

第一个问题好了,再来看看第二个问题 报错信息定位不精确。我们仍旧在官网找找看,有没有对应的解决方案。通过 1 小时的文档阅读和 7 小时的摸鱼,终于在一天后找到了解决方法。

我们在 webpack.config.js 中添加配置

  1. // 省略 ... 
  2. module.exports = { 
  3.   // 省略 ... 
  4.   devtool: 'eval-cheap-module-source-map'

这个配置什么意思呢,它会告诉我们错误是在原始代码的哪一行发生的。废话不多说,先来看看效果

 点进去看看是什么情况

这么精准的定位,一天可以改100个 bug 了。

但是!!!这玩意好归好,生产环境可不能乱用。这里建议

开发环境 最佳:eval-cheap-module-source-map生产环境 最佳:hidden-source-map

什么?你上下嘴皮子吧嗒一合,说最佳就最佳?没有拿得出手的理由我们是不会信的

造谣是不可能造谣的,这辈子都不会。我也是吸收了这篇文章 万字长文:关于 sourcemap,这篇文章就够了 的精华才总结出来的。

一万字的文章总结成两句话,10 秒钟吸收

世事总是这么奇妙,按照上面的思路,在解决第二个问题的时候又带出了一个新的问题,某些配置可能需要区分环境来设置,不同的环境设置合适的配置。就像在解决一个bug A的过程中,发现了一个新的 bug B。看来在解决上面第三个问题之前,得先解决这个 区分环境配置 的问题了。

拆分环境

按照一般惯例,我们会有 开发、测试、预发、生产几个环境。但是我个人很多情况下 开发 和 测试 环境是同一套配置,所以我这里直接省略 测试 这个环境。

修改下目录结构

  1. test-app 
  2.   + ├── build 
  3.   + |    ├── webpack.base.js 
  4.   + |    ├── webpack.dev.js 
  5.   + |    ├── webpack.pre.js 
  6.   + |    ├── webpack.pro.js 
  7.     ├── dist 
  8.     ├──  ├── bundle.b8ba1739.js 
  9.     ├──  ├── bundle.dc044571.js 
  10.     |    ├── index.html 
  11.     |    ├── main.js 
  12.     ├── src 
  13.     |    └── index.js 
  14.     ├── public 
  15.     |    └── index.html 
  16.     ├── .babelrc 
  17.     ├── package.json 

从目录中就可以看出一点东西,我们删除了原先根目录下的 webpack.config.js 文件。新增了一个 build 目录。在 build 目录下我们需要建一个 webpack.base.js 文件。用来存放各个环境公共的配置,毕竟不可能所有配置在各个环境中都不一样。然后按照我们各自项目实际的需求来建立不同环境的配置文件。

先修改公共配置文件 webpack.base.js。原先的 devServe 配置由于只有开发环境有;devtool 各个环境不一样,所以这两个配置从公共配置里移除了

  1. const path = require('path'); 
  2. const HtmlWebpackPlugin = require('html-webpack-plugin'); 
  3.  
  4. const rootDir = process.cwd(); 
  5.  
  6. module.exports = { 
  7.   entry: path.resolve(rootDir, 'src/index.js'), 
  8.   output: { 
  9.     path: path.resolve(rootDir, 'dist'), 
  10.     filename: 'bundle.[contenthash:8].js'
  11.   }, 
  12.   module: { 
  13.     rules: [ 
  14.       { 
  15.         test: /\.(jsx|js)$/, 
  16.         use: 'babel-loader'
  17.         include: path.resolve(rootDir, 'src'), 
  18.         exclude: /node_modules/, 
  19.       }, 
  20.     ] 
  21.   }, 
  22.   plugins: [ 
  23.     new HtmlWebpackPlugin({ 
  24.       template: path.resolve(rootDir, 'public/index.html'), 
  25.       inject: 'body'
  26.       scriptLoading: 'blocking'
  27.     }), 
  28.   ], 

接下来配置各个环境的配置,这里主要用到一个 webpack-merge 插件,用来合并公共配置,执行 npm install webpack-merge -D

修改 webpack.dev.js

  1. const { merge } = require('webpack-merge'); 
  2. const baseConfig = require('./webpack.base'); 
  3.  
  4. module.exports = merge(baseConfig, { 
  5.   mode: 'development'
  6.   devtool: 'eval-cheap-module-source-map'
  7.   devServer: { 
  8.     port: '3001', // 默认是 8080 
  9.     hot: true
  10.     stats: 'errors-only', // 终端仅打印 error 
  11.     compress: true, // 是否启用 gzip 压缩 
  12.     proxy: { 
  13.       '/api': { 
  14.         target: 'http://0.0.0.0:80'
  15.         pathRewrite: { 
  16.           '/api'''
  17.         }, 
  18.       }, 
  19.     }, 
  20.   }, 
  21. }); 

因为这里不涉及到实际的项目开发,所以这里预发和生产两个环境的文件先配置成一样的,大家可以根据自己的实际需要来进行不同的配置。

  • webpack.pre.js
  • webpack.pro.js
  1. const { merge } = require('webpack-merge'); 
  2. const baseConfig = require('./webpack.base'); 
  3.  
  4. module.exports = merge(baseConfig, { 
  5.   mode: 'production'
  6.   devtool: 'hidden-source-map'
  7. }); 

看到仔细的人已经发现,配置中多了一个 mode 属性,这个会在后面解释一波,这里先不讲

修改 package.json 中的命令

  1. "scripts": { 
  2.   "dev""webpack serve --config build/webpack.dev.js --open"
  3.   "build:pro""npx webpack --config build/webpack.pro.js"
  4. }, 

再次执行 npm run dev 看看效果

看来是没问题了,现在已经成功把 webpack.config.js 文件根据环境进行拆分成了多个文件。

现在来回顾下之前提出的第三个问题

这个项目小的时候其实问题不大,但是当项目大了之后,每次打包都增加几百上千的文件,还是有点恐怖的。所以还是把这个问题也顺带解决下好了。

打包时清除上次构建产物

我们的目标是每次打包时删除上次打包的产物,保证打包目录下所有文件都是新的,社区查找一番后,找到一个插件clean-webpack-plugin ,来看下这个插件的介绍

比较懒,所以直接上截图了。老步骤,先安装 npm install clean-webpack-plugin -D 然后直接将文档中的示例代码借鉴到我们的项目中。修改 webpack.base.js

  1. // 省略... 
  2. const { CleanWebpackPlugin } = require('clean-webpack-plugin'); 
  3.  
  4. module.exports = { 
  5.   // 省略... 
  6.   plugins: [ 
  7.     new HtmlWebpackPlugin({ 
  8.       template: path.resolve(rootDir, 'public/index.html'), 
  9.       inject: 'body'
  10.       scriptLoading: 'blocking'
  11.     }), 
  12.     new CleanWebpackPlugin(), 
  13.   ], 

试下效果,执行 npm run build:pro 打个包。查看目录

  1. test-app 
  2.     ├── build 
  3.     |    ├── webpack.base.js 
  4.     |    ├── webpack.dev.js 
  5.     |    ├── webpack.pre.js 
  6.     |    ├── webpack.pro.js 
  7.     ├── dist 
  8.     |    ├── bundle.fd44c2eb.js 
  9.     |    ├── bundle.fd44c2eb.js.map 
  10.     |    ├── index.html 
  11.     ├── src 
  12.     |    └── index.js 
  13.     ├── public 
  14.     |    └── index.html 
  15.     ├── .babelrc 
  16.     ├── package.json 

dist 目录下原先存在的 main.js、bundle.b8ba1739.js 等前几次打包产物已经自动清除了。到这里第三个问题也解决了

功能完善

添加 css 和 less 支持

为什么不添加 sass 支持?因为我不用 sass

首先,在 src 目录下添加一个 index.less 文件

  1. .test { 
  2.   color: red; 

修改 src/index.js 文件,在文件中引用刚才添加的 less 文件

  1. import './index.less' 
  2.  
  3. class Test { 
  4.   constructor() { 
  5.     this.renderDiv() 
  6.   } 
  7.  
  8.   renderDiv() { 
  9.     const div = document.createElement('div'
  10.     div.className = 'test' 
  11.     div.innerHTML = 'hello world' 
  12.     document.body.appendChild(div) 
  13.   } 
  14.  
  15. new Test() 

执行 npm run dev

等待 10 分钟后,页面迟迟没有加载任何东西,打开控制台一看

英语 8 级的我立马读懂了报错:"你 可能 需要 一个 什么什么 loader 来 处理 这个 文件 类型, 目前 没有 loaders 被配置 来 process 这个 文件"

再结合官网的说明

 

到了这里,我好像隐约明白了 webpack 的真谛:虽然很多时候我不行,但是很多大佬会让我行。呸,什么叫不行?这叫 灵活可插拔,正是这种特性,让 webpack 可灵活支持各种复杂场景的自定义配置。

忘了正事儿,既然问题找到了,就好解决了,找到几个处理 css 和 less 的 loader 就行

首先安装 loader

  1. npm install less style-loader css-loader less-loader -D 

再修改 webpack.base.js 文件

  1. // 省略... 
  2.  
  3. module.exports = { 
  4.   // 省略... 
  5.   module: { 
  6.     rules: [ 
  7.       // 省略... 
  8.       { 
  9.         test: /\.(le|c)ss$/, 
  10.         exclude: /node_modules/, 
  11.         use: ['style-loader''css-loader''less-loader'
  12.       }, 
  13.     ] 
  14.   }, 
  15.   // 省略... 

再次执行 npm run dev,查看效果

css module

这一块是基于上面的模块修改的,解决 css 命名混乱和冲突的。不需要的话可以直接跳过这一块。

修改 webpack.base.js

  1. // 省略... 
  2.  
  3. module.exports = { 
  4.   // 省略... 
  5.   module: { 
  6.     rules: [ 
  7.       //  省略... 
  8.       { 
  9.         test: /\.(le|c)ss$/, 
  10.         exclude: /node_modules/, 
  11.         use: [ 
  12.           'style-loader'
  13.           { 
  14.             loader: 'css-loader'
  15.             options: { 
  16.               modules: { 
  17.                 compileType: 'module'
  18.                 localIdentName: "[local]__[hash:base64:5]"
  19.               }, 
  20.             }, 
  21.           }, 
  22.           'less-loader' 
  23.         ] 
  24.       }, 
  25.     ] 
  26.   }, 
  27.   // 省略... 

执行 npm run dev 来看看效果

给 class 样式名称后加上一个哈希串,具体的配置可以看 css-loader 官网

css 自动添加前缀

首先安装插件

  1. npm install autoprefixer postcss postcss-loader -D 

修改 webpack.base.js 配置文件

  1. // 省略... 
  2. const autoprefixer = require('autoprefixer'); 
  3.  
  4. module.exports = { 
  5.   // 省略... 
  6.   module: { 
  7.     rules: [ 
  8.       // 省略... 
  9.       { 
  10.         test: /\.(le|c)ss$/, 
  11.         exclude: /node_modules/, 
  12.         use: [ 
  13.           // 省略... 
  14.           'less-loader'
  15.           { 
  16.             loader: 'postcss-loader'
  17.             options: { 
  18.               postcssOptions: { 
  19.                 plugins: [ 
  20.                   ["autoprefixer"], 
  21.                 ], 
  22.               }, 
  23.             }, 
  24.           } 
  25.         ] 
  26.       }, 
  27.     ] 
  28.   }, 
  29.   // 省略... 

打包后抽离 css 文件

首先安装 mini-css-extract-plugin 插件

  1. npm install mini-css-extract-plugin -D 

修改 webpack.base.js 配置文件

  1. // 省略... 
  2. const MiniCssExtractPlugin = require('mini-css-extract-plugin'); 
  3.  
  4. module.exports = { 
  5.   // 省略... 
  6.   module: { 
  7.     rules: [ 
  8.       // 省略... 
  9.       { 
  10.         test: /\.(le|c)ss$/, 
  11.         exclude: /node_modules/, 
  12.         use: [ 
  13.           MiniCssExtractPlugin.loader, 
  14.           // 省略... 
  15.         ] 
  16.       }, 
  17.     ] 
  18.   }, 
  19.   plugins: [ 
  20.     // 省略... 
  21.     new MiniCssExtractPlugin({ 
  22.       filename: 'css/[name].css'
  23.     }), 
  24.   ], 

执行 npm run build:pro 打个包看看效果。

可以看到 css 已经被抽离出来了

压缩打包后的 css 文件

首先安装 optimize-css-assets-webpack-plugin 插件

  1. npm install optimize-css-assets-webpack-plugin -D 

修改 webpack.base.js 配置文件

  1. // 省略... 
  2. const OptimizeCssPlugin = require('optimize-css-assets-webpack-plugin'); 
  3.  
  4. module.exports = { 
  5.   // 省略... 
  6.   plugins: [ 
  7.     // 省略... 
  8.     new MiniCssExtractPlugin({ 
  9.       filename: 'css/[name].css'
  10.     }), 
  11.     new OptimizeCssPlugin(), 
  12.   ], 

执行 npm run build:pro 打个包看看效果。

  1. .test__1PSRs{color:red;transition-duration:.4s} 

可以看出 css 已经被压缩了

复制静态资源到打包目录

有些时候有些第三方的 js 插件没有提供 npm 包,只提供了一个 cdn 地址或者一份文件需要自己下载下来。通常我们下载下来之后放在我们的 public/js 目录下面,然后 public/index.html 文件里直接用 script 标签引入。这个时候不管是 npm run dev 开发时,还是 npm run build:pro 构建后,这个 js 文件都是找不到的。我们可以尝试下

在 public/js 新加一个 test.js 的空文件,啥内容都不用。然后在 public/index.html 中引入这个文件

  1. <!DOCTYPE html> 
  2. <html lang="en"
  3.   <head> 
  4.     // 省略 
  5.   </head> 
  6.  
  7.   <body> 
  8.     <div id="root"></div> 
  9.     <script src="./js/test.js"></script> 
  10.   </body> 
  11. </html> 

执行 npm run dev 查看效果

这里我们可以用 copy-webpack-plugin 这个插件,在构建的时候,将 public/js 的静态资源复制到 dist 目录下,这样文件就能找到了

安装插件 npm install copy-webpack-plugin -D

修改 webpack.base.js 配置文件

  1. // 省略... 
  2. const CopyWebpackPlugin = require('copy-webpack-plugin'); 
  3.  
  4. const rootDir = process.cwd(); 
  5.  
  6. module.exports = { 
  7.   // 省略... 
  8.   plugins: [ 
  9.     new HtmlWebpackPlugin({ 
  10.       template: path.resolve(rootDir, 'public/index.html'), 
  11.       inject: 'body'
  12.       scriptLoading: 'blocking'
  13.     }), 
  14.     new CleanWebpackPlugin(), 
  15.     new CopyWebpackPlugin({ 
  16.       patterns: [ 
  17.         { 
  18.           from'*.js'
  19.           context: path.resolve(rootDir, "public/js"), 
  20.           to: path.resolve(rootDir, 'dist/js'), 
  21.         }, 
  22.       ], 
  23.     }) 
  24.     new MiniCssExtractPlugin({ 
  25.       filename: 'css/[name].css'
  26.     }), 
  27.     new OptimizeCssPlugin(), 
  28.   ], 

执行 npm run dev 查看效果

静态文件已经可以正常加载了。

资源加载器

项目中难免要引入一些图标、图片等资源,在不做任何处理的情况下,我们尝试下在代码中引用图片,修改 src/index.js 文件如下

  1. import wuhanjiayou from '../public/asset/a.jpeg' 
  2.  
  3. class Test { 
  4.   constructor() { 
  5.     this.renderImg() 
  6.   } 
  7.  
  8.   renderImg() { 
  9.     const img = document.createElement('img'
  10.     img.src = wuhanjiayou 
  11.     document.body.appendChild(img) 
  12.   } 
  13.  
  14. new Test() 

执行 npm run dev 看下效果,报了个熟悉的错

按照以往的套路,直接引用社区的三件套 raw-loader、url-loader、file-loader,安装依赖,配置依赖,一通操作下来就解决了问题。现在我们使用 webpack5就方便多了,不用安装任何依赖,直接修改 webpack.base.js 配置文件

  1. // 省略... 
  2. rules: [ 
  3.     { 
  4.         test: /\.(png|jpg|gif|jpeg|webp|svg|eot|ttf|woff|woff2)$/, 
  5.         type: 'asset'
  6.     }, 

没错,就是这么简单。type 属性还有其他几个值,具体可以看 官方文档

配置已经修改好了,执行 npm run dev 再来看下效果

搞定!

上面讲到的东西基本够小项目的日常开发需求了,常用的 loader 和 plugin 都已经有所涉及。但是,如果你的项目特别复杂,需求又比较小众,社区没有现成的 loader 和 plugin 可以借鉴,那么只能自己动手实现一个了。

可能在一部分人眼中,loader 和 plugin 是比较神秘的,也不可能想着自己去造一个轮子。但是当碰到问题又没有现成的解决方案的时候,那就不得不自己造了。

看了这篇文章 Webpack - 手把手教你写一个 loader / plugin 应该能很快上手

项目优化

刚才也讲到了,上面的一通操作基本够小项目开发使用了。为什么是小项目?大项目不行吗?当一个项目大到路由都有几百个的时候,一次热更新就需要十几二十多秒,一次打包要半个小时。开发时,一次代码改动保存就要等 20 秒,这搁谁谁都忍不了啊。这个时候就需要想点办法来优化。

loader 配置优化

这个其实上面已经做了。明确告诉 loader,哪些文件不用做处理(exclude),或者只处理哪些文件(include)。

  1.     test: /\.(jsx|js)$/, 
  2.     use: 'babel-loader'
  3.     // include: [path.resolve(rootDir, 'src')] 
  4.     // exclude: /node_modules/, 
  5.   }, 

一般倾向于使用 include,但是如果怕漏处理一些文件的话,粗暴点,使用 exclude: /node_modules/ 也可以。

这部分测试了下,提升速度不是很明显,应该算锦上添花吧

缓存

先说下 webpack5 之前是怎么做的。

利用 cache-loader 将结果缓存中磁盘中;利用 hard-source-webpack-plugin 将结果缓存在 node_modules/.cache 下提升二次打包速度;利用 DllReferencePlugin 将变化不频繁的第三方库提前单独打包成动态链接库,提升真正业务代码的打包速度

webpack5 自带了持久化缓存,配置如下

开发环境 webpack.dev.js

  1. cache: { 
  2.     type: 'memory' 
  3. }, 

生产环境 webpack.pro.js

  1. cache: { 
  2.     type: 'filesystem'
  3.     buildDependencies: { 
  4.       config: [__filename] 
  5.     } 
  6. }, 

这个测试了下前后的打包时间

数据是这个数据:

  • 第一次: 12592 ms
  • 第二次: 920 ms但是我心里默数了下,二次打包大概在 3 秒左右,咱也不知道控制台的计时逻辑是什么

如果在构建时,你主动确定要放弃旧的缓存的话,可以传一个新的 version 参数来放弃使用缓存

  1. cache: { 
  2.     type: 'filesystem'
  3.     buildDependencies: { 
  4.       config: [__filename] 
  5.     }, 
  6.     version: 'new_version' 
  7. }, 

代码拆分

  1. optimization: { 
  2.     splitChunks: { 
  3.       chunks: 'all'
  4.     } 

这个在 mode: production 时是默认开启的,但是默认情况下只会对按需加载的代码进行分割。如果我们要对一开始就加载的代码也做分割处理,就要进行如上配置。

从官网截了一张图:

大家的项目可能都有所不同,相对应的最佳的配置可能也有所不同,所以这里就补贴具体的配置了,大家有需要的可以看官网的文档对自己的项目进行配置 官网 optimization.splitChunks 更多配置、「Webpack」从 0 到 1 学会 code splitting

mode

mode: production 在上面出现了这么多次,也没有具体说有哪些功能。其实当设置 mode: production 时,webpack 已经默认开启了一些优化措施。

这里面的一些东西由于篇幅较大也不做一一说明了,反正只要记得 mode: production 已经给我们做了一系列优化,真的想知道有哪些优化的,我找了篇文章,有兴趣的可以看看 mode 详解

happypack

利用 happypack 插件进行多线程打包,按照官网文档进行配置

  1. // 省略... 
  2. const Happypack = require('happypack'); 
  3. const os = require('os'
  4. const happyThreadPool = Happypack.ThreadPool({ size: os.cpus().length }) 
  5.  
  6. // 省略... 
  7. rules: [ 
  8.   { 
  9.     test: /\.(jsx|js)$/, 
  10.     // use: 'babel-loader'
  11.     use: 'Happypack/loader?id=js'
  12.     exclude: /node_modules/, 
  13.   }, 
  14.  
  15. plugins: [ 
  16.     new Happypack({ 
  17.       id: 'js', // 这个 id 值为上面 Happypack/loader?id=js 问号后跟的参数 
  18.       use: ['babel-loader'], 
  19.       threadPool: happyThreadPool 
  20.     }), 

由于本篇文章写的是个 demo,没有业务代码,所以这个打包出来的时间基本没变化甚至还多了 1 秒,这里就不贴效果图了。这是因为happypack执行也需要时间,如果项目比较小的话,就不需要配置了。js 处理完之后那就是要处理css了, 按照处理js的方式,ctrl+c/ctrl+v 处理css。

执行 npm run build:pro

  1. ERROR in ./src/index.less 
  2. Module build failed (from ./node_modules/Happypack/loader.js): 
  3. Error: You forgot to add 'mini-css-extract-plugin' plugin (i.e. `{ plugins: [new MiniCssExtractPlugin()] }`), please read https://github.com/webpack-contrib/mini-css-extract-plugin#getting-started 

报错说忘记添加了mini-css-extract-plugin插件,但是明明已经添加了,经过试验,发现是 mini-css-extract-plugin 这个插件引起 happypack 报错的。终于,在经过 百度、谷歌 等一系列骚操作后,我放弃了,没找到解决方法

现在摆在面前的就三条路:

  • 放弃使用 happypack
  • 使用 happypack 优化js和css,放弃使用 mini-css-extract-plugin
  • 使用 happypack 优化 js,放弃优化 css,保留 mini-css-extract-plugin

知道咋解决的或有更好的方式的可以在下方留言,让我白嫖 借鉴下。

thread-loader

如果采用上面第一种,放弃使用 happypack,可以用 thread-loader 代替下。而且这个配置非常简单。

先安装: npm install thread-loader -D,再修改配置

  1. // 省略... 
  2. rules: [ 
  3.   { 
  4.     test: /\.(jsx|js)$/, 
  5.     use: ['thread-loader''babel-loader'], 
  6.     exclude: /node_modules/, 
  7.   }, 
  8.   { 
  9.     test: /\.(le|c)ss$/, 
  10.     exclude: /node_modules/, 
  11.     use: [ 
  12.       MiniCssExtractPlugin.loader, 
  13.       'thread-loader'
  14.       { 
  15.         loader: 'css-loader'
  16.         options: { 
  17.           modules: { 
  18.             compileType: 'module'
  19.             localIdentName: "[local]__[hash:base64:5]"
  20.           }, 
  21.         }, 
  22.       }, 
  23.       'less-loader'
  24.       { 
  25.         loader: 'postcss-loader'
  26.         options: { 
  27.           postcssOptions: { 
  28.             plugins: [ 
  29.               ["autoprefixer"], 
  30.             ], 
  31.           }, 
  32.         }, 
  33.       } 
  34.     ], 
  35.   }, 

到这里应该可以应付一般的项目了。由于这篇文章主要讲述 webpack 的应用,所以很多知识点没有细讲,也没有精力细讲,但是很多涉及到的知识点都推荐了相应的文章,有兴趣的朋友可以看一下。

参考文献:

  • webpack5
  • webpack4 升级到 5

 

责任编辑:姜华 来源: 微医大前端技术
相关推荐

2022-09-20 07:33:15

Jenkinshttps://mp

2021-07-12 06:11:14

SkyWalking 仪表板UI篇

2021-10-28 08:51:53

GPIO软件框架 Linux

2023-03-13 09:31:04

2021-04-14 07:55:45

Swift 协议Protocol

2022-02-25 15:50:05

OpenHarmonToggle组件鸿蒙

2021-04-23 08:59:35

ClickHouse集群搭建数据库

2021-05-08 08:36:40

ObjectString前端

2023-03-29 07:45:58

VS编辑区编程工具

2021-01-28 08:55:48

Elasticsear数据库数据存储

2021-04-08 11:00:56

CountDownLaJava进阶开发

2021-04-14 14:16:58

HttpHttp协议网络协议

2021-03-12 09:21:31

MySQL数据库逻辑架构

2021-07-21 09:48:20

etcd-wal模块解析数据库

2021-06-21 14:36:46

Vite 前端工程化工具

2021-04-01 10:51:55

MySQL锁机制数据库

2022-04-29 14:38:49

class文件结构分析

2022-03-22 09:09:17

HookReact前端

2024-06-13 08:34:48

2022-02-17 08:53:38

ElasticSea集群部署
点赞
收藏

51CTO技术栈公众号