Spring MVC REST 中的 ETag 处理

Question

我正在考虑从带有 JAX RS 的 Apache CXF RS 切换到 Spring MVC REST，并看到 Spring MVC REST 当前处理 ETag 的方式存在一些问题。也许我的理解不正确，或者有更好的方法来实现当前使用 JAX RS 所做的事情？

使用 Apache CXF RS，最后修改时间戳和 ETag 的条件在 REST 服务内进行评估（条件评估实际上相当复杂，请参阅 RFC 2616 第 14.24 和 14.26 节，所以我很高兴为我完成了） .代码如下所示：

@GET
@Path("...")
@Produces(MediaType.APPLICATION_JSON)
public Response findBy...(..., @Context Request request) {
       ... result = ...fetch-result-or-parts-of-it...;
       final EntityTag eTag = new EntityTag(computeETagValue(result), true);
       ResponseBuilder builder = request.evaluatePreconditions(lastModified, eTag);
       if (builder == null) {
              // a new response is required, because the ETag or time stamp do not match
              // ...potentially fetch full result object now, then:
              builder = Response.ok(result);
       } else {
              // a new response is not needed, send "not modified" status without a body
       }
       final CacheControl cacheControl = new CacheControl();
       cacheControl.setPrivate(true); // store in private browser cache of user only
       cacheControl.setMaxAge(15); // may stay unchecked in private browser cache for 15s, afterwards revalidation is required
       cacheControl.setNoTransform(true); // proxies must not transform the response
       return builder
              .cacheControl(cacheControl)
              .lastModified(lastModified)
              .tag(eTag)
              .build();
}

我对 Spring MVC REST 的相同尝试如下所示：

@RequestMapping(value="...", produces=MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<...> findByGpnPrefixCacheable(...) {
       ... result = ...fetch-result...;
//     ... result = ...fetch-result-or-parts-of-it...; - can't fetch parts, must obtain full result, see below
       final String eTag = "W/\""+computeETagValue(result)+"\""; // need to manually construct, as opposed to convenient JAX RS above
       return ResponseEntity
              .ok() // always say 'ok' (200)?
              .cacheControl(
                     CacheControl
                           .cachePrivate()
                           .maxAge(15, TimeUnit.SECONDS)
                           .noTransform()
                     )
              .eTag(eTag)
              .body(result); // ETag comparison takes place outside controller(?), but data for a full response has already been built - that is wasteful!
}

我不同意必须事先构建所有数据以进行完整响应，即使不是必需的。这使得 Spring MVC REST 中使用的 ETag 的价值远低于其应有的价值。据我了解，弱 ETag 的想法是建立其价值并进行比较可能是“便宜的”。在好的情况下，这可以防止服务器上的负载。在这种情况下，资源被修改了，当然必须构建完整的响应。

在我看来，Spring MVC REST 目前的设计要求构建完整的响应数据，无论最终是否需要响应主体。

所以，总而言之，Spring MVC REST 有两个问题：

1. 是否有等同于evaluatePreconditions()?
2. 有没有更好的方法来构造 ETag 字符串？

感谢您的意见！

Answer 1

1. 是的，有一个等效的方法。

你可以这样使用它：

@RequestMapping
public ResponseEntity<...> findByGpnPrefixCacheable(WebRequest request) {

    // 1. application-specific calculations with full/partial data
    long lastModified = ...; 
    String etag = ...;

    if (request.checkNotModified(lastModified, etag)) {
        // 2. shortcut exit - no further processing necessary
        //  it will also convert the response to an 304 Not Modified
        //  with an empty body
        return null;
    }

    // 3. or otherwise further request processing, actually preparing content
    return ...;
}

请注意，checkNotModified 方法有不同的版本，包括 lastModified、ETag 或两者兼有。

您可以在此处找到文档：Support for ETag and Last-Modified response headers。

---

1. 是的，但您必须先更改一些内容。

您可以更改计算 ETag 的方式，从而无需获取完整结果。

例如，如果这个 fetch-result 是一个数据库查询，您可以向您的实体添加一个版本字段并使用 @Version 对其进行注释，以便每次修改时递增，然后将该值用于电子标签。

这有什么作用？由于您可以将获取配置为惰性，因此您无需检索实体的所有字段，并且还避免了必须对其进行散列以构建 ETag。只需使用版本作为 ETag 字符串。

这是一个关于Using @Version in Spring Data project的问题。