HTTP缓存与Spring示例

缓存是HTTP协议的强大功能，但由于某些原因，它主要用于静态资源，例如图像，CSS样式表或JavaScript文件。但是，HTTP缓存不仅限于应用程序的资产，您还可以将其用于动态计算的资源。

只需少量工作，您就可以加速应用程序并改善整体用户体验。在本文中，您将学习如何对Spring控制器的结果使用内置的HTTP响应缓存机制 。

1.如何以及何时使用HTTP响应缓存？

您可以在应用程序的多层上进行缓存。数据库具有其缓存存储，应用程序将一些数据缓存在操作内存中，Web客户端也在其侧重用信息。

您可能知道，HTTP协议负责网络通信。缓存机制使我们可以通过减少客户端与服务器之间传输的数据量来优化网络流量。

您可以（并且应该）优化什么？

当网络资源不经常更改或您确切知道其更新时间时 ，您便是使用HTTP缓存进行优化的理想人选。

一旦确定了用于HTTP缓存的竞争者，就需要选择一种合适的方法来管理缓存的验证。 HTTP协议定义了几个请求和响应头，可用于控制客户端何时应清除缓存 。

适当的HTTP标头的选择取决于您要优化的特定情况。但是，无论用例如何，我们都可以根据缓存的验证位置划分缓存管理选项。它可以由客户端或服务器验证。

让我们继续上演这个节目。

HTTP缓存

2.客户端缓存验证

当您知道请求的资源在给定时间内不会更改时，服务器可以将此类信息作为响应头发送给客户端。根据该信息，客户端决定是应该重新获取资源还是重用先前下载的资源。

有两个可能的选项来描述客户端何时应再次获取资源并删除存储的缓存值。因此，让我们看看它们的实际效果。

HTTP缓存在固定时间内有效

如果要防止客户端在给定的时间内重新获取资源 ，则应查看Cache-Control标头，您可以在其中指定应将提取的数据重用多长时间。

通过将标头的值设置为max-age = <seconds>，您可以通知客户端不必再提取资源多长时间。 缓存值的有效性与请求时间有关。

为了在Spring的控制器中设置HTTP标头，而不是常规的有效负载对象，您应该返回ResponseEntity包装器类。这是一个例子：

@GetMapping("/{id}")
ResponseEntity<Product> getProduct(@PathVariable long id) {// …CacheControl cacheControl = CacheControl.maxAge(30, TimeUnit.MINUTES);return ResponseEntity.ok().cacheControl(cacheControl).body(product);
}

标头的值只是一个常规的String，但在Cache-Control的情况下，Spring为我们提供了一个特殊的构建器类，该类可防止我们犯小错误，例如拼写错误。

HTTP缓存有效至固定日期

有时您知道什么时候资源会改变。这是经常发布的数据的常见情况，例如天气预报或为昨天的交易时段计算的股市指标。 资源的确切到期日期可以向客户端公开。

为此，您应该使用Expires HTTP标头。日期值应使用一种标准化的数据格式进行格式化。

Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format

幸运的是，Java附带了针对第一个这些格式的预定义格式器。在下面，您可以找到一个将标题设置为当天结束的示例。

@GetMapping("/forecast")
ResponseEntity<Forecast> getTodaysForecast() {// ...ZonedDateTime expiresDate = ZonedDateTime.now().with(LocalTime.MAX);String expires = expiresDate.format(DateTimeFormatter.RFC_1123_DATE_TIME);return ResponseEntity.ok().header(HttpHeaders.EXPIRES, expires).body(weatherForecast);
}

注意， HTTP日期格式需要有关时区的信息 。这就是为什么上面的示例使用ZonedDateTime的原因 。如果尝试使用LocalDateTime ，则在运行时将出现以下错误消息：

java.time.temporal.UnsupportedTemporalTypeException: Unsupported field: OffsetSeconds

如果响应中同时存在Cache-Control和Expires标头，则客户端仅使用Cache-Control 。

3.服务器端缓存验证

在基于用户输入动态生成的内容中，服务器不知道何时更改请求的资源的情况更为常见。在这种情况下，客户端可以使用以前获取的数据，但首先，它需要询问服务器该数据是否仍然有效。

自日期以来是否修改过资源？

如果您跟踪Web资源的修改日期，则可以将该日期作为响应的一部分向客户端公开。在下一个请求中，客户端会将这个日期发送回服务器，以便它可以验证自上一个请求以来是否已修改资源。如果资源没有更改，则服务器不必再次重新发送数据。相反，它使用304 HTTP代码进行响应，而没有任何有效负载。

HTTP缓存

要公开资源的修改日期，您应该设置Last-Modified标头。 Spring的ResponseEntity构建器具有一个名为lastModified（）的特殊方法，该方法可以帮助您以正确的格式分配值。您将在一分钟内看到它。

但是在发送完整响应之前，您应该检查客户端是否在请求中包括 If-Modified-Since 标头。客户端根据与该特定资源的先前响应一起发送的Last-Modified标头的值来设置其值。

如果If-Modified-Since标头的值与请求的资源的修改日期匹配，则可以节省一些带宽并以空主体响应客户端。

再次，Spring提供了一个辅助方法，该方法简化了上述日期的比较。可以在WebRequest包装器类中找到称为checkNotModified（）的方法，您可以将其添加到控制器的方法中作为输入。

听起来复杂吗？

让我们仔细看一下完整的示例。

@GetMapping("/{id}")
ResponseEntity<Product> getProduct(@PathVariable long id, WebRequest request) {Product product = repository.find(id);long modificationDate = product.getModificationDate().toInstant().toEpochMilli();if (request.checkNotModified(modificationDate)) {return null;}return ResponseEntity.ok().lastModified(modificationDate).body(product);
}

首先，我们获取请求的资源并访问其修改日期。我们将日期转换为格林尼治标准时间1970年1月1日以来的毫秒数，因为那是Spring框架所期望的格式。

然后，我们将日期与If-Modified-Since标头的值进行比较，并在正匹配项上返回一个空主体。否则，服务器会发送完整的响应正文，并带有Last-Modified头的适当值。

有了这些知识，您几乎可以涵盖所有常见的缓存候选对象。但是，您应该知道还有一个更重要的机制是……

使用ETag进行资源版本控制

到目前为止，我们将有效期的精度定义为一秒的精度。

但是，如果您需要比一秒钟更高的精度呢？

这就是ETag进入的地方。

可以将ETag定义为唯一的字符串值，该字符串值可以在时间点上明确标识资源。 通常，服务器根据给定资源的属性或（如果可用）其最新修改日期来计算ETag。

客户端和服务器之间的通信流程几乎与修改日期检查的情况相同。仅标题的名称和值不同。

服务器设置在所谓的（令人惊奇地） 的ETag报头中的ETag值。当客户端再次访问资源时，它应该在名为If-None-Match的标头中发送其值。如果该值与资源的新计算的ETag匹配，则服务器可以使用空主体和HTTP代码304进行响应。

在Spring中，您可以实现ETag服务器流程，如下所示：

@GetMapping("/{id}")
ResponseEntity<Product> getProduct(@PathVariable long id, WebRequest request) {Product product = repository.find(id);String modificationDate = product.getModificationDate().toString();String eTag = DigestUtils.md5DigestAsHex(modificationDate.getBytes());if (request.checkNotModified(eTag)) {return null;}return ResponseEntity.ok().eTag(eTag).body(product);
}

看起来相似吗？

是的，样本与修改日期检查的前一个样本几乎相同。我们只是使用一个不同的值进行比较（并使用MD5算法来计算ETag）。 注意， WebRequest 有一个重载的 checkNotModified（） 方法来处理表示为字符串的ETag。

如果Last-Modified和ETag的工作原理几乎相同，为什么我们需要两者？

HTTP缓存

最后修改与ETag

正如我已经提到的， Last-Modified标头的精度较低，因为它的精度为一秒钟。为了获得更高的精度，请选择ETag 。

当您不跟踪资源的修改日期时，还必须使用ETag 。服务器可以基于资源的属性来计算其值。可以将其视为对象的哈希码。

如果资源具有其修改日期，并且一秒钟的精度适合您，请使用Last-Modified标头。为什么？因为ETag计算可能是一项昂贵的操作 。

顺便说一句，值得一提的是HTTP协议没有指定用于计算ETag的算法。选择算法时，您应该专注于其速度。

本文重点介绍缓存GET请求，但您应该知道服务器可以使用ETag同步更新操作。但这是另一篇文章的想法。

Spring ETag过滤器

由于ETag只是内容的字符串表示形式，因此服务器可以使用响应的字节表示形式来计算其值。这意味着您实际上可以将ETag分配给任何响应。

你猜怎么着？

Spring框架为您提供了ETag响应过滤器实现，该实现为您完成。您要做的就是在应用程序中配置过滤器。

在Spring应用程序中添加HTTP过滤器的最简单方法是通过配置类中的FilterRegistrationBean 。

@Bean
public FilterRegistrationBean filterRegistrationBean () {ShallowEtagHeaderFilter eTagFilter = new ShallowEtagHeaderFilter();FilterRegistrationBean registration = new FilterRegistrationBean();registration.setFilter(eTagFilter);registration.addUrlPatterns("/*");return registration;
}

在这种情况下，对addUrlPatterns（）的调用是多余的，因为默认情况下所有路径都匹配。我将其放在此处以演示您可以控制Spring应该向其添加ETag值的资源。

除了生成ETag之外，过滤器还尽可能以HTTP 304和空主体作为响应。

但是要当心。

ETag计算可能很昂贵。 对于某些应用程序，启用此过滤器实际上可能造成弊大于利 。使用它之前，请先考虑一下您的解决方案。