【译】Google - 使用 webpack 进行 web 性能优化(三):监控和分析应用

前端工程师 @ 上海阅文信息技术有限公司

即使你可以通过配置 webpack 使得应用尽可能小,追踪它并且知道它包含什么仍然是很重要的。否则,你可能安装了一个让应用大了两倍的依赖却浑然不觉。

这节就来讲几个可以帮助你深入分析 bundle 的工具。

追踪 bundle 的大小

为了监控你的应用大小,可以在开发过程中使用 webpack-dashboard 和在 CI 上使用 bundlesize

webpack-dashboard

webpack-dashboard 增强了 webpack 的输出,包含依赖的大小、进度和其他细节。这是它的界面:

这个看板帮助追踪大的依赖 —— 如果你增加了一个依赖,那么你就能够立刻在 Modules 部分中看到它。

要想使用它,需要安装依赖包 webpack-dashboard :

npm install webpack-dashboard --save-dev
复制代码

然后在 webpack.config.js 文件中的 plugins 字段里增加这个 plugin:

// webpack.config.js
const DashboardPlugin = require('webpack-dashboard/plugin');

module.exports = {
  plugins: [
    new DashboardPlugin(),
  ],
};
复制代码

如果你使用基于 express 的服务,也可以使用 compiler.apply():

compiler.apply(new DashboardPlugin());
复制代码

尽情地使用 dashboard 来找到可能优化的地方吧!举个例子,纵览 Modules 部分可以找到过大的库,然后用相对小的库来替代掉它。

bundlesize

bundlesize 校验 webpack 的资源有没有超过指定的大小。将它集成到 CI 中,就可以在应用过大的时候收到提醒。

配置:

确定大小上限

  1. 先优化应用,让它尽可能小,然后运行生产环境构建;

  2. package.json 中增加 bundlesize 字段的配置,如下:

    // package.json
    {
      "bundlesize": [
        {
          "path": "./dist/*"
        }
      ]
    }
    复制代码
  3. npx 执行 bundlesize:

    npx bundlesize
    复制代码

    将打印出每个文件 gzip 过后的大小

    PASS  ./dist/icon256.6168aaac8461862eab7a.png: 10.89KB
    PASS  ./dist/icon512.c3e073a4100bd0c28a86.png: 13.1KB
    PASS  ./dist/main.0c8b617dfc40c2827ae3.js: 16.28KB
    PASS  ./dist/vendor.ff9f7ea865884e6a84c8.js: 31.49KB
    复制代码
  4. 在每个文件大小的基础上增加 10-20%,就可以得到大小上限。这 10%-20% 的 buffer 可以保证既不妨碍你日常开发,又可以在它的体积增长过快的时候向你报警。

启用 bundlesize

  1. 安装 bunlesize 包作为开发依赖:

    npm install bundlesize --save-dev
    复制代码
  2. package.jsonbundlesize 字段里,指定具体的大小上限,对于有的文件(例如图片),你可能需要为特定的文件类型设置上限,而不是每个文件。

    // package.json
    {
      "bundlesize": [
        {
          "path": "./dist/*.png",
          "maxSize": "16 kB",
        },
        {
          "path": "./dist/main.*.js",
          "maxSize": "20 kB",
        },
        {
          "path": "./dist/vendor.*.js",
          "maxSize": "35 kB",
        }
      ]
    }
    复制代码
  3. 增加 npm 脚本来运行检查。

    // package.json
    {
      "scripts": {
        "check-size": "bundlesize"
      }
    }
    复制代码
  4. 配置好 CI ,以便在每次 push 的时候运行 npm run check-size (如果你在 github 上开发项目的话还可以在 github 中集成 bundlesize)。

就是这样!现在如果你运行 npm run check-size 或者 push 代码,你会看到输出文件是否足够小。

如果是失败的情况:

扩展阅读:

分析 bundle 为什么这么大

你可能想要深入研究 bundle,来分析哪些模块占用了空间。请看 webpack-bundle-analyzer:

(Screen recording from github.com/webpack-con…)

webpack-bundle-analyzer 扫描 bundle 并且建立一个可视化的结果展示它包含什么,通过该可视化界面可以去找大的或者不必要的依赖。

要使用 analyzer,需要安装 webpack-bundle-analyzer

npm install webpack-bundle-analyzer --save-dev
复制代码

在 webpack 配置文件里增加一个 plugin。

// webpack.config.js
const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin;

module.exports = {
  plugins: [
    new BundleAnalyzerPlugin(),
  ],
};
复制代码

然后运行 production build,插件会在浏览器里打开一个统计的页面。

默认情况下,统计页面展示的是解析过后的文件大小。(即出现在 bundle 里的文件),你可能想要比较 gzip 压缩之后的大小,因为这会更接近真实用户的体验。可以在侧边栏切换大小类型。

⭐️注意 : 如果你使用 ModuleConcatenationPlugin,一部分在 webpack-bundle-analyzer 输出的模块可能会被合并,使得报告的信息量减少。所以如果你在用这个插件,在分析的过程中需要将它禁用掉。

以下是希望从报告中得到的信息:

  • 大的依赖 为什么他们那么大?是否有更小的替代品(例如 Preact 代替 React)?你是否需要其中的全部代码?(例如,Moment.js 包含很多并不常使用并可以扔掉的本地化语言环境 )

  • 重复的依赖 你是否在多个文件里看到相同的依赖?(使用像 webpack4 中的 optimization.splitChunks.chunks 选项或者 webpack3 中的 CommonsChunkPlugin 来将他们移到一个公共文件里)或者 bundle 是否包含了同一个库的多个版本?

  • 相似的依赖 是否有相似的库做着差不多的事情?(例如 commentdate-fns 或者 lodashlodash-es)试着统一成单一的工具。

同时,建议看一下 Sean Larkin 的 great analysis of webpack bundles

总结

  • 使用 webpack-dashboard 和 bundlesize 来持续关注你的应用大小。
  • webpack-bundle-analyzer 来深究应用大小的构成

结论

总结:

  • 减少不必要的字节。 压缩所有资源,去除无用代码,谨慎添加依赖。
  • 通过路由分离代码。 只加载当前真正需要的资源,其他的资源延迟加载。
  • 缓存代码。 应用中某部分代码的更新频率比其他部分低。可以将这部分代码剥离,以便只在必要时重新加载。
  • 持续关注应用大小。 使用像 webpack-dashboardwebpack-bundle-analyzer 这类的工具来了解应用的大小。然后每隔几个月重新检查一下应用的性能。

Webpack 不是唯一一个可以帮助你让应用变得更快的工具。还可以考虑让你的应用变成一个渐进式 web 应用(Progressive Web App),从而获得更好的体验,并且使用像 Lighthouse 这样的自动分析工具来获得改进意见。

别忘了去阅读 webpack 文档 - 那里还有大量有用的信息。

同时记得用 training 项目来练习哦!

更多分享,请关注YFE:

上一篇:译】Google - 使用 webpack 进行 web 性能优化(二):利用好持久化缓存

文章分类
前端