讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

AniShort
AniShort

AI短剧协同制作平台

Seko
Seko

AI短剧一键生成成片

立刻MV
立刻MV

低成本歌曲 MV、视频生成

JavaScript中模块化中的副作用Side-Effects声明

落敏酱_3167

落敏酱_3167

发布时间:2026-03-18 19:58:03

|

159人浏览过

|

来源于php中文网

原创

sideEffects 是构建工具用于标识模块副作用的字段,避免 tree-shaking 错误移除影响环境的代码;支持 false、文件 glob、具体路径或 true 等声明形式,需谨慎配置以防功能缺失或样式丢失。

javascript中模块化中的副作用side-effects声明

在 JavaScript 模块化中,sideEffects 是一个用于构建工具(如 Webpack、Rollup)的提示字段,告诉打包器哪些模块具有“副作用”,从而避免在摇树优化(tree-shaking)过程中被错误地移除。

什么是副作用(Side Effects)?

副作用指模块在被导入时,除了导出变量/函数外,还会执行一些影响外部环境的操作,例如:

  • 修改全局变量或原型链(如 Array.prototype.myMethod = ...)
  • 向 DOM 添加节点、监听事件或触发样式计算
  • 发起网络请求、设置定时器、写入 localStorage
  • 调用 console 或 alert 等产生可观测行为的 API

这类代码不能被单纯依据“是否被 import 引用”来判断是否可删除——即使某个模块没被显式使用,只要它有副作用,就必须保留执行。

如何声明 sideEffects?

在项目的 package.json 中添加 sideEffects 字段,支持以下几种形式:

立即学习“Java免费学习笔记(深入)”;

modern-javascript-patterns
modern-javascript-patterns

掌握 ES6+ 特性,包括 async/await、解构、扩展运算符、箭头函数、Promise、模块、迭代器、生成器以及函数式编程模式,编写简洁高效的 Java

下载
  • "sideEffects": false:表示整个包无副作用,所有未引用的导出均可安全剔除(最激进,适合纯函数式工具库)
  • "sideEffects": ["*.css", "*.scss"]:仅声明特定文件类型有副作用(常见于样式文件需强制引入)
  • "sideEffects": ["./src/polyfill.js", "./src/init.js"]:精确列出有副作用的模块路径
  • "sideEffects": true(默认行为):不提供线索,构建工具保守处理,不进行深度 tree-shaking

注意:路径匹配基于项目根目录,且支持 glob 模式;若使用相对路径,需确保与实际导入路径一致。

常见误用与注意事项

声明不当会导致两种典型问题:

  • 误标为 false:模块实际有副作用(如自动注册全局组件),却被剔除,运行时报错或功能缺失
  • 漏标副作用文件:比如 CSS 文件未列入 sideEffects,而构建工具又启用了模块化 CSS 提取,则样式可能丢失
  • ESM 与 CJS 混用时失效:某些工具对 CommonJS 模块的副作用分析较弱,建议统一使用 ESM 并配合正确的 type: "module"

可通过构建后检查产物或启用 Webpack 的 stats: "verbose" 查看哪些模块被标记为“有副作用”。

与 /*#__PURE__*/ 注释的区别

sideEffects 是模块粒度的声明,作用于整个文件;而 /*#__PURE__*/ 是语句级提示,用于标记单个函数调用可被安全移除(如 /*#__PURE__*/console.log("test"))。两者目标不同,可配合使用,但不可替代。

热门AI工具

更多
Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

函子Zion

一款支持AI搭建、可视化编辑和多端发布的全栈无代码开发平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3909

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2528

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1460

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1398

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1456

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2478

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

4160

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

19995

2023.09.22

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

40

2026.11.12

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.5万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn