phase 5 part 2: vite 8, webpack 5, fe-testing-perf topics with verified examples
This commit is contained in:
1 parent
7b5cae7d24
commit
9eeb10aede
38 files changed
+1823
-37
No files matched your search
@@ -0,0 +1,102 @@
|
||||
---
|
||||
id: frontend.webpack.build-optimization
|
||||
title: webpack 5:loader 与 plugin、splitChunks、tree shaking、缓存、模块联邦
|
||||
type: lesson
|
||||
domain: frontend
|
||||
stack: [webpack]
|
||||
tags: [webpack, loader, plugin, splitChunks, tree shaking, contenthash, 持久化缓存, Module Federation]
|
||||
level: intermediate
|
||||
prerequisites: []
|
||||
est_hours: 2.5
|
||||
related: [frontend.vite.dev-build-config, frontend.webpack.scenario.build-speed, frontend.webpack.interview]
|
||||
week: [7]
|
||||
order: 1
|
||||
---
|
||||
|
||||
# webpack 5:loader 与 plugin、splitChunks、tree shaking、缓存、模块联邦
|
||||
|
||||
> 基于 webpack 5.112 + webpack-cli 7 编写并实际构建验证。很多公司的存量项目仍在用 webpack,面试也常问原理。以官方文档为准:https://webpack.js.org/concepts/ 。
|
||||
|
||||
## 解释说明
|
||||
|
||||
### 核心概念
|
||||
|
||||
| 概念 | 一句话 |
|
||||
| --- | --- |
|
||||
| entry | 从哪里开始分析依赖 |
|
||||
| output | 产物放在哪里、叫什么名字 |
|
||||
| **loader** | 把非 JS 文件(或需要转换的 JS)**转换**成 JS 模块;从右到左(从下到上)链式执行 |
|
||||
| **plugin** | 在编译**生命周期的钩子**上做事(生成 HTML、压缩、提取 CSS、分析体积),基于 tapable 事件机制 |
|
||||
| chunk | 打包过程中的代码块;入口、动态 `import()`、`splitChunks` 都会产生 chunk |
|
||||
| mode | `development` / `production`,决定默认优化项 |
|
||||
|
||||
### 构建流程(面试常问)
|
||||
|
||||
初始化参数 → 创建 Compiler → 从 entry 开始,对每个模块调用匹配的 loader 转换 → 解析出依赖,递归构建模块依赖图 → 根据入口和拆包规则组装 chunk → 生成代码写入 output。过程中在各个阶段触发钩子,plugin 在钩子上执行。
|
||||
|
||||
### 优化手段
|
||||
|
||||
- **tree shaking**:依赖 ES 模块的静态结构,`usedExports` 标记未使用的导出,压缩时删除;`package.json` 的 `sideEffects` 声明哪些文件有副作用(如 CSS),其余可以整体删除。
|
||||
- **splitChunks**:提取公共代码和第三方库;`runtimeChunk: "single"` 把运行时单独拆出。
|
||||
- **contenthash**:文件名随内容变化,配合 CDN 长期缓存。
|
||||
- **持久化缓存**:`cache: { type: "filesystem" }`,第二次构建明显变快。
|
||||
- **构建提速**:缩小 loader 的处理范围(`include` / `exclude`)、用 swc / esbuild 类 loader 代替 babel、多进程、减少不必要的 source map。
|
||||
- **Module Federation(模块联邦)**:多个独立构建的应用在运行时共享模块,用于微前端。
|
||||
|
||||
## 案例
|
||||
|
||||
一个主站和后台两个入口共享工具函数:通过 `splitChunks` 提取出 `shared`,运行时拆出 `runtime`,报表模块用动态 `import()` 按需加载。
|
||||
|
||||
## 代码示例
|
||||
|
||||
完整项目:[examples/webpack-config](examples/webpack-config/),`npm install && npm run build` 输出:
|
||||
|
||||
```text
|
||||
[size] runtime.981552ae.js 2.74 KiB
|
||||
[size] main.38cd14b7.js 0.33 KiB
|
||||
[size] 531.30ecc347.js 0.21 KiB ← 动态 import 的 report.js
|
||||
[size] admin.e2a620fd.js 0.20 KiB
|
||||
[size] shared.5f4a3ab4.js 0.18 KiB ← 两个入口共用的 utils.js
|
||||
Entrypoint main 3.25 KiB = runtime + shared + main
|
||||
Entrypoint admin 3.12 KiB = runtime + shared + admin
|
||||
```
|
||||
|
||||
已验证:`utils.js` 中未被使用的 `unusedHelper` 在产物中搜索不到(tree shaking 生效)。
|
||||
|
||||
自定义 loader([loaders/md-loader.cjs](examples/webpack-config/loaders/md-loader.cjs)):
|
||||
|
||||
```js
|
||||
module.exports = function mdLoader(source) {
|
||||
const { trim = false } = this.getOptions();
|
||||
const text = trim ? source.trim() : source;
|
||||
return `export default ${JSON.stringify(text)};`;
|
||||
};
|
||||
```
|
||||
|
||||
自定义 plugin([webpack.config.js](examples/webpack-config/webpack.config.js)):
|
||||
|
||||
```js
|
||||
class SizeReportPlugin {
|
||||
apply(compiler) {
|
||||
compiler.hooks.done.tap("SizeReportPlugin", (stats) => {
|
||||
const assets = stats.toJson({ all: false, assets: true }).assets ?? [];
|
||||
for (const a of assets) console.log(`[size] ${a.name} ${(a.size / 1024).toFixed(2)} KiB`);
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 易错点
|
||||
|
||||
- 混淆 loader 和 plugin 的职责。
|
||||
- loader 的执行顺序写反(`use: ["style-loader", "css-loader"]` 中 css-loader 先执行)。
|
||||
- 用了 CommonJS(`require` / `module.exports`)导致 tree shaking 失效;`sideEffects: false` 配置错误导致 CSS 被删掉。
|
||||
- 用 `[hash]` 而不是 `[contenthash]`,每次构建所有文件名都变,缓存失效。
|
||||
- 生产环境开启了暴露源码的 source map 并公开访问。
|
||||
|
||||
## 面试常问
|
||||
|
||||
- loader 和 plugin 的区别?写过吗?
|
||||
- webpack 的构建流程?
|
||||
- tree shaking 的原理和失效原因?
|
||||
- 怎么优化构建速度和产物体积?
|
||||
@@ -0,0 +1,7 @@
|
||||
// 不自动运行:webpack loader,由 webpack 调用
|
||||
// loader 是一个函数:输入文件内容,返回 JS 代码字符串
|
||||
module.exports = function mdLoader(source) {
|
||||
const { trim = false } = this.getOptions();
|
||||
const text = trim ? source.trim() : source;
|
||||
return `export default ${JSON.stringify(text)};`;
|
||||
};
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"name": "webpack-config-demo",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"sideEffects": ["*.css"],
|
||||
"scripts": {
|
||||
"build": "webpack --mode production",
|
||||
"analyze": "webpack --mode production --json > stats.json"
|
||||
},
|
||||
"devDependencies": {
|
||||
"webpack": "^5.112.0",
|
||||
"webpack-cli": "^7.0.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,4 @@
|
||||
// 不自动运行:由 webpack 打包
|
||||
import { formatPrice } from "./utils.js";
|
||||
|
||||
console.log("admin", formatPrice(500));
|
||||
@@ -0,0 +1,7 @@
|
||||
// 不自动运行:由 webpack 打包
|
||||
import { formatPrice } from "./utils.js";
|
||||
import notice from "./notice.md";
|
||||
|
||||
console.log(formatPrice(1999), notice.split("\n")[0]);
|
||||
// 动态 import:单独的 chunk,用到时才加载
|
||||
import("./report.js").then((m) => console.log(m.buildReport([1, 2, 3])));
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
# 公告
|
||||
|
||||
退货政策调整,详见帮助中心。
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
// 不自动运行:被动态 import
|
||||
export function buildReport(nums) {
|
||||
return { count: nums.length, sum: nums.reduce((a, b) => a + b, 0) };
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
// 不自动运行:由 webpack 打包
|
||||
export function formatPrice(cents) {
|
||||
return `¥${(cents / 100).toFixed(2)}`;
|
||||
}
|
||||
// 没有被任何地方使用:生产构建时会被 tree shaking 删除
|
||||
export function unusedHelper() {
|
||||
return "UNUSED_HELPER_MARKER";
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
// 不自动运行:需要先 npm install,然后 npm run build
|
||||
// webpack 5 配置示例:loader、plugin、splitChunks、contenthash、tree shaking、持久化缓存。以官方文档为准:https://webpack.js.org/concepts/
|
||||
import path from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||
|
||||
// 自定义 plugin:构建结束后打印每个产物的大小(plugin = 在编译生命周期的钩子上做事)
|
||||
class SizeReportPlugin {
|
||||
apply(compiler) {
|
||||
compiler.hooks.done.tap("SizeReportPlugin", (stats) => {
|
||||
const assets = stats.toJson({ all: false, assets: true }).assets ?? [];
|
||||
for (const a of assets.sort((x, y) => y.size - x.size)) {
|
||||
console.log(`[size] ${a.name.padEnd(36)} ${(a.size / 1024).toFixed(2)} KiB`);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
export default (env, argv) => {
|
||||
const isProd = argv.mode === "production";
|
||||
return {
|
||||
entry: { main: "./src/index.js", admin: "./src/admin.js" }, // 两个入口,共享 utils 和第三方代码
|
||||
output: {
|
||||
path: path.resolve(__dirname, "dist"),
|
||||
filename: isProd ? "[name].[contenthash:8].js" : "[name].js", // 内容变了文件名才变,利于长期缓存
|
||||
clean: true,
|
||||
},
|
||||
module: {
|
||||
rules: [
|
||||
// 自定义 loader:把 .md 文件转成导出字符串的 JS 模块(loader = 把某类文件转换成 JS 模块)
|
||||
{ test: /\.md$/, use: [{ loader: path.resolve(__dirname, "loaders/md-loader.cjs"), options: { trim: true } }] },
|
||||
],
|
||||
},
|
||||
optimization: {
|
||||
usedExports: true, // 标记未使用的导出,压缩时删除(tree shaking)
|
||||
runtimeChunk: "single", // webpack 运行时单独一个文件,避免业务代码变化影响 vendor 的哈希
|
||||
splitChunks: {
|
||||
chunks: "all",
|
||||
cacheGroups: {
|
||||
shared: { name: "shared", minChunks: 2, minSize: 0, priority: 10 }, // 两个入口都用到的代码
|
||||
},
|
||||
},
|
||||
},
|
||||
cache: { type: "filesystem" }, // 持久化缓存:第二次构建明显变快
|
||||
plugins: [new SizeReportPlugin()],
|
||||
devtool: isProd ? false : "eval-cheap-module-source-map",
|
||||
};
|
||||
};
|
||||
@@ -1,15 +1,39 @@
|
||||
---
|
||||
id: frontend.webpack.index
|
||||
title: Webpack
|
||||
title: webpack
|
||||
type: index
|
||||
domain: frontend
|
||||
stack: [webpack]
|
||||
tags: []
|
||||
tags: [webpack, 构建工具, 性能优化]
|
||||
week: [7]
|
||||
---
|
||||
|
||||
# Webpack
|
||||
# webpack
|
||||
|
||||
核心概念、Loader 与 Plugin、拆包、构建优化。
|
||||
存量项目和面试中仍然很常见:loader 与 plugin、构建流程、tree shaking、拆包和缓存、构建提速。
|
||||
|
||||
> 本专题建设中:课程、企业场景、面试题和示例代码会陆续补充。
|
||||
## 学习路线
|
||||
|
||||
| 顺序 | 课程 | 级别 | 预计 |
|
||||
| --- | --- | --- | --- |
|
||||
| 1 | [webpack 5:loader 与 plugin、splitChunks、tree shaking、缓存、模块联邦](01-build-optimization.md) | 进阶 | 2.5 小时 |
|
||||
|
||||
## 企业场景
|
||||
|
||||
- [大型项目构建慢、包体积大:度量、优化和防退化](scenarios/build-speed.md)
|
||||
|
||||
## 面试题
|
||||
|
||||
- [webpack 面试题](interview.md)
|
||||
|
||||
## 示例代码
|
||||
|
||||
- [examples/webpack-config](examples/webpack-config/):双入口 + `splitChunks` 提取公共代码 + 动态导入 + 自定义 loader 和 plugin(`npm run build` 已验证,未使用的导出被删除)
|
||||
|
||||
## 在 16 周计划中
|
||||
|
||||
- [第 7 周:前端工程化查漏](../../../plan/week07-frontend.md)
|
||||
|
||||
## 官方资料
|
||||
|
||||
- https://webpack.js.org/concepts/
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
id: frontend.webpack.interview
|
||||
title: webpack 面试题
|
||||
type: interview
|
||||
domain: frontend
|
||||
stack: [webpack]
|
||||
tags: [webpack, loader, plugin, tree shaking, 面试]
|
||||
level: intermediate
|
||||
related: [frontend.webpack.build-optimization, frontend.vite.interview]
|
||||
week: [7, 16]
|
||||
---
|
||||
|
||||
# webpack 面试题
|
||||
|
||||
## 基础
|
||||
|
||||
### 【基础】loader 和 plugin 有什么区别?
|
||||
|
||||
**参考答案**:loader 负责把某类文件转换成 webpack 能处理的 JS 模块,本质是转换函数,在 `module.rules` 中配置;plugin 通过钩子介入整个编译生命周期,做打包优化、资源管理、注入环境变量等,在 `plugins` 中配置。
|
||||
|
||||
**追问**:多个 loader 的执行顺序?→ 从右到左(数组从后往前);每个 loader 还有 pitch 阶段,从左到右执行。
|
||||
|
||||
### 【基础】hash、chunkhash、contenthash 的区别?
|
||||
|
||||
**参考答案**:hash 与整次构建相关,任何改动都会变;chunkhash 与所在 chunk 相关;contenthash 与文件内容相关,最适合长期缓存(例如 CSS 文件不随 JS 变化)。
|
||||
|
||||
**追问**:只改了业务代码,vendor 的文件名也变了,为什么?→ 运行时代码或模块 id 混在 vendor 中;用 `runtimeChunk: "single"` 并使用确定性的模块 id(webpack 5 生产模式默认)。
|
||||
|
||||
### 【基础】什么是 tree shaking?
|
||||
|
||||
**参考答案**:删除未使用代码。依赖 ES 模块的静态导入导出,构建时标记未使用的导出,压缩阶段删除;`sideEffects` 声明哪些模块有副作用。
|
||||
|
||||
**追问**:什么情况会失效?→ 使用 CommonJS、模块有副作用但未声明、babel 把 ESM 转成了 CommonJS、动态访问导出对象。
|
||||
|
||||
## 进阶
|
||||
|
||||
### 【进阶】讲讲 webpack 的构建流程。
|
||||
|
||||
**参考答案**:合并配置 → 创建 Compiler 并注册插件 → 从入口开始构建模块:调用 loader 转换、解析 AST 收集依赖、递归 → 形成模块依赖图 → 按入口、动态导入和 splitChunks 规则生成 chunk → 生成代码、写入文件。全程通过 tapable 钩子通知插件。
|
||||
|
||||
**追问**:Compiler 和 Compilation 的区别?→ Compiler 代表整个 webpack 实例,生命周期贯穿始终;Compilation 代表一次构建(监听模式下每次重新构建创建新的 Compilation)。
|
||||
|
||||
### 【进阶】如何提升 webpack 的构建速度?
|
||||
|
||||
**参考答案**:持久化缓存;缩小 loader 范围;更快的转译器(swc / esbuild 类 loader);减少或简化 source map;类型检查并行;合理的 `resolve` 配置;必要时考虑 Rspack。
|
||||
|
||||
**追问**:怎么确定瓶颈?→ 先用速度分析工具或 `--profile` 统计各阶段和 loader 耗时,再有针对性地优化。
|
||||
|
||||
### 【进阶】什么是模块联邦?适用场景?
|
||||
|
||||
**参考答案**:webpack 5 提供的能力,让独立构建和部署的应用在运行时互相加载模块,并共享依赖(如同一份 Vue)。用于微前端、多团队独立发布。
|
||||
|
||||
**追问**:有什么风险?→ 共享依赖版本不一致、运行时加载失败要降级、类型共享麻烦、调试复杂。
|
||||
|
||||
## 场景题
|
||||
|
||||
### 【场景题】CI 构建十几分钟、首页 JS 几 MB,你怎么优化并防止反弹?
|
||||
|
||||
**参考答案**:先度量(速度分析、产物分析)→ 构建提速(缓存、swc、并行类型检查)→ 体积优化(懒加载、按需引入、拆包、tree shaking)→ CI 体积预算。详见[构建优化场景](scenarios/build-speed.md)。
|
||||
|
||||
**追问**:优化效果怎么证明?→ 对比优化前后的构建时间和关键页面的产物大小、LCP 等指标,用数据说话。
|
||||
|
||||
### 【场景题】要求你写一个 loader,把团队内部的 `.md` 文档直接作为字符串导入组件,怎么做?
|
||||
|
||||
**参考答案**:loader 导出一个函数,参数是文件内容,用 `this.getOptions()` 读取配置,返回 `export default <JSON 字符串>` 形式的 JS 代码;在 `module.rules` 中用 `test: /\.md$/` 配置。见 [examples/webpack-config](examples/webpack-config/)。
|
||||
|
||||
**追问**:如果要转成 HTML 并支持异步处理?→ 使用 `this.async()` 获取回调,调用 Markdown 解析库后回调结果;注意输出内容的 XSS 风险。
|
||||
@@ -0,0 +1,85 @@
|
||||
---
|
||||
id: frontend.webpack.scenario.build-speed
|
||||
title: 大型项目构建慢、包体积大:度量、优化和防退化
|
||||
type: scenario
|
||||
domain: frontend
|
||||
stack: [webpack, fe-testing-perf, cicd]
|
||||
tags: [构建速度, 包体积, splitChunks, 持久化缓存, 体积预算, CI]
|
||||
level: intermediate
|
||||
prerequisites: [frontend.webpack.build-optimization]
|
||||
est_hours: 2
|
||||
related: [frontend.webpack.interview, frontend.vite.scenario.webpack-to-vite]
|
||||
week: [7]
|
||||
---
|
||||
|
||||
# 大型项目构建慢、包体积大:度量、优化和防退化
|
||||
|
||||
## 业务背景与问题
|
||||
|
||||
一个中台项目(webpack 5,几百个页面):CI 构建要十几分钟,发版排队;首页 JS 有几 MB,弱网用户首屏很慢;优化过一次,几个月后又变回去了。
|
||||
|
||||
## 约束
|
||||
|
||||
- 短期内不能换构建工具(有大量自定义 loader 和插件)。
|
||||
- 优化要可量化,并且防止退化。
|
||||
|
||||
## 方案设计
|
||||
|
||||
1. **先度量**:
|
||||
- 构建速度:统计各 loader / plugin 耗时(速度分析插件或 `--profile`);
|
||||
- 体积:生成产物分析报告(`webpack --json` + 可视化工具),找出最大的依赖和重复依赖。
|
||||
2. **构建提速**:
|
||||
- 开启 `cache: { type: "filesystem" }`,CI 中缓存缓存目录;
|
||||
- babel-loader 换成 swc 类 loader,并用 `include` 只处理源码;
|
||||
- 生产构建关闭不需要的 source map 或使用更快的类型;
|
||||
- 类型检查与构建并行(单独的 `tsc --noEmit` 任务)。
|
||||
3. **体积优化**:
|
||||
- 路由级懒加载;
|
||||
- 大依赖按需引入(图表库、组件库、日期库)或替换为更小的库;
|
||||
- `splitChunks` 按变化频率拆分第三方库;
|
||||
- 检查 `sideEffects` 让 tree shaking 生效。
|
||||
4. **防退化**:在 CI 中设置体积预算(`performance.maxEntrypointSize` 或脚本对比上次的产物大小),超出就失败并提示。
|
||||
|
||||
## 关键代码
|
||||
|
||||
```js
|
||||
// webpack.config.js 片段
|
||||
export default {
|
||||
cache: { type: "filesystem", buildDependencies: { config: [import.meta.filename] } }, // 配置变化时缓存失效
|
||||
module: {
|
||||
rules: [{ test: /\.[jt]sx?$/, include: path.resolve("src"), use: "swc-loader" }],
|
||||
},
|
||||
optimization: {
|
||||
runtimeChunk: "single",
|
||||
splitChunks: {
|
||||
chunks: "all",
|
||||
cacheGroups: {
|
||||
framework: { test: /[\\/]node_modules[\\/](vue|vue-router|pinia)[\\/]/, name: "framework", priority: 20 },
|
||||
vendors: { test: /[\\/]node_modules[\\/]/, name: "vendors", priority: 10 },
|
||||
},
|
||||
},
|
||||
},
|
||||
performance: { hints: "error", maxEntrypointSize: 500 * 1024, maxAssetSize: 300 * 1024 }, // 超预算直接构建失败
|
||||
};
|
||||
```
|
||||
|
||||
可运行的基础配置:[examples/webpack-config](../examples/webpack-config/)。
|
||||
|
||||
## 取舍
|
||||
|
||||
| 选择 | 优点 | 缺点 |
|
||||
| --- | --- | --- |
|
||||
| **在 webpack 内优化(本方案)** | 风险小,见效快 | 上限受 webpack 限制 |
|
||||
| 迁移到 Rspack | 配置大体兼容,速度提升大 | 部分插件需要验证 |
|
||||
| 迁移到 Vite | 开发体验最好 | 迁移成本高,见[迁移场景](../../vite/scenarios/webpack-to-vite.md) |
|
||||
|
||||
## 易错点
|
||||
|
||||
- 没有度量就开始优化,改了很多却不知道哪项有效。
|
||||
- 持久化缓存没有配置 `buildDependencies`,改了配置却用了旧缓存。
|
||||
- 把所有第三方库打成一个巨大的 vendor,任何依赖升级都让整个文件缓存失效。
|
||||
- 只优化一次,没有预算和 CI 检查,很快退化。
|
||||
|
||||
## 面试怎么讲
|
||||
|
||||
> “先度量:用速度分析和产物分析找到瓶颈,主要是 babel 处理了 node_modules 和一个整包引入的图表库。然后开启持久化缓存并在 CI 中缓存、换成 swc 类 loader、类型检查并行;体积上做路由懒加载、图表库按需引入、按变化频率拆包。最后在 CI 加体积预算防止退化。数据以实际测量为准,我会给出优化前后的对比。”
|
||||
Reference in new issue
Block a user