提升开发体验
SourceMap
问题:
开发时我们运行的代码是经过 webpack 编译后的,例如下面这个样子
npm run start
很多代码都是通过从eval函数暴露,要是代码有bug,不方便定位出错点。
比如:
这个例子不太合适,但只是一个例子而已。
解决方法
SourceMap(源代码映射)是一个用来生成源代码与构建后代码一一映射的文件的方案。
它会生成一个 xxx.map 文件,里面包含源代码和构建后代码每一行、每一列的映射关系。当构建后代码出错了,会通过 xxx.map 文件,从构建后代码出错位置找到映射后源代码出错位置,从而让浏览器提示源代码文件出错位置,帮助我们更快的找到错误根源。
官方文档 SourceMap 的值有很多种情况。
但实际开发时我们只需要关注两种情况即可:
- 开发模式:cheap-module-source-map
- 优点:打包编译速度快,只包含行映射
- 缺点:没有列映射
module.exports = {
// 其他省略
mode: "development",
devtool: "cheap-module-source-map",
};
- 生产模式:source-map
- 优点:包含行/列映射
- 缺点:打包编译速度更慢
module.exports = {
// 其他省略
mode: "production",
devtool: "source-map",
};
添加后重启服务器:
会精确提示出错地位置
提升打包构建速度
HotModuleReplacement
问题: 开发时我们修改了其中一个模块代码,Webpack 默认会将所有模块全部重新打包编译,速度很慢。所以我们需要做到修改某个模块代码,就只有这个模块代码需要重新打包编译,其他模块不变,这样打包速度就能很快。
解决方式:HotModuleReplacement(HMR/热模块替换):在程序运行中,替换、添加或删除模块,而无需重新加载整个页面。
使用
默认开启(js默认不支持)
module.exports = {
// 其他省略
devServer: {
host: "localhost", // 启动服务器域名
port: "3000", // 启动服务器端口号
open: true, // 是否自动打开浏览器
hot: true, // 开启HMR功能(只能用于开发环境,生产环境不需要了)默认配置
},
};
js配置
// main.js
import count from "./js/count";
import sum from "./js/sum";
const result1 = count(2, 1);
console.log(result1);
const result2 = sum(1, 2, 3, 4);
console.log(result2);
// 判断是否支持HMR功能
if (module.hot) {
module.hot.accept("./js/count.js", function (count) {
const result1 = count(2, 1);
console.log(result1);
});
module.hot.accept("./js/sum.js", function (sum) {
const result2 = sum(1, 2, 3, 4);
console.log(result2);
});
}
上面这样写会很麻烦,所以实际开发我们会使用其他 loader 来解决。
比如:vue-loader 和 react-loader
OneOf
问题:
打包时每个文件都会经过所有 loader 处理,虽然因为 test 正则原因实际没有处理上,但是都要过一遍,比较慢。
解决方法:
顾名思义就是只能匹配上一个 loader, 剩下的就不匹配了。
const path = require("path");
const ESLintPlugin = require("eslint-webpack-plugin");
const HtmlWebpackPlugin = require("html-webpack-plugin");
module.exports = {
// 入口,相对路径和绝对路径都可以
entry: "./src/main.js",
// 输出
output: {
// 开发模式没输出
path: undefined,
// 入口文件打包输出文件名
filename: "static/js/main.js",
// 自动清空上次打包的内容
// 原理:在打包前,将path(上面那个)整个目录内容删除,然后再进行打包
clean: true,
},
// 记载器
module: {
rules: [
// loader的配置
{
// 每个文件只能被其中一个loader配置处理
oneOf: [
{
test: /\.css/, // 只检测.css文件
use: [
// 执行顺序:从右到左
"style-loader", // 将js中的css通过创建style标签添加到html文件中生效
"css-loader", // 将css资源编译成commonjs模块到js中
],
},
{
test: /\.less$/,
use: [
"style-loader",
"css-loader",
"less-loader", // 将less编译成css文件
],
},
{
test: /\.(png|jpe?g|git|webp|svg)$/,
type: "asset",
parser: {
dataUrlCondition: {
// 这里配置小于20kb的图片就转为base64
// 优点:减少请求数量
// 缺点:体积会变大
maxSize: 20 * 1024,
},
},
generator: {
// 输出图片路径及名称
// [hash:10] hash值只取前10位
filename: "static/images/[hash:10][ext][query]",
},
},
{
// 处理字体、音频、视频等资源
test: /\.(tff|woff2?|map3|map4|avi)$/,
type: "asset/resource", // 不转换位base64
generator: {
filename: "static/media/[hash:10][ext][query]",
},
},
{
test: /\.js$/,
exclude: /node_modules/, // 不处理node_modules下的js文件
loader: "babel-loader",
// options: {
// presets: ["@babel/preset-env"],
// },
},
],
},
],
},
// 插件
plugins: [
new ESLintPlugin({
// 检测哪些文件
context: path.resolve(__dirname, "../src"),
}),
new HtmlWebpackPlugin({
// 模板:以public/index.html文件创建新的html文件
// 新的html文件特点:1、结构和原来一致 2、自动引入打包输出的资源
template: path.resolve(__dirname, "../public/index.html"),
}),
],
// 开发服务器
devServer: {
host: "localhost", // 启动服务器域名
port: "3000", // 启动服务器端口号
open: true, // 是否自动打开浏览器
},
// 模式
mode: "development",
devtool: "cheap-module-source-map",
};
Include/Exclude
问题:
开发时我们需要使用第三方的库或插件,所有文件都下载到node_modules 中了。而这些文件是不需要编译可以直接使用的。所以我们在对 js 文件处理时,要排除 node_modules 下面的文件。
解决方法:
- include
包含,只处理 xxx 文件 - exclude
排除,除了 xxx 文件以外其他文件都处理
include和exclude只能使用一个
Cache
问题:
每次打包时 js 文件都要经过 Eslint 检查 和 Babel 编译,速度比较慢。我们可以缓存之前的 Eslint 检查 和 Babel 编译结果,这样第二次打包时速度就会更快了。
解决方法:
对 Eslint 检查 和 Babel 编译结果进行缓存。
Thread
问题:
当项目越来越庞大时,打包速度越来越慢,甚至于需要一个下午才能打包出来代码。这个速度是比较慢的。我们想要继续提升打包速度,其实就是要提升 js 的打包速度,因为其他文件都比较少。而对 js 文件处理主要就是 eslint 、babel、Terser 三个工具,所以我们要提升它们的运行速度。我们可以开启多进程同时处理 js 文件,这样速度就比之前的单进程打包更快了。
解决方法:
多进程打包:开启电脑的多个进程同时干一件事,速度更快。需要注意:请仅在特别耗时的操作中使用,因为每个进程启动就有大约为 600ms 左右开销。
我们启动进程的数量就是我们 CPU 的核数。如何获取 CPU 的核数,因为每个电脑都不一样。
示例:
// nodejs核心模块,直接使用
const os = require("os");
// cpu核数
const threads = os.cpus().length;
使用
npm i thread-loader -D
const os = require("os");
const path = require("path");
const ESLintPlugin = 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 TerserWebpackPlugin = require("terser-webpack-plugin"); // 压缩js, 已经内置了,不需要安装
const threads = os.cpus().length; // cpu核数
function getStyleLoader() {
return [
// 执行顺序:从右到左
MiniCssExtractPlugin.loader, // 将css打包成单独文件
"css-loader", // 将css资源编译成commonjs模块到js中
{
loader: "postcss-loader",
options: {
postcssOptions: {
plugins: [
"postcss-preset-env", // 能解决大都数兼容性问题
],
},
},
},
];
}
module.exports = {
// 入口,相对路径和绝对路径都可以
entry: "./src/main.js",
// 输出
output: {
path: path.resolve(__dirname, "../dist"),
// 入口文件打包输出文件名
filename: "static/js/main.js",
// 自动清空上次打包的内容
// 原理:在打包前,将path(上面那个)整个目录内容删除,然后再进行打包
clean: true,
},
// 记载器
module: {
rules: [
// loader的配置
{
oneOf: [
{
test: /\.css/, // 只检测.css文件
use: getStyleLoader(),
},
{
test: /\.less$/,
use: [
...getStyleLoader(),
"less-loader", // 将less编译成css文件
],
},
{
test: /\.(png|jpe?g|git|webp|svg)$/,
type: "asset",
parser: {
dataUrlCondition: {
// 这里配置小于20kb的图片就转为base64
// 优点:减少请求数量
// 缺点:体积会变大
maxSize: 20 * 1024,
},
},
generator: {
// 输出图片路径及名称
// [hash:10] hash值只取前10位
filename: "static/images/[hash:10][ext][query]",
},
},
{
// 处理字体、音频、视频等资源
test: /\.(tff|woff2?|map3|map4|avi)$/,
type: "asset/resource", // 不转换位base64
generator: {
filename: "static/media/[hash:10][ext][query]",
},
},
{
test: /\.js$/,
exclude: /node_modules/, // 不处理node_modules下的js文件
use: [
{
loader: "thread-loader", // 开启多进程
options: {
works: threads,
},
},
{
loader: "babel-loader",
options: {
cacheDirectory: true, // 开启babel压缩
cacheCompression: false, // 关闭缓存文件压缩
},
},
],
},
],
},
],
},
// 插件
plugins: [
new ESLintPlugin({
// 检测哪些文件
context: path.resolve(__dirname, "../src"),
cache: true, // 开启缓存
cacheLocation: path.resolve(
__dirname,
"../node_modules/.cache/eslintcache"
),
threads, // 开启多进程
}),
new HtmlWebpackPlugin({
// 模板:以public/index.html文件创建新的html文件
// 新的html文件特点:1、结构和原来一致 2、自动引入打包输出的资源
template: path.resolve(__dirname, "../public/index.html"),
}),
new MiniCssExtractPlugin({
filename: "static/css/main.css",
}),
// new CssMinimizerPlugin(),
// new TerserWebpackPlugin({
// parallel: threads,
// }),
],
optimization: {
// 压缩插件通常放这里
minimizer: [
new CssMinimizerPlugin(),
new TerserWebpackPlugin({
parallel: threads,
}),
],
},
// 生产模式不需要devServer
// 模式
mode: "production",
devtool: "source-map",
};
减少代码体积
Tree Shaking
问题:
开发时我们定义了一些工具函数库,或者引用第三方工具函数库或组件库。如果没有特殊处理的话我们打包时会引入整个库,但是实际上可能我们可能只用上极小部分的功能。这样将整个库都打包进来,体积就太大了。
解决方法:
Tree Shaking 是一个术语,通常用于描述移除 JavaScript 中的没有使用上的代码。
注意:它依赖 ES Module。
使用:
Webpack 已经默认开启了这个功能,无需其他配置。
Babel
问题:
Babel 为编译的每个文件都插入了辅助代码,使代码体积过大!
Babel 对一些公共方法使用了非常小的辅助代码,比如 _extend。默认情况下会被添加到每一个需要它的文件中。
你可以将这些辅助代码作为一个独立模块,来避免重复引入。
解决方法:
@babel/plugin-transform-runtime: 禁用了 Babel 自动对每个文件的 runtime 注入,而是引入 @babel/plugin-transform-runtime 并且使所有辅助代码从这里引用。
使用:
安装
npm i @babel/plugin-transform-runtime -D
Image Minimizer
问题:
开发如果项目中引用了较多图片,那么图片体积会比较大,将来请求速度比较慢。我们可以对图片进行压缩,减少图片体积。
注意:如果项目中图片都是在线链接,那么就不需要了。本地项目静态图片才需要进行压缩
解决方法:
image-minimizer-webpack-plugin: 用来压缩图片的插件
使用:
安装
npm i image-minimizer-webpack-plugin imagemin -D
还有剩下包需要下载,有两种模式:
- 无损压缩:
npm install imagemin-gifsicle imagemin-jpegtran imagemin-optipng imagemin-svgo -D
- 有损压缩
npm install imagemin-gifsicle imagemin-mozjpeg imagemin-pngquant imagemin-svgo -D
const TerserPlugin = require("terser-webpack-plugin");
// 压缩图片
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",
},
},
],
},
],
],
},
},
}),