在 javascript 构建流水线中集成 tree shaking,核心做法是确保使用支持 es module (esm) 的打包工具(如 webpack、vite 或 rollup),并在配置中开启优化选项。tree shaking 依赖静态的 import/export 语法来识别未使用的代码,因此必须将项目模块格式转换为 esm,并配合 babel 等工具移除未使用的代码。这样做可以在生产构建时显著减小最终包体积。
Webpack 5 如何配置以启用 Tree Shaking
在 Webpack 5 中启用 Tree Shaking 需要设置 mode 为 production 或在 optimization 中显式指定 sideEffects。Webpack 默认在生产模式下会尝试摇树,但为了更精确的控制,建议检查 package.json 中的 sideEffects 字段。如果库没有副作用,可以设置为 false,这样 Webpack 能安全地删除未引用的文件。

{
"name": "my-app",
"version": "1.0.0",
"sideEffects": false
}
在 webpack.config.js 中,确保 optimization.usedExports 为 true,这会标记每个模块中导出的内容是否被使用。同时,minimizer 插件(如 TerserPlugin)负责实际删除这些标记的代码。以下是一个最小化的配置示例:
const path = require('path');
module.exports = {
entry: './src/index.js',
output: {
filename: 'main.js',
path: path.resolve(__dirname, 'dist'),
},
mode: 'production',
optimization: {
usedExports: true,
minimize: true,
},
};
运行 npx webpack 后,输出文件将只包含被引用的代码。例如,如果 index.js 只导出了 add 函数,而 utils.js 中有 unusedFunction,则 unusedFunction 不会被打包进 main.js。
Vite 中 Tree Shaking 的自动处理机制
Vite 基于 Rollup 进行生产构建,天然支持 Tree Shaking。开发者无需手动配置复杂的优化选项,只需确保代码符合 ESM 规范即可。Vite 在开发服务器中使用 esbuild 进行快速转换,而在构建时使用 Rollup 进行彻底的摇树。
在代码库出现结构漂移之前,扫描JS或TS代码库中的禁止导入、循环依赖、孤立模块和其他依赖规则违规情况。

// src/main.js
import { greet } from './utils.js';
console.log(greet('World'));
// src/utils.js
export function greet(name) {
return `Hello, ${name}`;
}
export function farewell(name) {
return `Goodbye, ${name}`;
}
在上述代码中,main.js 仅导入了 greet 函数。当执行 npm run build 时,Rollup 会分析依赖图,发现 farewell 函数未被使用,从而将其从最终的 bundle 中移除。这种机制比 Webpack 更自动化,减少了配置负担。
sideEffects 配置错误导致代码被意外删除
当在 package.json 中将 sideEffects 设置为 false 时,任何导入的文件都会被假设没有副作用。如果某个文件虽然导出了一些函数,但在导入时还执行了全局样式注入或全局变量修改,这些代码会被误删,导致运行时错误。
// src/styles.css
body {
background-color: #f0f0f0;
}
// src/index.js
import './styles.css'; // 这行代码可能被忽略
import { func } from './lib.js';
func();
如果 lib.js 和 styles.css 都被标记为无副作用,且 index.js 中没有显式使用 styles.css 的导出,Webpack 可能会在优化阶段移除对 styles.css 的引用,导致样式丢失。正确的做法是在 sideEffects 数组中列出有副作用的文件,如 ["*.css"],或者在导入时显式使用其导出值。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










