你构建的代码为什么这么大

本文作者：文西

前言

代码体积的控制对前端来说至关重要，尽管网络条件逐渐变好，但是代码体积的增加不仅仅只影响资源加载速度，还会直接或间接影响浏览器各类性能指标。

例如增加用户内存使用消耗，内存的增加又会更频繁的触发 V8 引擎的 GC 机制，进而影响页面交互性能。

本文从一个典型的 Webpack+Babel 工程出发，找到构建产物体积变大的常见原因和对应的解决思路，减少项目代码构建后的体积

Babel

babel 最常见的用途就是代码降级，使构建后的代码能够被低版本浏览器兼容，按照功能可以划分两部分

1. API 降级
2. 语法降级

通过 Babel 构建后的代码为了适配低版本浏览器通常会比源代码大上几倍，这里面除了源代码外还包含 API 垫片和语法辅助函数，分别对应上诉的 API 降级和语法降级，我们看下如何减少这部分的代码体积

core-js

按照目前最新版本的 babel@7，@babel/polyfill 已经废弃，我们使用 core-js 完成 API 的语法降级

core-js 可以为浏览器中可能不兼容的 API 提供垫片，例如 Promise，Map

import "core-js/modules/es.promise.js";

// 使用降级 API
const promise = Promise.resolve();

在需要降级的 API 调用前 require 对应的 core-js 模块，就可以以污染全局变量或者原型链的方式实现 API 降级

手动插入 core-js 即麻烦又不安全，所以我们可以使用@babel/preset-env帮助我们自动插入 core-js 模块

@babel/preset-env根据项目中 browserlist 定义的用户环境，选择性插入垫片代码，减少垫片代码体积

在配置@babel/preset-env 时，useBuiltIns 属性非常重要，有两个值"entry"|"usage"，分别为全量降级和按需降级

entry 全量降级

entry 非常直接，首先我们需要手动在代码的第一行import 'core-js'，在执行编译时，会按照 browserlist 中定义的环境，把可能需要降级的 API 一次性插入并替换到 core-js 声明的位置

开发者不再需要手动插入垫片，但这有个问题，即没有使用的 API 仍然会被打进 bundle 中，由于 ECMAScript 标准的不断发展，core-js 在 g-zip 压缩后也有 50kb 左右的体积，显然还是太大了

usage 按需降级

当选择 usage 时，babel 会扫描所有需要编译的 JS 代码，根据实际使用到的 API 选择性插入所需垫片

看起来是相比 entry 的更优解，但实际过于理想

1. 通常基于编译速度的考虑，node_modules 下的模块不会参与 Babel 编译，仅参与 Webpack 打包，如果此时恰巧某个依赖包里没有声明所需的垫片，那么就可能出现垫片缺失，最终导致线上环境 JS 运行异常。

   实际上这种情况在混乱的 npm 生态中非常普遍，有不少 npm 包直接使用 tsc 打包，除非开发者手动介入，否则构建产物中就会缺少 API 垫片，遇到这种情况往往只能在线上发现异常后手动添加依赖到babel.include中进行编译

2. 并不是所有 JS 代码都会参与编译，例如通过一些平台动态下发的脚本，这些平台动态下发的代码完全不经过编译，如果使用了未经降级的 api 也可能会出现 JS 运行异常。

可以看到 entry，usage 都是存在问题的，所以也就有了平台化的方案，polyfill.io。

如果使用最新的现代化浏览器访问该服务，那么返回的 JS 内容则是空的，反之它会响应浏览器所需的降级 API，既控制了包体积，也能确保未经编译的 JS 获得降级 API。

出于安全考虑，我们需要自部署服务，目前 polyfill.io 的 node.js 代码是完全开源的，支持自部署，但是实际落地还需要考虑缓存和异常兜底

@babel/runtime

core-js 是为了解决 API 降级问题存在的，但是我们还有语法降级需要解决，例如 class，async

默认情况下 babel 为了实现 class 功能会生成一些内联辅助函数，例如下图的 createClass。这会产生一个问题，就是当多个模块都使用 class 语法时则会生成多个相同的辅助函数，辅助函数不能复用

我们可以通过注册 babel 插件@babel/plugin-transform-runtime，将硬编码辅助函数的方式改为从@babel/runtime引入辅助函数，实现不同模块间辅助函数的复用

从下图可以看到 createClass 函数从硬编码改为require("@babel/runtime/helpers/createClass")，代码大幅缩小

但是@babel/plugin-transform-runtime的方案也不是毫无问题，和 api 降级一样，同样面临各种依赖包构建不标准带来的困扰

最大的问题就是没有办法保证依赖包的产物一定使用了@babel/plugin-transform-runtime进行构建，语法降级使用了内联的辅助函数，又或者使用了老版本的babel-runtime·，导致项目最终的构建产物对辅助函数进行了多次打包

以相对常见的依赖包构建工具 father-build 和 tsc 为例，他们都没有将语法辅助函数通过@babel/runtime依赖包进行提取，而是都以硬编码的形式存在每个 JS 模块当中。

这类由社区维护的 npm 包我们不好处理，但是可以通过收敛公司内部构建工具的方式，统一处理公司内部维护的依赖包，使它们构建的产物符合应用打包的需求，我们在文章结尾处再说

Tree-shaking

tree-shaking 是减少构建产物体积最有效的方式，以常用 lodash 为例，g-zip 后的体积 24kb，但是项目中使用到的函数并不多，如果能够为它启用 tree-shaking，代码体积能控制在 1kb 以内

如何为依赖代码启用 tree-shaking？

1. package.json 声明 module 字段，地址指向 ESM 规范的构建产物
2. package.json 声明sideEffects:false，告诉 Webpack 整个依赖包没有存在副作用，或者指明存在副作用模块的地址

ESM

ESM 相比 commonjs 具备静态分析能力， 这是 tree-shaking 的前置依赖条件，所以我们需要 babel 构建我们的源代码时保留 import 语法，不要编译成 commonjs

{
  "presets": [
    [
      "@babel/preset-env",
      {
        "modules": false // 保留ESM语法
      }
    ]
  ]
}

sideEffects

为什么依赖包的 package.json 需要声明 sideEffects？

这里需要引申出自函数式编程中的纯函数和副作用函数概念，如果我们的代码没有存在任何副作用，tree-shaking 确实可以不需要类似 sideEffects 的副作用声明，但实际上副作用普遍存在我们的代码中，如果只依据函数是否被引用过作为 DCE(Dead Code Elimination) 的条件，很容易影响程序运行的正确性

通过 css-loader 引入 css 文件是很典型的例子

import "./button.css";

对于 webpack 来说 button.css 同样是一个模块，这里没有引用任何的具名函数，但是引入 css 模块是会为我们带来一个副作用，它会为 html 插入一个 style 标签。如果 webpack 认为他是没有副作用的，那么在 minify 阶段 webpack 会删除这行代码，最终导致样式错乱

为了告诉 webpack 这个 css 文件是存在副作用的，不能删除，sideEffects 就可以怎么写

{
  "sideEffects": ["*.css", "*.less"]
}

公司内部维护的依赖相比开源社区，很容易忽略sideEffects的声明，如果存在公司内部的依赖构建工具，可以将sideEffects添加到相关的模板代码中，默认为依赖包开启 tree-shaking

回到社区现状我们再来看 tree-shaking，lodash 推出了支持 tree-shaking 的lodash-es，antd@4 也不再需要安装babel-plugin-import插件，可以通过 tree-shaking 的方式原生支持代码按需加载，从而大幅缩小构建体积

Duplicate dependencies 重复依赖

依赖重复打包是前端开发中的常见问题，容易出现在公司内部长期无人维护的依赖包中

当我们的项目中存在 Root→C→[email protected]，Root→B→[email protected]类似的依赖关系时，node_module 结构如下

node_modules
  -- C <-- depends on [email protected]
  -- [email protected]
  -- B <-- depends on [email protected]
    -- node_modules
      -- [email protected]

可以看到在 node_modules 下嵌套安装了 2 个版本的依赖 D，即[email protected]，[email protected]。这可能导致在构建的产物中也同样存在两份相同依赖不同版本的代码，除了会影响代码体积，还可能导致代码运行异常

解决方式是升级 B 的依赖[email protected]→[email protected]，此时重新安装后node_modules的嵌套结构会恢复扁平

node_modules
  -- C <-- depends on [email protected]
  -- [email protected]
  -- B <-- depends on [email protected]

我们可以使用find-duplicate-dependencies和webpack-bundle-analyzer这些工具辅助我们排查依赖重复打包的问题

最佳实践

回顾文章我们对一个典型前端应用可能影响 Bundle 体积的因素进行了分析，同时提出对应的解决方案。在文章的结尾我们可以更进一步通过工程化和平台化的手段，以相对一劳永逸的方式解决上诉问题

如下图，@company/app-builder负责构建应用，@company/module-builder负责构建依赖包，然后通过使用封装的 babel 配置@company/babel-base，统一处理 JS 编译

babel-base关闭 core-js 的 api 降级，由 app-builder 开启平台 polyfill.io 方案，同时babel-base开启@babel/plugin-transform-runtime，为应用和依赖包启用语法辅助函数抽离

module-builder关闭 ESM 语法的转换，为app-builder做 tree-shaking 时提供必要前置条件

通过这种方式，我们就可以实现在构建过程中减少代码体积的最佳实践

至于重复依赖的问题，由于必定需要开发者介入做版本选择，所以我们可以考虑在部署平台构建时自动上报 Dependency graph 数据，然后由性能分析等平台将重复依赖的问题邮件抄送给相关开发者进行优化

总结

本文从构建工具的角度，阐述了如何减少构建产物的体积。可以看到仅仅处理应用的构建是不够的，为了实现最佳效果，我们还需要介入公司内部依赖包的构建，使依赖包的构建产物符合应用构建的需求。只有具备全场景的构建能力才能最大程度降低代码的构建体积。

参考资料

• https://docs.npmjs.com/cli/v8...
• https://babeljs.io/docs/en/ba...
• https://babeljs.io/docs/en/ba...
• https://babeljs.io/docs/en/ba...
• https://webpack.js.org/guides...
• https://cdn.polyfill.io/v3/

本文发布自网易云音乐技术团队，文章未经授权禁止任何形式的转载。我们常年招收各类技术岗位，如果你准备换工作，又恰好喜欢云音乐，那就加入我们 grp.music-fe(at)corp.netease.com！