0

0

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

舞姬之光

舞姬之光

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

|

139人浏览过

|

来源于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免费学习笔记(深入)”;

甲骨文AI协同平台
甲骨文AI协同平台

专门用于甲骨文研究的革命性平台

下载
  • "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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

565

2023.06.20

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

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

443

2023.07.04

js四舍五入
js四舍五入

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

803

2023.07.04

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

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

494

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

678

2023.09.04

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

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

1140

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

674

2023.09.12

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

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

562

2023.09.20

Python WebSocket实时通信与异步服务开发实践
Python WebSocket实时通信与异步服务开发实践

本专题聚焦 Python 在实时通信场景中的开发实践,系统讲解 WebSocket 协议原理、长连接管理、消息推送机制以及异步服务架构设计。内容包括客户端与服务端通信实现、连接稳定性优化、消息队列集成及高并发处理策略。通过完整案例,帮助开发者构建高效稳定的实时通信系统,适用于聊天应用、实时数据推送等场景。

7

2026.03.18

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 6.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.7万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号