0

0

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

狼影

狼影

发布时间:2025-09-29 15:07:16

|

214人浏览过

|

来源于php中文网

原创

答案是构建支持Tree-shaking的工具库需使用ES模块语法、合理组织代码结构并配置打包工具。具体包括:采用export单独导出函数,避免默认或聚合导出;每个函数独立文件存放,入口文件仅重新导出;通过Rollup或Vite生成ESM格式产物;在package.json中设置module字段指向ESM入口,并声明sideEffects以辅助摇树优化。

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

构建一个支持 Tree-shaking 的通用工具库,核心在于让打包工具(如 Webpack、Rollup)能静态分析模块结构,只打包实际用到的代码。实现这一点需要从模块格式、构建配置和代码组织方式上综合设计。

使用 ES 模块语法(ESM)

Tree-shaking 能生效的前提是模块必须使用 import / export 语法,而非 CommonJS 的 require / module.exports

说明:
  • 确保所有工具函数使用 export 单独导出,避免默认导出或对象聚合导出。
  • 例如:每个工具函数单独导出,而不是集中在一个对象里导出。

推荐写法:

export function add(a, b) {
  return a + b;
}

export function subtract(a, b) { return a - b; }

避免写法:

const utils = {
  add(a, b) { return a + b; },
  subtract(a, b) { return a - b; }
};
export default utils;

合理组织项目结构与入口文件

为了让 Tree-shaking 更高效,应采用“按需导入”友好的目录结构。

  • 将每个工具函数放在独立文件中,如 src/add.jssrc/subtract.js
  • 主入口文件(index.js)仅做重新导出,不聚合逻辑。

示例 src/index.js

export { add } from './add';
export { subtract } from './subtract';

这样用户可以这样导入:

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

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

下载
import { add } from 'your-utils'; // 只引入 add,其余可被摇掉

配置打包工具输出 ESM 格式

即使源码用了 ESM,最终发布到 npm 的包也需提供 ESM 构建产物。

建议使用 Rollup 或 Vite 构建:
  • 生成一份 ESM 格式的构建文件,如 dist/your-utils.esm.js
  • package.json 中通过 module 字段指向 ESM 入口:
{
  "main": "dist/your-utils.cjs.js",
  "module": "dist/your-utils.esm.js",
  "exports": {
    ".": {
      "import": "./dist/your-utils.esm.js",
      "require": "./dist/your-utils.cjs.js"
    }
  }
}

现代打包工具优先读取 moduleexports.import,从而启用 Tree-shaking。

避免副作用(sideEffects)

某些代码会导致模块有“副作用”,使打包工具不敢摇掉未引用的代码。

  • 避免在模块顶层执行可能产生副作用的操作,如修改全局对象、注册事件等。
  • 若确实没有副作用,在 package.json 中声明:
"sideEffects": false

如果有部分文件有副作用(如样式注入),可列出文件路径:

"sideEffects": ["./dist/style.js"]

基本上就这些。只要坚持使用 ESM、合理拆分导出、提供标准构建产物,并正确配置 package.json,你的工具库就能天然支持 Tree-shaking,提升下游项目的构建效率。

相关专题

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

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

403

2023.08.07

json是什么
json是什么

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

528

2023.08.23

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

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

307

2023.10.13

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

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

74

2025.09.10

require的用法
require的用法

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

457

2023.11.27

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

508

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

241

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

249

2023.08.03

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

74

2025.12.31

热门下载

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

精品课程

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

共58课时 | 3.2万人学习

Pandas 教程
Pandas 教程

共15课时 | 0.9万人学习

ASP 教程
ASP 教程

共34课时 | 3.1万人学习

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

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