HTTP 缓存

ChatGPT-4o 中英对照 HTTP Caching

查看在 Servlet 栈中的等效内容

HTTP 缓存可以显著提高 Web 应用程序的性能。HTTP 缓存围绕 Cache-Control 响应头以及后续的条件请求头，如 Last-Modified 和 ETag。Cache-Control 指导私有（例如，浏览器）和公共（例如，代理）缓存如何缓存和重用响应。ETag 头用于发起一个条件请求，如果内容没有改变，可能会导致返回 304 (NOT_MODIFIED) 状态码而没有响应体。ETag 可以被视为 Last-Modified 头的更复杂的继任者。

本节介绍 Spring WebFlux 中可用的 HTTP 缓存相关选项。

CacheControl

参见 Servlet 栈中的等效内容

CacheControl 提供了对 Cache-Control 头相关设置的支持，并在多个地方被接受为参数：

• 控制器

• 静态资源

虽然 RFC 7234 描述了 Cache-Control 响应头的所有可能指令，但 CacheControl 类型采用了一种面向用例的方法，专注于常见场景，如以下示例所示：

Java

// Cache for an hour - "Cache-Control: max-age=3600"
CacheControl ccCacheOneHour = CacheControl.maxAge(1, TimeUnit.HOURS);

// Prevent caching - "Cache-Control: no-store"
CacheControl ccNoStore = CacheControl.noStore();

// Cache for ten days in public and private caches,
// public caches should not transform the response
// "Cache-Control: max-age=864000, public, no-transform"
CacheControl ccCustom = CacheControl.maxAge(10, TimeUnit.DAYS).noTransform().cachePublic();

java

Kotlin

// Cache for an hour - "Cache-Control: max-age=3600"
val ccCacheOneHour = CacheControl.maxAge(1, TimeUnit.HOURS)

// Prevent caching - "Cache-Control: no-store"
val ccNoStore = CacheControl.noStore()

// Cache for ten days in public and private caches,
// public caches should not transform the response
// "Cache-Control: max-age=864000, public, no-transform"
val ccCustom = CacheControl.maxAge(10, TimeUnit.DAYS).noTransform().cachePublic()

kotlin

控制器

查看在 Servlet 栈中的等效内容

控制器可以添加对 HTTP 缓存的显式支持。我们建议这样做，因为在与条件请求头进行比较之前，需要计算资源的 lastModified 或 ETag 值。控制器可以将 ETag 和 Cache-Control 设置添加到 ResponseEntity 中，如以下示例所示：

Java

@GetMapping("/book/{id}")
public ResponseEntity<Book> showBook(@PathVariable Long id) {

    Book book = findBook(id);
    String version = book.getVersion();

    return ResponseEntity
            .ok()
            .cacheControl(CacheControl.maxAge(30, TimeUnit.DAYS))
            .eTag(version) // lastModified is also available
            .body(book);
}

java

Kotlin

@GetMapping("/book/{id}")
fun showBook(@PathVariable id: Long): ResponseEntity<Book> {

    val book = findBook(id)
    val version = book.getVersion()

    return ResponseEntity
            .ok()
            .cacheControl(CacheControl.maxAge(30, TimeUnit.DAYS))
            .eTag(version) // lastModified is also available
            .body(book)
}

kotlin

前面的示例在与条件请求头的比较表明内容没有更改时，发送一个带有空主体的 304 (NOT_MODIFIED) 响应。否则，ETag 和 Cache-Control 头会被添加到响应中。

您还可以在控制器中对条件请求头进行检查，如以下示例所示：

Java

@RequestMapping
public String myHandleMethod(ServerWebExchange exchange, Model model) {

    long eTag = ... 1

    if (exchange.checkNotModified(eTag)) {
        return null; 2
    }

    model.addAttribute(...); 3
    return "myViewName";
}

java

• 应用程序特定的计算。

• 响应已设置为 304 (NOT_MODIFIED)。无需进一步处理。

• 继续请求处理。

Kotlin

@RequestMapping
fun myHandleMethod(exchange: ServerWebExchange, model: Model): String? {

    val eTag: Long = ... 1

    if (exchange.checkNotModified(eTag)) {
        return null2
    }

    model.addAttribute(...) 3
    return "myViewName"
}

kotlin

• 应用程序特定的计算。

• 响应已设置为 304 (NOT_MODIFIED)。无需进一步处理。

• 继续请求处理。

有三种变体用于根据 eTag 值、lastModified 值或两者检查条件请求。对于条件 GET 和 HEAD 请求，可以将响应设置为 304 (NOT_MODIFIED)。对于条件 POST、PUT 和 DELETE，可以将响应设置为 412 (PRECONDITION_FAILED) 以防止并发修改。

静态资源

查看在 Servlet 栈中的等效内容

你应该为静态资源提供 Cache-Control 和条件响应头，以获得最佳性能。请参阅配置静态资源的部分。