在 javascript 项目中启用 tree shaking,核心是确保代码符合 es modules (esm) 规范并使用现代构建工具(如 webpack、vite)进行生产环境打包。具体做法是将项目配置为使用 module 字段指向 esm 入口,并在构建命令中开启 --production 模式或设置 mode: 'production',这样构建工具会自动移除未使用的导出代码。

Webpack 如何配置以支持 Tree Shaking
Webpack 启用 Tree Shaking 需要满足三个条件:使用 ESM 语法、设置 mode 为 production、配置 optimization.usedExports 和 sideEffects。首先,确保 package.json 中的 main 指向 CommonJS 而 module 指向 ESM,或者统一使用 ESM。其次,在 webpack.config.js 中明确声明哪些文件没有副作用,以便构建工具安全地删除它们。

{
"name": "my-tree-shaking-app",
"version": "1.0.0",
"type": "module",
"sideEffects": false,
"exports": {
".": "./src/index.js"
}
}
上述 package.json 配置中,"type": "module" 使所有 .js 文件默认为 ESM,"sideEffects": false 告诉 Webpack 这些模块没有副作用,可以安全地进行摇树优化。如果某些 CSS 文件或特定脚本有副作用,需在数组中列出,例如 [".css", "src/polyfill.js"]。在 Webpack 5 中,默认情况下 usedExports 和 sideEffects 已在 production 模式下启用,但显式配置可确保行为一致。
立即学习“Java免费学习笔记(深入)”;
// src/utils.js export const add = (a, b) => a + b; export const multiply = (a, b) => a * b;
// src/index.js
import { add } from './utils.js';
console.log(add(1, 2));
当运行 npx webpack --mode production 时,由于 multiply 未被导入,Webpack 会在最终 bundle 中将其移除。验证方法是检查输出文件的大小和内容,或使用 webpack-bundle-analyzer 插件可视化分析。
使用 Husky 将 pre-commit、pre-push 和 commit-msg 检查集成到仓库中,以便代理和开发人员在更改离开工作站之前运行相同的本地防护措施。
Vite 中 Tree Shaking 的自动处理机制
Vite 基于 Rollup 构建,Tree Shaking 是开箱即用的,无需额外配置。只要使用 ESM 导入语句,Rollup 就会自动分析依赖图并剔除未使用的代码。开发者只需确保使用 import ... from ... 而非 require(),并利用 Vite 的开发服务器快速验证结果。

// vite.config.js
export default {
build: {
rollupOptions: {
// 可选:手动指定外部依赖,避免被打包
external: ['lodash']
}
}
}
在 Vite 项目中,即使引入了整个库,如 import _ from 'lodash',如果只使用了其中几个函数,Rollup 也能通过静态分析移除未用部分。例如,若只调用 _.get(),其他方法不会被包含在产物中。这与 Webpack 不同,Webpack 有时需要对第三方库进行特殊配置才能有效摇树,而 Vite/Rollup 对 ESM 的支持更彻底。
// main.js
import { get } from 'lodash-es';
const obj = { a: { b: 1 } };
console.log(get(obj, 'a.b'));
使用 lodash-es 而非 lodash 是关键,因为后者是 CommonJS 格式,不利于 Tree Shaking。运行 npx vite build 后,生成的 dist 目录中将仅包含必要的代码片段,显著减小包体积。
Tree Shaking 对未使用导出的实际影响
Tree Shaking 直接减少最终打包文件的体积,提升加载速度。对于大型项目,未使用的工具函数、常量或组件会被彻底移除,避免冗余代码传输。这一过程发生在构建阶段,不影响运行时行为,因为未导入的代码根本不会出现在 bundle 中。

















