javascript tree shaking 通过静态分析代码的导入导出关系来识别死代码,核心在于确保模块使用 es module (esm) 语法,并依赖打包工具(如 webpack、vite)在构建时根据 sideeffects 配置和引用链剔除未被引用的导出。

如何标记模块以允许安全删除
要允许打包工具安全地删除模块中的代码,必须在 package.json 中设置 sideEffects 字段。如果模块包含副作用(如修改全局变量或执行初始化逻辑),则需指定具体文件;若完全无副作用,可设为 false,这样即使模块被导入但未使用其导出,整个模块也可被移除。

{
"name": "my-lib",
"version": "1.0.0",
"sideEffects": false
}
当 sideEffects 为 false 时,打包工具会认为该包内所有文件均无副作用。此时,如果代码中没有任何 import 引用该包中的任何导出函数或变量,该包及其内部所有未使用的代码都将被视为死代码并从最终 bundle 中剔除。反之,如果设置了具体的副作用文件列表,如 ["src/polyfill.js"],则只有未引用的非副作用文件会被清理,而 polyfill.js 始终会被保留以确保全局环境正确。
立即学习“Java免费学习笔记(深入)”;
哪些代码会被判定为死代码
Tree Shaking 主要识别两类死代码:一是未被任何地方 import 的导出项,二是模块内部未被当前模块其他代码调用的局部函数或变量。关键在于“引用链”必须完整,只要有一个入口点引用了某个导出,该导出及其依赖的代码就会被保留。

// utils.js
export function used() { return 'used'; }
export function unused() { return 'unused'; } // 未被 import
// main.js
import { used } from './utils.js';
console.log(used());
在上述示例中,main.js 仅导入了 used 函数。打包工具在分析时会发现 unused 函数虽然被导出,但没有任何外部模块引用它,因此将其标记为死代码并移除。同时,如果 utils.js 内部存在一个未被 used 调用的辅助函数,且该辅助函数也不被其他导出项依赖,它同样会被剔除。这种基于引用关系的静态分析确保了最终输出的代码只包含实际运行所需的逻辑。
为什么 CommonJS 无法进行 Tree Shaking
CommonJS (CJS) 模块系统采用动态加载机制,其 require() 调用可以在运行时执行,甚至位于条件语句中,这使得静态分析工具无法在编译阶段确定模块的真实依赖关系。因此,打包工具无法安全地预测哪些导出项会被使用,从而无法进行有效的树摇优化。
// commonjs_example.js
const lib = require('./lib');
if (process.env.NODE_ENV === 'production') {
console.log(lib.prodFunc());
} else {
console.log(lib.devFunc());
}
在 CommonJS 模式下,require 返回的是一个对象快照,且加载时机不确定。即使 prodFunc 和 devFunc 中只有一个会被调用,打包工具也无法确定具体是哪一个,为了安全起见,它通常会保留整个模块的所有导出内容。相比之下,ESM 的 import 声明必须在模块顶层,且在解析阶段就确定了所有依赖,这为静态分析和死代码消除提供了坚实基础。


















