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) { /* ... */ }

export function formatNumber(num) { / ... / }

// src/index.js export from './utils/format'; export 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"]

合理设计打包输出格式

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

Android创建和使用数据库详细指南 中文WORD版
Android创建和使用数据库详细指南 中文WORD版

每个应用程序都要使用数据,Android应用程序也不例外,Android使用开源的、与操作系统无关的SQL数据库--SQLite,本文介绍的就是如何为你的Android应用程序创建和操作SQLite数据库。 数据库支持每个应用程序无论大小的生命线,除非你的应用程序只处理简单的数据,那么就需要一个数据库系统存储你的结构化数据,Android使用SQLite数据库,它是一个开源的、支持多操作系统的SQL数据库,在许多领域广泛使用,如Mozilla FireFox就是使用SQLite来存储配置数据的,iPhon

下载
  • 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。

相关专题

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

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

411

2023.08.07

json是什么
json是什么

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

532

2023.08.23

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

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

309

2023.10.13

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

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

74

2025.09.10

css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

511

2023.06.15

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

262

2023.07.27

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

752

2023.07.28

css超出显示...
css超出显示...

在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

537

2023.08.01

php与html混编教程大全
php与html混编教程大全

本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

3

2026.01.13

热门下载

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

精品课程

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

共14课时 | 0.8万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.9万人学习

CSS教程
CSS教程

共754课时 | 18.7万人学习

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

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