javascript tree shaking 打包体积没减小,通常是因为代码中包含了无法被静态分析的副作用(side effects)或模块导出方式不符合规范。要解决这个问题,需要检查 `package.json` 中的 `sideeffects` 配置、确保使用 es module (esm) 语法而非 commonjs,并排查是否引入了带有全局副作用的库。

如何正确配置 sideEffects 以允许移除未使用的纯模块
当 Webpack 等打包工具遇到一个模块时,如果不确定它是否有副作用,为了安全起见,它会保留该模块。通过配置 `sideEffects`,你可以明确告诉打包器哪些文件是“纯”的(即导入后除了导出变量外不执行其他操作),从而允许 Tree Shaking 移除这些未使用的文件。例如,如果你有一个只包含常量的文件 `constants.js`,且没有修改全局对象,就可以将其标记为无副作用。

{
"name": "my-app",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"build": "webpack --mode production"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"webpack": "^5.88.0",
"webpack-cli": "^5.1.4"
},
"dependencies": {
"lodash-es": "^4.17.21"
},
"sideEffects": false
}
在上面的 `package.json` 示例中,`"sideEffects": false` 表示项目中的所有文件都没有副作用。这意味着如果某个文件没有被导入,Webpack 可以安全地将其从最终包中剔除。如果你的项目中确实有 CSS 文件或某些脚本需要在全局运行(如 polyfills),则需要将它们列入数组,例如 `"sideEffects": ["*.css", "src/polyfill.js"]`。这样,未被引用的 JS 模块会被摇树优化,而 CSS 和 polyfill 会被保留。
为什么 CommonJS 模块会导致 Tree Shaking 失效
Tree Shaking 依赖于静态分析模块的依赖关系,这要求模块系统必须是静态的。CommonJS (CJS) 的 `require()` 是动态执行的,打包器在编译时无法确定它到底导出了什么,因此通常会保留整个模块。要将 CJS 转换为 ESM,需要将 `module.exports` 改为 `export`,将 `require()` 改为 `import`。此外,一些旧库可能只提供 CJS 接口,这时可以使用 `babel-plugin-module-resolver` 或在构建时进行转换,但最佳实践是直接依赖提供 ESM 版本的库。
使用 Husky 将 pre-commit、pre-push 和 commit-msg 检查集成到仓库中,以便代理和开发人员在更改离开工作站之前运行相同的本地防护措施。

// bad: CommonJS - 整个模块可能被保留
const _ = require('lodash');
console.log(_.isEmpty([]));
// good: ES Modules - 仅导入使用的函数
import isEmpty from 'lodash-es/isEmpty';
console.log(isEmpty([]));
// 或者命名空间导入(取决于打包器支持情况)
import * as _ from 'lodash-es';
console.log(_.isEmpty([]));
在上述代码中,使用 `lodash-es` 库并采用 ESM 语法导入,Webpack 可以精确分析出只使用了 `isEmpty` 函数,从而只打包该函数的代码,而不是整个 lodash 库。如果使用 `require('lodash')`,由于 CJS 的动态特性,Webpack 可能无法确定具体使用了哪些方法,导致整个库被打包进来。确保你的源代码和依赖项都尽可能使用 ESM 语法,是 Tree Shaking 生效的关键前提。
当引入第三方库时如何判断其是否支持 Tree Shaking
即使你正确配置了 `sideEffects` 并使用 ESM,如果引入的第三方库本身不支持 Tree Shaking,打包体积也不会减小。许多传统 npm 包只提供经过 Babel 转译的 CJS 代码,或者它们的 ESM 入口点指向的是整个库。你需要检查库的 `package.json`,查看是否有 `module` 字段指向 ESM 版本,以及该库是否声明了 `sideEffects`。对于不支持 Tree Shaking 的库,可以考虑寻找替代方案,或者使用按需加载的方式手动引入所需部分。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










