JavaScript 中 Tree Shaking 怎么检查并避开副作用(Side Effects)污染导致的代码无法被清除

秋涛君_6364

秋涛君_6364

2026-08-28

418人浏览

原创

tree shaking 生效需模块为 es 模块且无副作用;副作用会导致死代码残留,可通过构建工具诊断、检查 sideeffects 字段、避免全局修改等手段识别和规避。

javascript 中 tree shaking 怎么检查并避开副作用(side effects)污染导致的代码无法被清除

Tree Shaking 能生效的前提是:模块必须是 ES 模块(import/export),且代码没有可观察的副作用。一旦 JavaScript 引擎或打包工具(如 Webpack、Rollup、Vite)认为某段代码可能产生副作用,它就会保守地保留该代码,哪怕你没显式调用它——这就导致本该被摇掉的死代码“污染”了整个 Tree Shaking 过程。

怎么检查副作用是否被误判?

最直接的方式是查看最终打包产物(如 dist/ 下的 bundle 文件),结合 source map 定位未被移除但本应删除的代码。更高效的做法是利用构建工具的诊断能力:

  • Webpack:开启 optimization.providedExports 和 optimization.usedExports,再配合 stats: "verbose" 或使用 webpack-bundle-analyzer 查看哪些 export 被标记为 “used” 或 “unused”;若某模块所有导出都标为 unused 却仍被打包进来,大概率是副作用触发了全量保留。
  • Rollup / Vite(底层 Rollup):启用 treeshake: { moduleSideEffects: false } 并配合 onwarn 钩子捕获 “Treeshaking unknown side effect in…” 类警告,这些就是工具无法静态分析、默认视为有副作用的语句(如 try/catch、with、eval、全局赋值等)。
  • 查看 package.json 的 "sideEffects" 字段:如果依赖包声明了 "sideEffects": false,表示整个包无副作用,可安全摇;若为数组(如 ["*.css", "index.js"]),则只对列表外的文件启用摇;若缺失或为 true,工具会默认整个包有副作用,跳过摇 —— 这是第三方库污染你项目的常见源头。

哪些写法会意外引入副作用?

不是只有 API 调用才算副作用。以下看似无害的操作,都会让工具放弃摇掉相关模块:

Java Maven Secondary Analysis
Java Maven Secondary Analysis

分析ZIP压缩包或GitLab仓库中的Java Maven项目,确定二次开发范围、类数量、模块分布及生产相关指标。

下载
  • 对全局对象的修改:例如 window.myLib = {...}、Array.prototype.myMethod = ...、console.log("init")(即使在模块顶层)。
  • import 但不使用:比如 import './polyfill.js' 或 import 'lodash-es' (后者因内部有顶层 this 判断等逻辑,默认被判定有副作用)。
  • 动态 import() + 字符串拼接:如 import(`./mod-${type}.js`),无法静态分析导入目标,整块逻辑会被保留。
  • try/catch 中的 import 或变量声明:控制流不可预测,工具无法保证 catch 块是否执行,倾向保留全部。
  • 带有 getter/setter 的 export 对象:如 export const obj = { get x() { return Math.random(); } },访问属性可能有副作用,工具不敢摇。

如何主动避开副作用污染?

核心原则:让模块“纯”起来,明确告诉打包器“这里没副作用”。

  • 把副作用逻辑抽离到单独入口:例如 polyfill、样式注入、全局监听器,统一放在 main.ts 或 entry-client.ts 中显式导入,其他业务模块保持 pure export。
  • 用 /*#__PURE__*/ 标记无副作用调用:如 /*#__PURE__*/ console.log("debug"),Webpack 5+ 和 Rollup 会识别并允许摇掉该语句(生产环境自动移除)。
  • 避免顶层副作用语句:把 localStorage.setItem、new Worker() 等移到函数内,仅在真正需要时执行。
  • 为自己的库正确配置 "sideEffects":在 package.json 中写明哪些文件有副作用(如 ["*.css", "dist/*.d.ts"]),其余设为 false;或者确保所有导出都是 pure 函数/常量。
  • 慎用第三方库的默认导入:改用具名导入(import { debounce } from 'lodash-es'),避免 import _ from 'lodash-es'(后者含大量副作用逻辑);必要时搭配 babel-plugin-lodash 自动转换。

验证是否成功:一个最小闭环

写一个测试模块:
src/utils/math.ts:

export const add = (a, b) => a + b;<br>export const PI = 3.14159;<br>console.log('math init'); // ← 这行会让整个模块无法被摇

在主文件中只 import add:

import { add } from './utils/math';<br>console.log(add(1, 2));

然后构建并搜索 dist 中是否还存在 math init 或 PI 字符串。如果存在,说明副作用未清除;删掉 console.log 再试,应完全消失。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

javascript java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4626

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1149

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4564

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

920

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1816

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3305

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4293

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2800

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

888

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习