javascript tree shaking 标记函数副作用的核心做法是向 package.json 的 sideeffects 字段提供数组,列出包含副作用的文件路径。当该值为 false 时,构建工具会假设所有模块都是纯函数并安全地移除未使用代码;若为具体文件列表,则仅对不在列表中的模块执行摇树优化。这一机制直接决定了打包后代码的体积和运行时的正确性。

如何配置 sideEffects 以启用或禁用全局副作用
在 package.json 中设置 sideEffects 可以控制整个包的摇树行为。如果包内没有任何全局副作用(如修改原型链、注册全局变量),可以将值设为 false,这样构建工具就能大胆地删除所有未被引用的导出函数。反之,如果包内有全局生效的代码,必须将其路径列入数组,防止被误删。

{
"name": "my-utils",
"version": "1.0.0",
"sideEffects": false
}
上述配置表示该包完全无副作用,任何未使用的导入都会被剔除。若存在全局样式或脚本,需改为:
{
"name": "my-ui-lib",
"version": "1.0.0",
"sideEffects": ["./src/styles.css", "./src/global.js"]
}
此时,styles.css 和 global.js 始终会被打包,而其他未引用的 JS 模块仍可被优化。开发者需确保列表中的路径与导入路径一致,否则优化可能失效或导致运行时错误。
如何处理单文件内的局部副作用
当副作用仅存在于某个特定文件中,且该文件可能被部分引用时,需在 sideEffects 数组中明确指定该文件。这允许其他模块正常被摇树,同时保留该文件的完整执行逻辑。关键在于识别哪些操作会在模块加载时立即产生效果,例如调用 fetch 发起请求或修改 Array.prototype。

// src/polyfill.js
// 这是一个有副作用的文件
if (!Array.prototype.flat) {
Array.prototype.flat = function() { ... };
}
export const helper = () => {};
在 package.json 中:
{
"sideEffects": ["./src/polyfill.js"]
}
即使项目中没有导入 helper,只要引入了 polyfill.js,其中的副作用代码就会执行。若未将该文件列入 sideEffects,且未使用其导出,构建工具可能会将其完全移除,导致 polyfill 失效。因此,准确标记这些文件是保证兼容性的必要步骤。
基于 sideEffects 标记对未使用导出的影响
当 sideEffects 正确配置后,未使用的导出函数将被彻底从最终 bundle 中移除。这意味着即使函数定义复杂,只要没有被任何入口点直接或间接引用,且所在文件未被标记为有副作用,它就不会出现在输出结果中。这种优化不仅减小了体积,还减少了解析和执行开销。
// src/math.js export const add = (a, b) => a + b; export const subtract = (a, b) => a - b; // 未使用
若 package.json 中 sideEffects 为 false 或未包含 math.js,且项目中仅使用了 add,则 subtract 不会被打包。但若 math.js 中有全局副作用并被列入 sideEffects,则整个文件会被保留,包括 subtract,因为无法确定移除部分代码是否会破坏副作用逻辑。因此,标记的粒度直接影响优化效果。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南











