JS 中怎么用 sideEffects: false 彻底释放无副作用库的 Tree Shaking 能力

冬明酱_7316

冬明酱_7316

2026-10-26

252人浏览

原创

"sideEffects": false 是 Tree Shaking 关键前提,但需配合纯模块写法、正确构建配置(Webpack/Vite/Rollup 启用相关选项)、按需导入及第三方库适配,才能彻底剔除未用代码。

js 中怎么用 sideeffects: false 彻底释放无副作用库的 tree shaking 能力

直接在 package.json 里写 "sideEffects": false 是关键一步,但光靠它不够——必须配合模块写法、构建配置和导入方式,才能真正让未使用的代码被整块剔除。

确保所有 JS 模块真正“无副作用”

副作用指模块顶层执行时产生的外部影响,比如:
– 修改全局对象(Array.prototype.map = ...)
– 发起请求或监听事件(fetch('/init') 在顶层调用)
– 注入样式(import './index.css')
– 执行初始化逻辑(initI18n() 直接调用)
只要存在这类行为,整个文件就会被保留,哪怕你只用了其中一个小函数。

建议:
– 把副作用逻辑抽离到单独文件(如 polyfill.js 或 global.css)
– 其余工具类、工具函数保持纯导出,不执行任何操作
– 导出全部使用具名形式:export const format = () => {},避免 export default + 聚合导出混合使用

正确配置 package.json 的 sideEffects 字段

"sideEffects": false 表示:项目中所有 JS 文件默认无副作用,可安全删除未引用部分。
但如果有例外,必须显式列出,否则副作用文件可能被误删:

  • 全局样式:加 "*.css" 或 "src/styles/index.scss"
  • 垫片脚本:加 "src/polyfill.js"
  • 字体/图标资源:加 "*.woff" 等资源路径(如果 loader 会触发副作用)

注意:
– 数组里的路径支持 glob,如 "*.css" 等价于 "**/*.css"
– 不要写 "sideEffects": [],空数组会被视为“全部有副作用”

Json Repair Kit
Json Repair Kit

使用 Node.js 评估修复格式错误的 JSON,自动纠正尾随逗号、单引号、未加引号的键等常见问题,实现文件规范化。

下载

构建工具需启用对应能力

Webpack 和 Vite 默认在 production 模式下开启 Tree Shaking,但仍需确认关键配置:

  • Webpack:确保 mode: 'production',无需额外设 usedExports(5+ 版本已内置)
  • Vite:默认启用,若用自定义 Rollup 配置,检查 treeshake.moduleSideEffects 是否为 false
  • Rollup:确认 treeshake: { moduleSideEffects: false } 已启用

第三方库若自身 package.json 声明了 "sideEffects": false,说明它已适配——你按需导入时,它的未用模块也会被摇掉。

导入方式决定能否真正“按需”

即使库本身支持 Tree Shaking,错误的引入方式仍会让整包保留:

  • ❌ 错误:import _ from 'lodash' → 全量引入,摇不动
  • ✅ 正确:import { debounce } from 'lodash-es'(推荐 lodash-es)
  • ✅ 正确:import { createApp } from 'vue'(Vue 3 ESM 版本)
  • ⚠️ 警惕:export * from './utils' 可能阻断分析,尤其当 ./utils 本身有副作用时

自己写的库对外发布时,记得在 package.json 中设置:
"module": "dist/index.esm.js",并确保该文件是 ES Module 格式输出。

相关专题

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

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

2023.06.20

5226

5

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

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

2023.07.04

1289

3

js四舍五入
js四舍五入

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

2023.07.04

5164

6

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

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

2023.09.01

980

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1916

5

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

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

2023.09.04

3665

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4773

6

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

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

2023.09.20

3120

5

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

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

2023.09.20

1008

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.3万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习