JavaScript 中 Tree Shaking 怎么配置 sideEffects

落宇小哥_9032

落宇小哥_9032

2026-09-16

567人浏览

原创

sideeffects配置是tree shaking生效的关键前提,它明确声明哪些文件含副作用必须保留,否则打包工具会保守保留全部代码导致摇树失效;支持false(全纯净)、文件数组(精准标记副作用)和不配置(等价true,禁用摇树)三种方式。

javascript 中 tree shaking 怎么配置 sideeffects

Tree Shaking 要真正生效,sideEffects 配置是关键一环。它不是可选的“锦上添花”,而是告诉打包工具“哪些文件哪怕没被导入,也必须保留”的安全声明。

为什么必须配 sideEffects?

ES 模块本身支持静态分析,但构建工具无法自动判断一个文件是否“只是导出函数”还是“顺带执行了全局操作”。比如:

  • import './styles.css' —— 没导出任何东西,但注入了样式(副作用)
  • import 'core-js/stable' —— 自动补丁浏览器 API(副作用)
  • window.myLib = {...} 在模块顶层执行(副作用)

如果不声明,Webpack 或 Rollup 会保守处理:宁可留着所有代码,也不冒险删掉有副作用的文件——结果就是 Tree Shaking 失效。

Java Development Manual
Java Development Manual

Java开发手册规约集合,基于阿里巴巴Java开发手册(嵩山版)。 涵盖7大维度:编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约。 当用户需要:(1) 编写或审查Java代码 (2) 检查命名/代码规范 (3) 处理异常和日志 (4) 编写单元测试 (5) 安全编码 (6) 数据库设...

下载

三种 sideEffects 写法及适用场景

在项目根目录的 package.json 中配置:

  • "sideEffects": false:表示整个包完全纯净,没有任何副作用。适合纯工具库(如 lodash-es、自研的 utils 库)。一旦设为 false,所有未使用导出都会被删除,连 CSS、字体、polyfill 都会被清掉——用前务必确认。
  • "sideEffects": ["*.css", "*.scss", "src/polyfills.js"]:最常用、最推荐的方式。只列出真正有副作用的文件或 glob 模式。CSS 文件、SVG 字体、全局初始化脚本都应列在这里。
  • 不写 sideEffects 字段:等价于 "sideEffects": true,构建工具默认认为每个文件都可能有副作用,Tree Shaking 基本不工作。

常见错误与避坑点

这些细节容易导致样式丢失、功能异常,却很难排查:

  • CSS 文件路径匹配要准确:"*.css" 可匹配 src/a.csslib/b.css;但 "src/**/*.css" 就不会匹配 node_modules/xxx/style.css
  • 第三方库的副作用由它自己的 package.json 控制。如果你用了不带 sideEffects: false 的旧版库,它的全部代码都会被保留,哪怕你只 import 了一个函数。
  • 动态导入(import())和 require() 不受 sideEffects 管控,也无法被 Tree Shaking 分析,尽量避免在需摇树的模块中混用。
  • Vite 或 Next.js 默认读取 package.jsonsideEffects,但 Webpack 还需确保 mode: 'production' 且未手动关闭 optimization.sideEffects(默认开启)。

验证是否生效的小技巧

改完配置后别急着上线,快速验证一下:

  • src/index.js 中只 import 一个函数,比如 import { debounce } from './utils',不引入其他导出;
  • 运行 npx webpack --mode=production --devtool=source-map
  • 打开生成的 dist/main.js,搜索未引入的函数名(如 throttle),确认它没出现在最终代码里;
  • 再检查 dist 下是否存在 CSS 文件——如果存在,说明 sideEffects 中的 "*.css" 生效了。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.06.20

4026

5

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

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

2023.07.04

1029

3

js四舍五入
js四舍五入

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

2023.07.04

3924

6

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

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

2023.09.01

820

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1696

5

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

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

2023.09.04

2965

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

3853

6

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

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

2023.09.20

2440

5

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

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

2023.09.20

808

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 11.9万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.5万人学习