JavaScript Tree Shaking 中怎么在模块中正确配置无副作用声明

酷雪大大_1210

酷雪大大_1210

2026-10-05

269人浏览

原创

关键是要在package.json中声明sideeffects: false或精确列出有副作用的文件,确保模块无顶层副作用,并配合/#__pure__/注释辅助压缩器移除无副作用调用,最终通过构建产物验证未使用导出是否被标记为unused harmony export并消失。

javascript tree shaking 中怎么在模块中正确配置无副作用声明

要在 JavaScript Tree Shaking 中让模块被安全“摇掉”,关键不是在代码里加开关,而是向打包工具明确传达:这个模块没有副作用。否则,即使函数没被引用,工具也会保守保留整块代码。

在 package.json 中统一声明 sideEffects

这是最常用也最推荐的方式,作用于整个包:

  • "sideEffects": false —— 表示所有 JS 文件都无副作用(纯计算、无全局修改、无 DOM 操作、无网络请求),打包器可放心剔除未引用的导出
  • "sideEffects": ["*.css", "*.scss", "src/init.js"] —— 只列出真正有副作用的文件或资源类型,其余 JS 模块默认可摇
  • 不写该字段,或设为 true,等同于告诉工具“每个文件都可能有副作用”,Tree Shaking 基本失效

避免模块顶层执行副作用代码

即使声明了 sideEffects: false,若模块顶部直接运行代码,仍会破坏摇树效果:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • ❌ 错误写法:模块一加载就执行 console.log('init')、Object.assign(window, {...})、document.addEventListener(...)
  • ✅ 正确做法:把副作用逻辑封装进函数,再按需调用;或移入单独文件(如 src/polyfill.js),并在 sideEffects 数组中显式保留
  • 例如:export function initPolyfill() { ... } + /*#__PURE__*/ initPolyfill()(配合压缩阶段优化)

单文件内用 /*#__PURE__*/ 注释标记调用

该注释不改变模块是否被保留,但能辅助压缩器(如 Terser)在最终阶段移除或内联特定调用:

  • 必须紧贴函数调用左侧,中间不能换行:/*#__PURE__*/ doCalc(1, 2)
  • 仅适用于真正无副作用的场景:纯数学运算、console.log(仅日志)、简单常量初始化
  • ⚠️ 注意:它不解决模块级保留问题,必须和 sideEffects 配合使用才完整

验证是否生效

别只看配置,要检查输出结果:

  • 构建后打开 bundle 文件,搜索未使用的函数名,确认不存在
  • Webpack 用户可查是否有 /* unused harmony export xxx */ 标记
  • 用 rollup-plugin-visualizer 或 webpack-bundle-analyzer 查依赖图,观察未引用模块是否消失

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

4526

5

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

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

2023.07.04

1129

3

js四舍五入
js四舍五入

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

2023.07.04

4444

6

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

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

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1796

5

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

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

2023.09.04

3265

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4233

6

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

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

2023.09.20

2740

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万人学习