# Tree Shaking 定义
- 利用 ES Module 可以进行静态分析的特点来检测模块内容的导出、导入以及被使用的情况,保留 Live Code。
- Rollup 对 Tree-shaking 的定义已经不仅仅是 ES Module 相关,此外它还支持了 DCE -- 消除不会被执行和没有副作用(Side Effect) 的 Dead Code,即 DCE 过程。
- Tree Shaking 指基于 ES Module 进行静态分析,通过 AST 将用不到的函数进行移除,从而减小打包体积。
- 与代码压缩不同,代码压缩主要是移除模块内部的无效代码,而 Tree Shaking 则是移除模块之间未使用的导出。
# 原理
- ESM 要求所有的导入导出语句只能出现在模块顶层,且导入导出的模块名必须为字符串常量,所以,ESM 下模块之间的依赖关系是高度确定的,与运行状态无关,编译工具只需要对 ESM 模块做静态分析,就可以从代码字面量中推断出哪些模块值未曾被其它模块使用,这是实现 Tree Shaking 技术的必要条件。
- webpack5 已经自带了这个功能了,当打包环境为
production: true
时,默认开启tree-shaking
功能。
# 在 Webpack 中实现 Tree Shaking 的原理
Webpack 中,Tree-shaking 的实现一是「先标记出模块导出值中哪些没有被用过」,二是「使用 Terser、UglifyJS 等 DCE 工具删掉这些没被用到的导出语句」。标记过程大致可划分为三个步骤:
- Make (构建)阶段,收集模块导出变量并记录到模块依赖关系图 ModuleGraph 变量中
- Seal (封装阶段),遍历 ModuleGraph 标记模块导出变量有没有被使用
- 生成产物时,若变量没有被其它模块使用则删除对应的导出语句
# 详细一点
Webpack 中 Tree Shaking 的实现分为如下步骤:
- 在
FlagDependencyExportsPlugin
插件中根据模块的 dependencies 列表收集模块导出值,并记录到 ModuleGraph 体系的exportsInfo
中; - 在
FlagDependencyUsagePlugin
插件中收集模块的导出值的使用情况,并记录到exportInfo._usedInRuntime
集合中; - 在
HarmonyExportXXXDependency.Template.apply
方法中根据导出值的使用情况生成不同的导出语句; - 使用 DCE(Terser、UglifyJS 等)工具删除 Dead Code,实现完整的树摇效果。
# 使用
- 使用>= ES2015 模块语法(即 import 和 export)
- 确保没有编译器将 ES2015 模块语法转换为 CommonJS 的(这是现在常用的@babel/preset-env 的默认行为)
- 在项目的 package.json 文件中,添加
"sideEffects": "false"
属性 - 使用
mode: "production"
的配置项以启用更多优化项,包括压缩代码与 tree shaking
# 在 Webpack 中启动 Tree Shaking
在 Webpack 中,启动 Tree Shaking 功能必须同时满足三个条件:
使用 ESM 规范编写模块代码 - 绝对的大前提
配置
optimization.usedExports = true
,启动标记功能 -(在开发环境启动 Tree Shaking)启动代码优化功能,可以通过如下方式实现:
- 配置
mode = production
- 在 Webpack5 中,Tree Shaking 在生产环境下默认启动 - 配置
optimization.minimize = true
-(在开发环境启动 Tree Shaking) - 提供
optimization.minimizer
数组 -(在开发环境启动 Tree Shaking)
- 配置
# tips 实践
- 当使用语法
import *
时,Tree Shaking 依然生效。 - Tree Shaking 甚至可对 JSON 进行优化。原理是因为 JSON 格式简单,通过 AST 容易预测结果,不像 JS 对象有复杂的类型与副作用。
- 为了减小生产环境体积,我们可以使用一些支持 ES 的 package,比如使用
lodash-es
/babel-plugin-lodash
替代lodash
。 - 我们可以在 npm.devtool.tech (opens new window)中查看某个库是否支持 Tree Shaking。
- 使用
/*#__PURE__*/
标注纯函数调用:在调用语句前添加/*#__PURE__*/
备注,明确告诉 Webpack 该次函数调用并不会对上下文环境产生副作用 - 禁止 Babel 转译模块导入导出语句:Babel 可以将
import/export
风格的 ESM 语句等价转译为 CommonJS 风格的模块化语句,但该功能却导致 Webpack 无法对转译后的模块导入导出内容做静态分析 - 优化导出值的粒度:比如 default 导出了一个包含多个属性/值的对象,即使实际上只用到导出值的其中一个属性,整个 default 对象依然会被完整保留。所以实际开发中,应该尽量保持导出值颗粒度和原子性
- 避免无意义的赋值,原因参考缺陷如下
# 缺陷
Webpack 的 Tree Shaking 逻辑停留在代码静态分析层面,只是浅显地判断:
- 模块导出变量是否被其它模块引用;
- 引用模块的主体代码中有没有出现这个变量。
没有进一步,从语义上分析模块导出值是不是真的被有效使用。
# 总结
综上,Tree-Shaking 是一种只对 ESM 有效的 Dead Code Elimination 技术,它能够自动删除无效(没有被使用,且没有副作用)的模块导出变量,优化产物体积。不过,受限于 JavaScript 语言灵活性所带来的高度动态特性,Tree-Shaking 并不能完美删除所有无效的模块导出,需要我们在业务代码中遵循若干最佳实践规则,帮助 Tree-Shaking 更好地运行。