带标头的条件操作

本节展示了 Spring Data REST 如何使用标准 HTTP 标头来提高性能、条件化操作并促进更复杂的前端。

ETag、If-Match 和 If-None-Match 标头

ETag 标头提供了一种标记资源的方式。这可以防止客户端相互覆盖，同时也可以减少不必要的调用。

考虑以下示例

示例 1. 带有版本号的 POJO
class Sample {

	@Version Long version; (1)

	Sample(Long version) {
		this.version = version;
	}
}
1 @Version 注解（如果您使用的是 Spring Data JPA，则为 JPA 中的注解；对于所有其他模块，则为 Spring Data 的 org.springframework.data.annotation.Version 注解）将此字段标记为版本标记。

在前面的示例中，当 Spring Data REST 将 POJO 作为 REST 资源提供时，它具有一个 ETag 标头，其值为版本字段的值。

如果提供以下 If-Match 标头，我们可以有条件地 PUT、PATCH 或 DELETE 该资源

curl -v -X PATCH -H 'If-Match: <value of previous ETag>' ...

只有当资源的当前 ETag 状态与 If-Match 标头匹配时，操作才会执行。此保护措施可防止客户端相互覆盖。两个不同的客户端可以获取资源并具有相同的 ETag。如果一个客户端更新资源，它会在响应中获得一个新的 ETag。但第一个客户端仍然拥有旧标头。如果该客户端尝试使用 If-Match 标头进行更新，则更新会失败，因为它们不再匹配。相反，该客户端会收到一个 HTTP 412 Precondition Failed 消息。客户端然后可以根据需要进行追赶。

“版本”一词在不同的数据存储中，甚至在您的应用程序中，可能具有不同的语义。Spring Data REST 有效地委托给数据存储的元模型，以识别字段是否已版本化，如果是，则仅在 ETag 元素匹配时才允许列出的更新。

If-None-Match 标头提供了另一种选择。If-None-Match 不用于条件更新，而是允许条件查询。请考虑以下示例

curl -v -H 'If-None-Match: <value of previous etag>' ...

前面的命令（默认情况下）运行一个 GET。Spring Data REST 在执行 GET 时检查 If-None-Match 标头。如果标头与 ETag 匹配，它会得出结论，即没有任何更改，并且不发送资源的副本，而是返回 HTTP 304 Not Modified 状态码。从语义上讲，它的含义是“如果提供的标头值与服务器端版本不匹配，则发送整个资源。否则，不发送任何内容。”

此 POJO 来自基于 ETag 的单元测试，因此它没有 @Entity (JPA) 或 @Document (MongoDB) 注解，这在应用程序代码中是预期的。它只关注带有 @Version 的字段如何生成 ETag 标头。

If-Modified-Since 标头

If-Modified-Since 标头提供了一种检查资源自上次请求以来是否已更新的方法，这使应用程序可以避免重新发送相同的数据。请考虑以下示例

示例 2. 域类型中捕获的最后修改日期
@Document
public class Receipt {

	public @Id String id;
	public @Version Long version;
	public @LastModifiedDate Date date;  (1)

	public String saleItem;
	public BigDecimal amount;

}
1 Spring Data Commons 的 @LastModifiedDate 注解允许以多种格式捕获此信息（JodaTime 的 DateTime、旧版 Java Date 和 Calendar、JDK8 日期/时间类型以及 long/Long）。

使用前面示例中的日期字段，Spring Data REST 返回一个类似于以下的 Last-Modified 标头

Last-Modified: Wed, 24 Jun 2015 20:28:15 GMT

此值可以捕获并用于后续查询，以避免在数据未更新时重复获取相同数据，如以下示例所示

curl -H "If-Modified-Since: Wed, 24 Jun 2015 20:28:15 GMT" ...

使用上述命令，您要求仅当资源自指定时间以来发生更改时才获取。如果是这样，您将获得一个修订后的 Last-Modified 标头，用于更新客户端。如果不是，您将收到一个 HTTP 304 Not Modified 状态码。

标头格式完美，可以发送回以进行未来的查询。

请勿将标头值与不同的查询混淆。结果可能会非常糟糕。仅当您请求完全相同的 URI 和参数时才使用标头值。

构建更高效的前端

ETag 元素与 If-Match 和 If-None-Match 标头相结合，可让您构建一个对用户的数据计划和移动设备电池续航更友好的前端。为此，请执行以下操作

  1. 识别需要锁定的实体并添加版本属性。

    HTML5 很好地支持 data-* 属性，因此将版本存储在 DOM 中（例如 data-etag 属性）。

  2. 识别那些从跟踪最新更新中受益的条目。在获取这些资源时，将 Last-Modified 值存储在 DOM 中（可能是 data-last-modified）。

  3. 在获取资源时，还在 DOM 节点中嵌入 self URI（可能是 data-uri 或 data-self），以便轻松返回资源。

  4. 调整 PUT/PATCH/DELETE 操作以使用 If-Match，并处理 HTTP 412 Precondition Failed 状态码。

  5. 调整 GET 操作以使用 If-None-Match 和 If-Modified-Since，并处理 HTTP 304 Not Modified 状态码。

通过在 DOM 中嵌入 ETag 元素和 Last-Modified 值（或者对于原生移动应用程序可能在其他地方），您可以减少数据和电池电量的消耗，因为您不会一遍又一遍地检索相同的内容。您还可以避免与其他客户端发生冲突，而是在需要协调差异时收到警报。

以这种方式，只需对前端进行少量调整和一些实体级编辑，后端即可提供时间敏感的详细信息，您可以在构建客户友好的客户端时利用这些详细信息。

© . This site is unofficial and not affiliated with VMware.