在 javascript 项目中启用 tree shaking,核心做法是切换到生产构建模式并配置打包工具(如 webpack)的优化选项。具体而言,需将 mode 设置为 'production' 以启用默认压缩,并在 optimization 中显式设置 usedexports: true 和 sideeffects: false。这样做会让打包器在编译阶段移除未使用的代码导出,从而减小最终包体积。

Webpack 生产模式下如何配置 Tree Shaking
要确保 Tree Shaking 生效,必须在 webpack.config.js 中明确指定优化策略。首先,设置 mode: 'production' 会触发内置的 TerserPlugin 进行代码压缩,这是基础步骤。其次,需要在 optimization 对象中配置 usedExports 为 true,这告诉 Webpack 标记哪些导出的函数或变量未被使用。最后,通过 sideEffects: false 告知打包器模块没有副作用,可以安全地丢弃未引用的模块。如果项目中的某些库有副作用(如修改全局变量),则需在 package.json 中列出这些文件,否则它们会被错误地移除。

{
"name": "tree-shaking-demo",
"version": "1.0.0",
"sideEffects": false,
"dependencies": {
"lodash-es": "^4.17.21"
},
"devDependencies": {
"webpack": "^5.88.0",
"webpack-cli": "^5.1.4"
}
}// webpack.config.js
const path = require('path');
module.exports = {
entry: './src/index.js',
output: {
filename: 'bundle.js',
path: path.resolve(__dirname, 'dist'),
},
mode: 'production', // 启用生产模式
optimization: {
usedExports: true, // 标记未使用的导出
sideEffects: false, // 假设所有模块无副作用
minimize: true, // 启用压缩
},
};// src/utils/math.js
export function add(a, b) {
return a + b;
}
export function subtract(a, b) {
return a - b;
}// src/index.js
import { add } from './utils/math';
console.log(add(1, 2)); // 仅使用 add,subtract 应被移除运行 npx webpack 后,生成的 dist/bundle.js 中将不包含 subtract 函数的定义。这是因为 usedExports 标记了它,而 sideEffects: false 允许打包器在压缩阶段将其彻底移除。如果 package.json 中未设置 sideEffects: false,且存在其他导入但未使用的模块,打包器可能会保守地保留它们以避免潜在问题。
立即学习“Java免费学习笔记(深入)”;
使用Atmosphere构建通过WebSocket、SSE、gRPC、WebTransport、MCP、A2A和AG-UI流传输的JVM代理网关,并带有治理钩子。
如何处理带有副作用的模块?
当项目中包含需要执行初始化代码的库时,Tree Shaking 可能会误删这些必要的导入。解决方法是在 package.json 的 sideEffects 字段中指定受影响的文件路径。例如,如果一个 CSS 文件或 polyfill 脚本需要在全局作用域中注册事件,必须将其列入白名单。这样,即使该文件中的导出未被直接引用,打包器也会保留整个文件,确保副作用正常执行。对于 ES Modules 库,通常可以安全地设置 false,但对于 CommonJS 或混合模块,需谨慎处理。

// src/polyfill.js
// 这个文件没有导出任何内容,但需要执行以修补浏览器
if (!Array.prototype.flat) {
Array.prototype.flat = function() {
return [].concat(this);
};
}// package.json
{
"sideEffects": [
"./src/polyfill.js",
"*.css"
]
}在上述配置中,polyfill.js 被明确列为有副作用的文件。即使 index.js 中没有导入它,只要其他模块间接依赖或构建流程中包含它,打包器就不会将其移除。如果错误地将 polyfill.js 排除在 sideEffects 列表之外,且其导出未被使用,它可能会被丢弃,导致运行时缺少必要的 API 支持。因此,正确识别和声明副作用是 Tree Shaking 成功的关键。
未使用的导出在压缩阶段是如何被移除的?
Tree Shaking 分为两个阶段:标记和压缩。usedExports: true 负责在第一阶段标记未使用的导出,但这并不会立即删除代码。真正的移除发生在第二阶段,由 TerserPlugin 完成。在生产模式下,TerserPlugin 会扫描代码,发现被标记为未使用的函数或变量,并将其从输出 bundle 中剔除。如果 minimize: false,即使标记了未使用导出,代码仍会保留在 bundle 中,只是添加了注释。因此,确保 mode: 'production' 或手动启用 minimize 是最终实现代码缩减的必要条件。

















