配置 HTTP 缓存行为

Jeff Posnick

注意：此 Codelab 使用 Chrome 开发者工具。下载 Chrome（如果您尚未安装）。

此 Codelab 将向您展示如何更改由基于 Node.js 的 Web 服务器（运行 Express 服务框架）返回的 HTTP 缓存标头。此外，还将展示如何使用 Chrome 开发者工具中的“网络”面板，确认您预期的缓存行为是否确实已应用。

注意：虽然具体说明是针对 Express 量身定制的，但有关选择正确缓存标头的一般原则适用于任何 Web 服务器环境。

熟悉示例项目

以下是您将在示例项目中使用的关键文件：

• server.js 包含用于提供 Web 应用内容的 Node.js 代码。它使用 Express 处理 HTTP 请求和响应。具体而言，express.static() 用于提供公共目录中的所有本地文件，因此 serve-static 文档会派上用场。
• public/index.html 是 Web 应用的 HTML。与大多数 HTML 文件一样，其网址中不包含任何版本控制信息。
• public/app.15261a07.js 和 public/style.391484cf.css 是 Web 应用的 JavaScript 和 CSS 资源。这些文件的网址中都包含一个哈希值，与其内容相对应。index.html 负责跟踪要加载的具体版本化网址。

注意：在“现实世界”中，分配哈希值和更新 HTML 文件以包含对最新版本网址的引用的过程将由构建工具（例如 webpack）处理。在本 Codelab 中，假设这些哈希是在已经完成的构建过程中生成的。

为 HTML 配置缓存标头

在响应不包含版本控制信息的网址请求时，请务必在响应消息中添加 Cache-Control: no-cache。除此之外，建议您设置以下两个额外响应标头之一：Last-Modified 或 ETag。index.html 属于此类别。您可以将此过程分为两个步骤。

首先，Last-Modified 和 ETag 标头由 etag 和 lastModified 配置选项控制。实际上，对于所有 HTTP 响应，这两个选项都默认为 true，因此在当前设置中，您无需选择启用即可获得该行为。不过，您仍然可以在配置中明确说明。

其次，您需要能够添加 Cache-Control: no-cache 标头，但仅适用于 HTML 文档（在本例中为 index.html）。若要根据条件设置此标头，最简单的方法是编写自定义 setHeaders function，并在其中检查传入请求是否针对 HTML 文档。

server.js 中的静态服务配置最初如下所示：

app.use(express.static('public'));

• 进行上述更改后，您应该会得到如下所示的内容：

app.use(express.static('public', {
  etag: true, // Just being explicit about the default.
  lastModified: true,  // Just being explicit about the default.
  setHeaders: (res, path) => {
    if (path.endsWith('.html')) {
      // All of the project's HTML files end in .html
      res.setHeader('Cache-Control', 'no-cache');
    }
  },
}));

为版本化网址配置缓存标头

在响应对包含“指纹”或版本控制信息且内容永远不会更改的网址的请求时，请在响应中添加 Cache-Control: max-age=31536000。app.15261a07.js 和 style.391484cf.css 属于此类别。

基于上一步中使用的 setHeaders function，您可以添加额外的逻辑来检查给定请求是否针对版本化网址，如果是，则添加 Cache-Control: max-age=31536000 标头。

最可靠的方法是使用正则表达式，查看所请求的资源是否与您知道哈希值所属的特定模式匹配。对于此示例项目，它始终是 8 个字符，由数字 0-9 和小写字母 a-f（即十六进制字符）组成。哈希值始终由两侧的 . 字符分隔。

符合这些一般规则的正则表达式可以表示为 new RegExp('\\.[0-9a-f]{8}\\.')。

注意：在制定这些规则时，尽可能具体一些有助于防范未来出现问题。如果您最终向项目中添加了其他未版本化的 JavaScript 或 CSS 资源，那么更通用的匹配（例如检查 .js 或 .css 文件扩展名）最终可能会导致问题。

• 修改 setHeaders 函数，使其如下所示：

app.use(express.static('public', {
  etag: true, // Just being explicit about the default.
  lastModified: true,  // Just being explicit about the default.
  setHeaders: (res, path) => {
    const hashRegExp = new RegExp('\\.[0-9a-f]{8}\\.');

    if (path.endsWith('.html')) {
      // All of the project's HTML files end in .html
      res.setHeader('Cache-Control', 'no-cache');
    } else if (hashRegExp.test(path)) {
      // If the RegExp matched, then we have a versioned URL.
      res.setHeader('Cache-Control', 'max-age=31536000');
    }
  },
}));

使用开发者工具确认新行为

注意：您可以通过完成此 Codelab 来熟悉 Chrome 开发者工具中的“网络”面板。

对静态文件服务器进行修改后，您可以打开开发者工具的“网络”面板，预览实时应用，以确保设置了正确的标头。

• 右键点击列标题，自定义“网络”面板中显示的列，以包含最相关的信息：

在这里，需要注意的列是 Name、Status、Cache-Control、ETag 和 Last-Modified。

• 在开发者工具打开到“网络”面板的情况下，刷新页面。

页面加载后，您应该会在“网络”面板中看到如下所示的条目：

第一行对应您导航到的 HTML 文档。这可以通过 Cache-Control: no-cache 妥善处理。该请求的 HTTP 响应状态为 304。这意味着浏览器知道不立即使用缓存的 HTML，而是使用 Last-Modified 和 ETag 信息向 Web 服务器发出 HTTP 请求，以查看其缓存中的 HTML 是否有任何更新。HTTP 304 响应表示 HTML 未更新。

注意：Cache-Control: no-cache 并不意味着“从不使用缓存的副本”。这意味着“始终先与服务器核对，如果收到 HTTP 304 响应，则使用缓存的副本”。

接下来的两行是版本化 JavaScript 和 CSS 资源。您应该会看到它们通过 Cache-Control: max-age=31536000 提供，并且每个文件的 HTTP 状态均为 200。由于所使用的配置，系统不会向 Node.js 服务器发出实际请求，点击该条目会显示更多详细信息，包括响应来自“（磁盘缓存）”。

ETag 和 Last-Modified 列的实际值并不重要。重要的是确认它们是否已设置。

总结

完成此 Codelab 中的步骤后，您现在已经熟悉了如何使用 Express 在基于 Node.js 的 Web 服务器中配置 HTTP 响应标头，以便以最佳方式使用 HTTP 缓存。您还了解了如何通过 Chrome 开发者工具中的“网络”面板确认是否使用了预期的缓存行为。