JavaScript Tree Shaking 中怎么在 package.json 中声明 sideEffects

千芳君_8135

千芳君_8135

2026-10-09

756人浏览

原创

sideeffects 字段用于声明模块是否有副作用,false 表示全无副作用,数组可指定有副作用的文件(如 css),true 或未声明则默认全有副作用,影响 tree shaking 效果。

javascript tree shaking 中怎么在 package.json 中声明 sideeffects

在 JavaScript 的 Tree Shaking 过程中,package.json 中的 sideEffects 字段用于告诉打包工具(如 Webpack、Rollup、Vite)哪些模块**没有副作用**,从而安全地移除未使用的导出。

什么是 sideEffects?

副作用(side effect)指模块在被导入时,除了导出变量外,还执行了其他影响运行时的行为,比如:

  • 修改全局变量或原型链(如 Array.prototype.map = ...)
  • 调用 require 或 import 动态加载资源
  • 发起网络请求、操作 DOM、设置定时器
  • 直接执行有影响的代码(如立即执行函数 IIFE)

如果一个模块没有副作用,打包器才能放心地“摇掉”其中未被引用的导出(例如只用了 utils.js 中的 filter,没用 map,就可删掉 map 的定义)。

如何在 package.json 中声明 sideEffects

sideEffects 是一个布尔值或字符串数组,写在项目根目录的 package.json 中:

  • "sideEffects": false:表示整个包的所有模块都无副作用。这是最激进、Tree Shaking 效果最好的写法,适用于纯函数式工具库(如 lodash-es 的部分用法)。⚠️ 仅当确认所有模块都不含副作用时才用。
  • "sideEffects": ["*.css", "*.scss"]:表示只有匹配这些 glob 模式的文件有副作用(比如 CSS 导入会触发样式注入),其余 JS 文件默认无副作用。这是常见且推荐的做法,尤其适合组件库或带样式资源的包。
  • "sideEffects": ["./src/entry.js", "./styles/index.css"]:精确列出有副作用的入口文件路径(支持相对路径和 glob)。
  • "sideEffects": true(默认行为):不声明该字段,或显式设为 true,表示所有模块都有副作用,Tree Shaking 将被大幅限制(可能只对 ES 模块语法做基础分析)。

实际建议与注意事项

如果你是库作者或维护一个可被他人引入的 npm 包:

Java Maven Secondary Analysis
Java Maven Secondary Analysis

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

下载
  • 优先使用 "sideEffects": ["*.css", "*.scss", "*.less"],覆盖样式资源;JS 文件若只做导出、无全局污染,就默认视为无副作用。
  • 避免把有副作用的逻辑写在模块顶层(如 console.log('init')、localStorage.setItem),否则即使写了 "sideEffects": false,也可能导致错误剔除或运行异常。
  • 确保你的源码是 ESM(export/import)格式,CommonJS(module.exports)不支持 Tree Shaking。
  • Vite 和 Webpack 5+ 原生支持该字段;旧版 Webpack 需开启 optimization.sideEffects: true(默认已启用)。

一个典型示例

假设你开发了一个 UI 组件库,结构如下:

my-ui/
├── package.json
├── index.js          // 导出所有组件,同时 import './style.css'
├── style.css
├── Button.js         // 纯导出,无副作用
└── utils/format.js   // 纯函数,无副作用

对应 package.json 可写:

"sideEffects": ["./index.js", "./style.css"]

或者更稳妥地:

"sideEffects": ["*.css", "index.js"]

这样,用户只引入 import { Button } from 'my-ui' 时,utils/format.js 中未用到的函数就能被摇掉,style.css 仍会被保留(因为声明了有副作用)。

不复杂但容易忽略 —— 一行 sideEffects 声明,往往能显著减小最终包体积。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.06.20

4646

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

4584

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

3325

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4313

6

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

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

2023.09.20

2820

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