知識庫 / Spring / Spring MVC RSS 訂閱

1. 概述

在本教程中，我們將學習 HTTP 緩存機制。我們還將探討如何在客户端和 Spring MVC 應用程序之間實現該機制的各種方法。

2. 介紹 HTTP 緩存

當我們通過瀏覽器打開網頁時，通常會從 Web 服務器下載大量的資源:

例如，在這個例子中，瀏覽器需要下載三個資源用於一個 /login 頁面。 瀏覽器通常會為每個網頁發出多個 HTTP 請求。 現在，如果我們頻繁請求這些頁面，會導致大量的網絡流量並延長這些頁面的加載時間。

為了減少網絡負載，HTTP 協議允許瀏覽器緩存一些這些資源。 如果啓用，瀏覽器可以將資源保存到本地緩存中。 這樣，瀏覽器就可以從本地存儲中提供這些頁面，而無需從網絡上請求:

Web 服務器可以通過在響應頭中添加 Cache-Control 頭來指示瀏覽器緩存特定資源。

由於資源已保存在本地副本中， 因此存在從瀏覽器提供過時內容（stale content）的風險。 因此，Web 服務器通常會在 Cache-Control 頭中添加過期時間。

在後續部分，我們將為響應添加此頭，來自 Spring MVC 控制器。 稍後，我們還將看到 Spring API，用於根據過期時間驗證緩存的資源。

3. 控制器響應中的 Cache-Control

3.1. 使用 ResponseEntity

最直接的方法是使用 Spring 提供的 CacheControl builder 類:

@GetMapping("/hello/{name}")
@ResponseBody
public ResponseEntity<String> hello(@PathVariable String name) {
    CacheControl cacheControl = CacheControl.maxAge(60, TimeUnit.SECONDS)
      .noTransform()
      .mustRevalidate();
    return ResponseEntity.ok()
      .cacheControl(cacheControl)
      .body("Hello " + name);
}

這將添加一個 Cache-Control 響應頭：

@Test
void whenHome_thenReturnCacheHeader() throws Exception {
    this.mockMvc.perform(MockMvcRequestBuilders.get("/hello/baeldung"))
      .andDo(MockMvcResultHandlers.print())
      .andExpect(MockMvcResultMatchers.status().isOk())
      .andExpect(MockMvcResultMatchers.header()
        .string("Cache-Control","max-age=60, must-revalidate, no-transform"));
}

3.2. 使用HttpServletResponse

通常，控制器需要從處理方法中返回視圖名稱。然而，ResponseEntity 類不允許我們同時返回視圖名稱並處理請求體。

作為替代方案，對於此類控制器，我們可以直接在 HttpServletResponse 中設置 Cache-Control 標頭：

@GetMapping(value = "/home/{name}")
public String home(@PathVariable String name, final HttpServletResponse response) {
    response.addHeader("Cache-Control", "max-age=60, must-revalidate, no-transform");
    return "home";
}

這還將向 HTTP 響應添加一個 Cache-Control 標頭，類似於上一部分：

@Test
void whenHome_thenReturnCacheHeader() throws Exception {
    this.mockMvc.perform(MockMvcRequestBuilders.get("/home/baeldung"))
      .andDo(MockMvcResultHandlers.print())
      .andExpect(MockMvcResultMatchers.status().isOk())
      .andExpect(MockMvcResultMatchers.header()
        .string("Cache-Control","max-age=60, must-revalidate, no-transform"))
      .andExpect(MockMvcResultMatchers.view().name("home"));
}

4. 緩存-控制 用於靜態資源

通常，我們的 Spring MVC 應用程序會提供大量的靜態資源，例如 HTML、CSS 和 JS 文件。由於這些文件會消耗大量的網絡帶寬，因此對於瀏覽器緩存它們至關重要。我們再次使用響應頭部的 緩存-控制 機制來實現這一點。

Spring 允許我們通過資源映射來控制緩存行為：

@Override
public void addResourceHandlers(final ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/resources/**").addResourceLocations("/resources/")
      .setCacheControl(CacheControl.maxAge(60, TimeUnit.SECONDS)
        .noTransform()
        .mustRevalidate());
}

這確保所有 在/resources 下定義的資源 將帶有 Cache-Control 頭響應。

5. 在攔截器中配置 Cache-Control

@Override
public void addInterceptors(InterceptorRegistry registry) {
    WebContentInterceptor interceptor = new WebContentInterceptor();
    interceptor.addCacheMapping(CacheControl.maxAge(60, TimeUnit.SECONDS)
      .noTransform()
      .mustRevalidate(), "/login/*");
    registry.addInterceptor(interceptor);
}

@Test
void whenInterceptor_thenReturnCacheHeader() throws Exception {
    this.mockMvc.perform(MockMvcRequestBuilders.get("/login/baeldung"))
      .andDo(MockMvcResultHandlers.print())
      .andExpect(MockMvcResultMatchers.status().isOk())
      .andExpect(MockMvcResultMatchers.header()
        .string("Cache-Control","max-age=60, must-revalidate, no-transform"));
}

@GetMapping(value = "/productInfo/{name}")
public ResponseEntity<String> validate(@PathVariable String name, WebRequest request) {
 
    ZoneId zoneId = ZoneId.of("GMT");
    long lastModifiedTimestamp = LocalDateTime.of(2020, 02, 4, 19, 57, 45)
      .atZone(zoneId).toInstant().toEpochMilli();
     
    if (request.checkNotModified(lastModifiedTimestamp)) {
        return ResponseEntity.status(304).build();
    }
     
    return ResponseEntity.ok().body("Hello " + name);
}

@Test
void whenValidate_thenReturnCacheHeader() throws Exception {
    HttpHeaders headers = new HttpHeaders();
    headers.add(IF_UNMODIFIED_SINCE, "Tue, 04 Feb 2020 19:57:25 GMT");
    this.mockMvc.perform(MockMvcRequestBuilders.get("/productInfo/baeldung").headers(headers))
      .andDo(MockMvcResultHandlers.print())
      .andExpect(MockMvcResultMatchers.status().is(304));
}