TreeShaking 与 SideEffect

Rollup 有很强大的程序流分析,从而可以大量移除冗余的、未被引用的代码,但是一些情况下 Rollup 为了保守起见,依然会保留这些代码,这些情况包括:

  1. import 的模块可能存在 side effect
  2. 引用的对象可能存在 side effect

参考以下的 FAQ tree-shaking-doesnt-seem-to-be-working

Example

最近我在实际的业务中就遇到了类似的情况,例如有 module-a.jsmodule-b.js 模块:

javascript 复制代码
// module-b.js
var EnumType
(function (EnumType) {
	EnumType['A'] = 'A';
})(EnumType)

export {
	EnumType
}
javascript 复制代码
// module-a.js
import { EnumType } from './module-b'

const dumbObjA = {
  type: EnumType.A
}

const dumbObjB = {
  type: 'B',
}

export function print() {
	console.log('hello')
}
javascript 复制代码
// main.js
import { print } from './module-a'

print()

表面上看 dumbObjAdumbObjB 都没有被引用,我们会期望 Rollup 打包之后的代码里 dumbObjAdumbObjB 都会被移除掉,但实际结果却是只有 dumbObjB 被清理掉,而 dumbObjA 以及 EnumType 都被保留了,这有些出乎意料:

javascript 复制代码
// Rollup 打包后的代码 index-XXX.js
var EnumType = /* @__PURE__ */ ((EnumType2) => {
  EnumType2["A"] = "A";
  return EnumType2;
})(EnumType || {});
({
  type: EnumType.A
});
function print() {
  console.log("hello");
}
print();

这正是上文所提及的:

引用的对象可能存在 side effect

由于 dumbObjA 的创建访问了 EnumType.A,Rollup 认为 EnumType.A 可能存在 side effect,因为 EnumType 是通过一个 IIFE(立即执行的函数表达式)创建的, EnumType.A 的访问可能触发 getter 从而执行一些 side effect 函数,为了保守起见,Rollup 保留的 dumbObjA 的代码。

作为开发者我们当然可以清楚地分辨出 EnumType.A 并没有 getter,可是 Rollup 并不如人聪明它无法分辨,因而为了保守起见它只能够保留这些可能有 side effect 的代码。

如果我们对 module-b.js 做一些修改,Rollup 才能够正确分辨出 EnumType 是没有 getter 的,可以放心清除掉它。

javascript 复制代码
// module-b.js
var EnumType = {
	A: 'A'
}

export {
	EnumType
}
javascript 复制代码
// Rollup 打包后的代码 index-XXX.js
function print() {
  console.log("hello");
}
print();

Why create EnumType using IIFE?

或许你会感到奇怪,如果一开始就不使用 IIFE 来创建 EnumType 的话,问题就不会存在。确实如此,但如果你使用的是 TS,而且不巧你用上了 TS 的 enum 关键字的话,那么最终 EnumType 就无可避免地被编译为 IIFE。至于为什么 TS 的 enum 为什么要编译成 IIFE,原因之一是 enum 支持声明合并的特性,这里也有些相关的讨论

typescript 复制代码
// module-b.ts
enum EnumType {
  A = 'A'
}

// 编译为 module-b.js
var EnumType
(function (EnumType) {
	EnumType['A'] = 'A';
})(EnumType)

export {
	EnumType
}

总结

长话短说,如果你是 TS 的开发者,而且你需要 TreeShaking 能够工作的话,考虑放弃 TS 的 enum 的使用。

References

相关推荐
烛阴1 小时前
Three.js 零基础入门:手把手打造交互式 3D 几何体展示系统
javascript·webgl·three.js
颜酱1 小时前
单调栈:从模板到实战
javascript·后端·算法
代码匠心2 小时前
AI 自动编程:一句话设计高颜值博客
前端·ai·ai编程·claude
_AaronWong3 小时前
Electron 实现仿豆包划词取词功能:从 AI 生成到落地踩坑记
前端·javascript·vue.js
cxxcode3 小时前
I/O 多路复用:从浏览器到 Linux 内核
前端
用户5433081441943 小时前
AI 时代,前端逆向的门槛已经低到离谱 — 以 Upwork 为例
前端
JarvanMo3 小时前
Flutter 版本的 material_ui 已经上架 pub.dev 啦!快来抢先体验吧。
前端
JohnYan3 小时前
工作笔记-CodeBuddy应用探索
javascript·ai编程·aiops
恋猫de小郭4 小时前
AI 可以让 WIFI 实现监控室内人体位置和姿态,无需摄像头?
前端·人工智能·ai编程
哀木4 小时前
给自己整一个 claude code,解锁编程新姿势
前端