0

0

如何构建一个支持Tree Shaking的通用工具库?

夜晨

夜晨

发布时间:2025-10-08 18:10:02

|

392人浏览过

|

来源于php中文网

原创

要构建支持 Tree Shaking 的工具库,需使用 ESM 语法、避免副作用、合理配置打包格式。核心是采用静态 import/export,每个函数单独文件导出,入口文件重新导出;在 package.json 中设置 "sideEffects": false(若有真实副作用则列出);通过 Rollup 输出 esm 和 cjs 格式;最后验证未引用函数是否被移除。

如何构建一个支持tree shaking的通用工具库?

要构建一个支持 Tree Shaking 的通用工具库,核心是确保未使用的代码在打包时能被静态分析工具(如 Webpack、Rollup 或 Vite)识别并移除。这要求你在项目结构、模块导出方式和打包配置上遵循特定规范。

使用 ES 模块语法

Tree Shaking 依赖于静态的 import / export 语法,因此必须使用 ES6 模块(ESM),而不是 CommonJS(require / module.exports)。

注意:如果混用 require 或动态导入,打包工具无法进行静态分析,Tree Shaking 将失效。
  • 每个工具函数单独定义在一个文件中
  • 使用 export 导出具体函数,避免默认导出或命名空间导出
  • 入口文件使用命名导出重新导出所有功能

示例:

// src/utils/format.js
export function formatDate(date) { /* ... */ }
<p>export function formatNumber(num) { /<em> ... </em>/ }</p><p>// src/index.js
export <em> from './utils/format';
export </em> from './utils/validate';

避免副作用

“副作用”指模块执行时除了导出值之外还产生其他行为(如修改全局变量、执行 console.log 等)。打包工具若检测到副作用,默认不会删除该模块,即使其中部分函数未被引用。

package.json 中声明 "sideEffects": false,告诉打包工具整个库无副作用,可安全进行 Tree Shaking。

{
  "name": "my-utils",
  "main": "dist/my-utils.cjs",
  "module": "dist/my-utils.esm.js",
  "sideEffects": false
}
  • 如果你的库包含 CSS 引入或 polyfill 等真实副作用,应将它们列在 sideEffects 数组中
  • 例如:"sideEffects": ["./src/polyfill.js", "*.css"]

合理设计打包输出格式

为了兼容不同环境,建议同时输出多种模块格式:

Insou AI
Insou AI

Insou AI 是一款强大的人工智能助手,旨在帮助你轻松创建引人入胜的内容和令人印象深刻的演示。

下载
  • ESM(.esm.js:保留 import/export,供支持 Tree Shaking 的现代打包工具使用
  • CommonJS(.cjs):供 Node.js 或旧版构建工具使用
  • 可选:UMD 格式用于浏览器直接引入

推荐使用 RollupVite 打包,天然对 Tree Shaking 友好。

Rollup 配置示例(rollup.config.js):

export default [
  {
    input: 'src/index.js',
    output: {
      file: 'dist/my-utils.esm.js',
      format: 'esm'
    }
  },
  {
    input: 'src/index.js',
    output: {
      file: 'dist/my-utils.cjs',
      format: 'cjs'
    }
  }
]

发布前验证 Tree Shaking 效果

构建完成后,应手动测试 Tree Shaking 是否生效。

  • 创建一个测试项目,只引入库中的某个函数:import { formatDate } from 'my-utils'
  • 使用 Webpack 或 Vite 构建该项目,并查看生成的 bundle
  • 确认未引用的函数(如 formatNumber)没有出现在最终代码中

也可使用工具如 webpack-bundle-analyzer 分析打包体积,辅助判断。

基本上就这些。只要保证 ESM 导出、无副作用声明、合理打包配置,你的工具库就能被消费端有效 Tree Shaking。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

549

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

337

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

es6新特性
es6新特性

es6新特性有:1、块级作用域变量;2、箭头函数;3、模板字符串;4、解构赋值;5、默认参数;6、 扩展运算符;7、 类和继承;8、Promise。本专题为大家提供es6新特性的相关的文章、下载、课程内容,供大家免费下载体验。

106

2023.07.17

es6新特性有哪些
es6新特性有哪些

es6的新特性有:1、块级作用域;2、箭头函数;3、解构赋值;4、默认参数;5、扩展运算符;6、模板字符串;7、类和模块;8、迭代器和生成器;9、Promise对象;10、模块化导入和导出等等。本专题为大家提供es6新特性的相关的文章、下载、课程内容,供大家免费下载体验。

197

2023.08.04

JavaScript ES6新特性
JavaScript ES6新特性

ES6是JavaScript的根本性升级,引入let/const实现块级作用域、箭头函数解决this绑定问题、解构赋值与模板字符串简化数据处理、对象简写与模块化提升代码可读性与组织性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

233

2025.12.24

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

510

2023.11.27

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

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

共14课时 | 0.9万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

CSS教程
CSS教程

共754课时 | 43.2万人学习

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

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