此页面由 Cloud Translation API 翻译。

利用长期缓存

webpack 如何帮助缓存资源

Ivan Akulov

要缩短应用加载时间，其次是缓存（在优化应用大小之后）。您可以使用它将应用的某些部分保留在客户端上，以免每次都重新下载这些部分。

使用 bundle 版本控制和缓存标头

执行缓存的常用方法是：

指示浏览器将文件缓存很长时间（例如一年）：
```
# Server header
Cache-Control: max-age=31536000
```
如果您不熟悉 Cache-Control 的用途，请参阅 Jake Archibald 的关于缓存最佳实践的优秀博文。

并在文件发生更改时重命名该文件，以强制重新下载：

<!-- Before the change -->
<script src="./index-v15.js"></script>

<!-- After the change -->
<script src="./index-v16.js"></script>

此方法会告知浏览器下载 JS 文件、将其缓存并使用缓存的副本。只有在文件名发生更改（或一年过去后），浏览器才会访问网络。

使用 webpack 时，您也可以执行相同的操作，但要指定文件哈希，而不是版本号。如需将哈希添加到文件名中，请使用 [chunkhash]：

// webpack.config.js
module.exports = {
  entry: './index.js',
  output: {
    filename: 'bundle.[chunkhash].js' // → bundle.8e0d62a03.js
  }
};

如果您需要文件名以将其发送到客户端，请使用 HtmlWebpackPlugin 或 WebpackManifestPlugin。

HtmlWebpackPlugin 是一种简单但灵活性较低的方法。在编译期间，此插件会生成包含所有已编译资源的 HTML 文件。如果您的服务器逻辑不复杂，那么以下步骤应该足以满足您的需求：

<!-- index.html -->
<!DOCTYPE html>
<!-- ... -->
<script src="bundle.8e0d62a03.js"></script>

WebpackManifestPlugin 是一种更灵活的方法，如果您的服务器部分比较复杂，此方法会非常有用。在构建期间，它会生成一个 JSON 文件，其中包含不带哈希的文件名与带有哈希的文件名之间的映射。在服务器上使用以下 JSON 来确定要处理哪个文件：

// manifest.json
{
  "bundle.js": "bundle.8e0d62a03.js"
}

深入阅读

Jake Archibald 关于缓存最佳实践

将依赖项和运行时解压缩到单独的文件中

依赖项

应用依赖项的更改频率往往低于实际应用代码。如果您将它们移至单独的文件中，浏览器将能够单独缓存它们，并且不会在每次应用代码更改时重新下载它们。

如需将依赖项提取到单独的代码块中，请执行以下三个步骤：

将输出文件名替换为 [name].[chunkname].js：
```
// webpack.config.js
module.exports = {
  output: {
    // Before
    filename: 'bundle.[chunkhash].js',
    // After
    filename: '[name].[chunkhash].js'
  }
};
```
Webpack 构建应用时，它会将 [name] 替换为分块的名称。如果不添加 [name] 部分，我们就必须根据分块的哈希值来区分分块，这很难！
将 entry 字段转换为对象：
```
// webpack.config.js
module.exports = {
  // Before
  entry: './index.js',
  // After
  entry: {
    main: './index.js'
  }
};
```
在此代码段中，“main”是一段代码的名称。此名称将取代第 1 步中的 [name]。

现在，如果您构建应用，此代码块将包含整个应用代码，就像我们之前没有完成这些步骤一样。但这很快就会发生变化。

在 webpack 4 中，将 optimization.splitChunks.chunks: 'all' 选项添加到 webpack 配置中：

// webpack.config.js (for webpack 4)
module.exports = {
  optimization: {
    splitChunks: {
      chunks: 'all'
    }
  }
};

此选项会启用智能代码拆分功能。有了它，如果供应商代码的大小超过 30 KB（在缩减和 gzip 之前），webpack 就会提取该代码。它还会提取通用代码，如果您的 build 会生成多个 bundle（例如将应用拆分为路由），这非常有用。

在 webpack 3 中，添加 CommonsChunkPlugin：

// webpack.config.js (for webpack 3)
module.exports = {
  plugins: [
    new webpack.optimize.CommonsChunkPlugin({
    // A name of the chunk that will include the dependencies.
    // This name is substituted in place of [name] from step 1
    name: 'vendor',

    // A function that determines which modules to include into this chunk
    minChunks: module => module.context && module.context.includes('node_modules'),
    })
  ]
};

此插件会获取路径中包含 node_modules 的所有模块，并将其移至名为 vendor.[chunkhash].js 的单独文件中。

进行这些更改后，每个 build 将生成两个文件，而不是一个：main.[chunkhash].js 和 vendor.[chunkhash].js（对于 webpack 4，为 vendors~main.[chunkhash].js）。对于 Webpack 4，如果依赖项较小，系统可能不会生成供应商软件包，这没关系：

$ webpack
Hash: ac01483e8fec1fa70676
Version: webpack 3.8.1
Time: 3816ms
                        Asset      Size  Chunks             Chunk Names
 ./main.00bab6fd3100008a42b0.js   82 kB       0  [emitted]  main
./vendor.d9e134771799ecdf9483.js  47 kB       1  [emitted]  vendor

浏览器会分别缓存这些文件，并仅重新下载更改的代码。

Webpack 运行时代码

很抱歉，仅提取供应商代码是不够的。如果您尝试更改应用代码中的某些内容：

// index.js
…
…

// E.g. add this:
console.log('Wat');

您会注意到 vendor 哈希也会发生变化：

                           Asset   Size  Chunks             Chunk Names
./vendor.d9e134771799ecdf9483.js  47 kB       1  [emitted]  vendor

↓

                            Asset   Size  Chunks             Chunk Names
./vendor.e6ea4504d61a1cc1c60b.js  47 kB       1  [emitted]  vendor

之所以发生这种情况，是因为除模块代码之外，Webpack 软件包还具有运行时，也就是用于管理模块执行的一小段代码。将代码拆分为多个文件后，这段代码会开始包含分块 ID 与相应文件之间的映射：

// vendor.e6ea4504d61a1cc1c60b.js
script.src = __webpack_require__.p + chunkId + "." + {
    "0": "2f2269c7f0a55a5c1871"
}[chunkId] + ".js";

Webpack 会将此运行时包含在最后生成的代码块中，在本例中为 vendor。每当任何分块发生变化时，这段代码也会发生变化，从而导致整个 vendor 分块发生变化。

为了解决此问题，我们将运行时移至单独的文件中。在 webpack 4 中，可通过启用 optimization.runtimeChunk 选项来实现此目的：

// webpack.config.js (for webpack 4)
module.exports = {
  optimization: {
    runtimeChunk: true
  }
};

在 webpack 3 中，可以通过使用 CommonsChunkPlugin 创建额外的空分块来实现此目的：

// webpack.config.js (for webpack 3)
module.exports = {
  plugins: [
    new webpack.optimize.CommonsChunkPlugin({
      name: 'vendor',
      minChunks: module => module.context && module.context.includes('node_modules')
    }),
    // This plugin must come after the vendor one (because webpack
    // includes runtime into the last chunk)
    new webpack.optimize.CommonsChunkPlugin({
      name: 'runtime',
      // minChunks: Infinity means that no app modules
      // will be included into this chunk
      minChunks: Infinity
    })
  ]
};

这些更改后，每个构建将生成三个文件：

$ webpack
Hash: ac01483e8fec1fa70676
Version: webpack 3.8.1
Time: 3816ms
                            Asset     Size  Chunks             Chunk Names
   ./main.00bab6fd3100008a42b0.js    82 kB       0  [emitted]  main
 ./vendor.26886caf15818fa82dfa.js    46 kB       1  [emitted]  vendor
./runtime.79f17c27b335abc7aaf4.js  1.45 kB       3  [emitted]  runtime

将它们以相反的顺序添加到 index.html 中，即可完成：

<!-- index.html -->
<script src="./runtime.79f17c27b335abc7aaf4.js"></script>
<script src="./vendor.26886caf15818fa82dfa.js"></script>
<script src="./main.00bab6fd3100008a42b0.js"></script>

深入阅读

关于长效缓存的 Webpack 指南
关于 webpack 运行时和清单的 Webpack 文档
“充分利用 CommonsChunkPlugin”
optimization.splitChunks 和 optimization.runtimeChunk 的运作方式

内嵌 webpack 运行时，用于保存额外的 HTTP 请求

为了进一步优化，请尝试将 webpack 运行时内嵌到 HTML 响应中。也就是说，不要使用以下代码：

<!-- index.html -->
<script src="./runtime.79f17c27b335abc7aaf4.js"></script>

请执行以下操作：

<!-- index.html -->
<script>
!function(e){function n(r){if(t[r])return t[r].exports;…}} ([]);
</script>

运行时很小，内联将帮助您保存 HTTP 请求（对于 HTTP/1 来说非常重要；对于 HTTP/2 来说不太重要，但可能仍会起作用）。

以下是操作方法。

如果您使用 HtmlWebpackPlugin 生成 HTML

如果您使用 HtmlWebpackPlugin 生成 HTML 文件，只需使用 InlineSourcePlugin 即可：

const HtmlWebpackPlugin = require('html-webpack-plugin');
const InlineSourcePlugin = require('html-webpack-inline-source-plugin');

module.exports = {
  plugins: [
    new HtmlWebpackPlugin({
      inlineSource: 'runtime~.+\\.js',
    }),
    new InlineSourcePlugin()
  ]
};

如果您使用自定义服务器逻辑生成 HTML

使用 webpack 4：

添加 WebpackManifestPlugin 以了解运行时分块的生成名称：

// webpack.config.js (for webpack 4)
const ManifestPlugin = require('webpack-manifest-plugin');

module.exports = {
  plugins: [
    new ManifestPlugin()
  ]
};

使用此插件的 build 会创建一个如下所示的文件：

// manifest.json
{
  "runtime~main.js": "runtime~main.8e0d62a03.js"
}

以便捷的方式内嵌运行时分块的内容。例如，使用 Node.js 和 Express：

// server.js
const fs = require('fs');
const manifest = require('./manifest.json');
const runtimeContent = fs.readFileSync(manifest['runtime~main.js'], 'utf-8');

app.get('/', (req, res) => {
  res.send(`
    …
    <script>${runtimeContent}</script>
    …
  `);
});

或者，使用 webpack 3：

通过指定 filename 将运行时名称设为静态：

module.exports = {
  plugins: [
    new webpack.optimize.CommonsChunkPlugin({
      name: 'runtime',
      minChunks: Infinity,
      filename: 'runtime.js'
    })
  ]
};

以方便的方式内嵌 runtime.js 内容。例如，使用 Node.js 和 Express：

// server.js
const fs = require('fs');
const runtimeContent = fs.readFileSync('./runtime.js', 'utf-8');

app.get('/', (req, res) => {
  res.send(`
    …
    <script>${runtimeContent}</script>
    …
  `);
});

您目前不需要的延迟加载代码

有时，网页上会有一些重要性不等的部分：

如果您在 YouTube 上加载视频页面，则更关心视频，而不是评论。在这里，视频比评论更重要。
如果您在新闻网站上打开一篇文章，您会更关心文章内容，而不是广告。在这种情况下，文字比广告更重要。

在这种情况下，请首先只下载最重要的内容，稍后再延迟加载其余部分，从而提高初始加载性能。为此，请使用 import() 函数和code-splitting：

// videoPlayer.js
export function renderVideoPlayer() { … }

// comments.js
export function renderComments() { … }

// index.js
import {renderVideoPlayer} from './videoPlayer';
renderVideoPlayer();

// …Custom event listener
onShowCommentsClick(() => {
  import('./comments').then((comments) => {
    comments.renderComments();
  });
});

import() 指定您要动态加载特定模块。当 webpack 看到 import('./module.js') 时，会将此模块移至单独的代码块中：

$ webpack
Hash: 39b2a53cb4e73f0dc5b2
Version: webpack 3.8.1
Time: 4273ms
                            Asset     Size  Chunks             Chunk Names
      ./0.8ecaf182f5c85b7a8199.js  22.5 kB       0  [emitted]
   ./main.f7e53d8e13e9a2745d6d.js    60 kB       1  [emitted]  main
 ./vendor.4f14b6326a80f4752a98.js    46 kB       2  [emitted]  vendor
./runtime.79f17c27b335abc7aaf4.js  1.45 kB       3  [emitted]  runtime

并且仅在执行到达 import() 函数时才下载它。

这将使 main 软件包变小，缩短初始加载时间。此外，它还将改善缓存，如果您更改主块中的代码，注释块不会受到影响。

注意：如果使用 Babel 编译此代码，您将遇到语法错误，因为 Babel 无法直接理解 import()。为避免出现此错误，请添加 syntax-dynamic-import 插件。

深入阅读

import() 函数的 Webpack 文档
用于实现 import() 语法的 JavaScript 提案

将代码拆分为路由和页面

如果您的应用有多个路线或页面，但只有一个 JS 文件包含相应代码（单个 main 分块），那么您很可能在每个请求中都提供了额外的字节。例如，当用户访问您网站的主页时：

他们无需加载代码来呈现其他网页上的报道，但会加载报道。此外，如果用户始终只访问首页，而您更改了文章代码，webpack 会使整个软件包失效，并且用户必须重新下载整个应用。

如果我们将应用拆分为多个页面（或路由，如果是单页应用），用户将只下载相关代码。此外，浏览器将更好地缓存应用代码：如果您更改了首页代码，webpack 只会使相应的分块失效。

对于单页应用

如需按路由拆分单页应用，请使用 import()（请参阅“延迟加载您目前不需要的代码”部分）。如果您使用的是框架，它可能已经提供了此问题的解决方案：

react-router 文档中的“代码分块”（适用于 React）
vue-router 文档中的“延迟加载路由”（适用于 Vue.js）

对于传统的多页面应用

如需按页面拆分传统应用，请使用 webpack 的入口点。如果您的应用有三种页面：首页、文章页面和用户账号页面，则应有三条条目：

// webpack.config.js
module.exports = {
  entry: {
    home: './src/Home/index.js',
    article: './src/Article/index.js',
    profile: './src/Profile/index.js'
  }
};

对于每个入口文件，webpack 都会构建一个单独的依赖项树，并生成一个仅包含该入口文件使用的模块的软件包：

$ webpack
Hash: 318d7b8490a7382bf23b
Version: webpack 3.8.1
Time: 4273ms
                            Asset     Size  Chunks             Chunk Names
      ./0.8ecaf182f5c85b7a8199.js  22.5 kB       0  [emitted]
   ./home.91b9ed27366fe7e33d6a.js    18 kB       1  [emitted]  home
./article.87a128755b16ac3294fd.js    32 kB       2  [emitted]  article
./profile.de945dc02685f6166781.js    24 kB       3  [emitted]  profile
 ./vendor.4f14b6326a80f4752a98.js    46 kB       4  [emitted]  vendor
./runtime.318d7b8490a7382bf23b.js  1.45 kB       5  [emitted]  runtime

因此，如果只有文章页面使用 Lodash，home 和 profile 软件包将不会包含它，并且用户在访问首页时也不必下载此库。

不过，单独的依赖项树也有缺点。如果两个入口点使用 Lodash，并且您尚未将依赖项移到供应商软件包中，则两个入口点都将包含 Lodash 的副本。如需解决此问题，请在 webpack 4 中将 optimization.splitChunks.chunks: 'all' 选项添加到 webpack 配置中：

// webpack.config.js (for webpack 4)
module.exports = {
  optimization: {
    splitChunks: {
      chunks: 'all'
    }
  }
};

此选项可启用智能代码分块。使用此选项后，webpack 会自动查找通用代码并将其提取到单独的文件中。

或者，在 webpack 3 中，使用 CommonsChunkPlugin，它会将常见依赖项移至指定的新文件中：

module.exports = {
  plugins: [
    new webpack.optimize.CommonsChunkPlugin({
      name: 'common',
      minChunks: 2    // 2 is the default value
    })
  ]
};

您可以随意调整 minChunks 值，以找到最佳值。一般来说，您应将其保持在较小水平，但如果分块数量增加，则应相应增加。例如，对于 3 个分块，minChunks 可能为 2，但对于 30 个分块，则可能是 8；如果将其保持为 2，则会有太多模块进入通用文件，导致它被过度膨胀。

深入阅读

有关入口点概念的 Webpack 文档
关于 CommonsChunkPlugin 的 Webpack 文档
“充分利用 CommonsChunkPlugin”
optimization.splitChunks 和 optimization.runtimeChunk 的运作方式

使模块 ID 更稳定

构建代码时，webpack 会为每个模块分配一个 ID。稍后，这些 ID 会在软件包内的 require() 中使用。在 build 输出中，ID 通常位于模块路径前面：

$ webpack
Hash: df3474e4f76528e3bbc9
Version: webpack 3.8.1
Time: 2150ms
                           Asset      Size  Chunks             Chunk Names
      ./0.8ecaf182f5c85b7a8199.js  22.5 kB       0  [emitted]
   ./main.4e50a16675574df6a9e9.js    60 kB       1  [emitted]  main
 ./vendor.26886caf15818fa82dfa.js    46 kB       2  [emitted]  vendor
./runtime.79f17c27b335abc7aaf4.js  1.45 kB       3  [emitted]  runtime

↓ 点击此处

[0] ./index.js 29 kB {1} [built]
[2] (webpack)/buildin/global.js 488 bytes {2} [built]
[3] (webpack)/buildin/module.js 495 bytes {2} [built]
[4] ./comments.js 58 kB {0} [built]
[5] ./ads.js 74 kB {1} [built]
+ 1 hidden module

默认情况下，系统使用计数器计算 ID（即第一个模块的 ID 为 0，第二个模块的 ID 为 1，依此类推）。这样做的问题在于，当您添加新模块时，它可能会显示在模块列表中间，从而更改所有后续模块的 ID：

$ webpack
Hash: df3474e4f76528e3bbc9
Version: webpack 3.8.1
Time: 2150ms
                           Asset      Size  Chunks             Chunk Names
      ./0.5c82c0f337fcb22672b5.js    22 kB       0  [emitted]
   ./main.0c8b617dfc40c2827ae3.js    82 kB       1  [emitted]  main
 ./vendor.26886caf15818fa82dfa.js    46 kB       2  [emitted]  vendor
./runtime.79f17c27b335abc7aaf4.js  1.45 kB       3  [emitted]  runtime
   [0] ./index.js 29 kB {1} [built]
   [2] (webpack)/buildin/global.js 488 bytes {2} [built]
   [3] (webpack)/buildin/module.js 495 bytes {2} [built]

↓ 我们添加了一个新模块…

[4] ./webPlayer.js 24 kB {1} [built]

↓ 看看它做了什么！comments.js 现在的 ID 为 5，而非 4

[5] ./comments.js 58 kB {0} [built]

↓ ads.js 现在的 ID 为 6，而非 5

[6] ./ads.js 74 kB {1} [built]
       + 1 hidden module

这样一来，包含或依赖于 ID 已更改的模块的所有区块都会失效，即使其实际代码并未更改也是如此。在本例中，0 分块（包含 comments.js 的分块）和 main 分块（包含其他应用代码的分块）都被失效了，而实际上应该只有 main 分块失效。

要解决此问题，请使用 HashedModuleIdsPlugin 更改模块 ID 的计算方式。它会将基于计数器的 ID 替换为模块路径的哈希值：

$ webpack
Hash: df3474e4f76528e3bbc9
Version: webpack 3.8.1
Time: 2150ms
                           Asset      Size  Chunks             Chunk Names
      ./0.6168aaac8461862eab7a.js  22.5 kB       0  [emitted]
   ./main.a2e49a279552980e3b91.js    60 kB       1  [emitted]  main
 ./vendor.ff9f7ea865884e6a84c8.js    46 kB       2  [emitted]  vendor
./runtime.25f5d0204e4f77fa57a1.js  1.45 kB       3  [emitted]  runtime

↓ 点击此处

[3IRH] ./index.js 29 kB {1} [built]
[DuR2] (webpack)/buildin/global.js 488 bytes {2} [built]
[JkW7] (webpack)/buildin/module.js 495 bytes {2} [built]
[LbCc] ./webPlayer.js 24 kB {1} [built]
[lebJ] ./comments.js 58 kB {0} [built]
[02Tr] ./ads.js 74 kB {1} [built]
    + 1 hidden module

采用这种方法时，只有在您重命名或移动模块时，模块的 ID 才会发生变化。新模块不会影响其他模块的 ID。

如需启用该插件，请将其添加到配置的 plugins 部分：

// webpack.config.js
module.exports = {
  plugins: [
    new webpack.HashedModuleIdsPlugin()
  ]
};

深入阅读

有关 HashedModuleIdsPlugin 的 Webpack 文档

总结

缓存软件包并通过更改软件包名称来区分版本
将 bundle 拆分为应用代码、供应商代码和运行时
内嵌运行时以保存 HTTP 请求
使用 import 延迟加载非关键代码
按路线/页面拆分代码，以避免加载不必要的内容