知識庫 / Spring RSS 訂閱

<filter>
   <filter-name>etagFilter</filter-name>
   <filter-class>org.springframework.web.filter.ShallowEtagHeaderFilter</filter-class>
</filter>
<filter-mapping>
   <filter-name>etagFilter</filter-name>
   <url-pattern>/foos/*</url-pattern>
</filter-mapping>

我們正在將過濾器映射到與 RESTful API 本身相同的 URI 模式上。 過濾器本身自 Spring 3.0 版本以來就是 ETag 功能的標準化實現。

該實現是淺層的一層 – 應用程序根據響應計算 ETag，雖然可以節省帶寬，但不會提升服務器性能。

因此，將受益於 ETag 支持的請求仍將作為標準請求進行處理，消耗任何它通常消耗的資源（例如數據庫連接），只有在響應返回給客户端之前，ETag 支持才會生效。

在該點，ETag 將根據響應主體計算並設置在資源本身，並且如果請求中設置了 If-None-Match 標頭，也會進行處理。

更深層次的 ETag 機制可能能夠提供更大的益處——例如，從緩存中服務某些請求，並且根本無需進行計算——但這無疑不會像此處描述的淺層方法那樣簡單或可插拔。

4.1. 基於Java的配置

讓我們看看基於Java的配置將是什麼樣子，通過在我們的Spring上下文中聲明一個ShallowEtagHeaderFilter bean 來實現：

@Bean
public ShallowEtagHeaderFilter shallowEtagHeaderFilter() {
    return new ShallowEtagHeaderFilter();
}

請注意，如果我們需要提供進一步的過濾器配置，我們應該聲明一個 FilterRegistrationBean 實例：

@Bean
public FilterRegistrationBean<ShallowEtagHeaderFilter> shallowEtagHeaderFilter() {
    FilterRegistrationBean<ShallowEtagHeaderFilter> filterRegistrationBean
      = new FilterRegistrationBean<>( new ShallowEtagHeaderFilter());
    filterRegistrationBean.addUrlPatterns("/foos/*");
    filterRegistrationBean.setName("etagFilter");
    return filterRegistrationBean;
}

最後，如果未使用 Spring Boot，則可以使用 AbstractAnnotationConfigDispatcherServletInitializer 的 getServletFilters 方法來設置過濾器。

4.2. 使用 ResponseEntity 的 eTag() 方法

此方法在 Spring Framework 4.1 中引入，我們可以使用它來控制單個端點檢索的 ETag 值。

例如，假設我們使用版本化實體作為樂觀鎖機制來訪問數據庫信息。

我們可以使用版本本身作為 ETag 來指示實體是否已被修改：

@GetMapping(value = "/{id}/custom-etag")
public ResponseEntity<Foo>
  findByIdWithCustomEtag(@PathVariable("id") final Long id) {

    // ...Foo foo = ...

    return ResponseEntity.ok()
      .eTag(Long.toString(foo.getVersion()))
      .body(foo);
}

服務將檢索與請求的條件頭信息匹配的對應 304-Not Modified 狀態。

5. 驗證 ETag

讓我們從簡單的開始——我們需要驗證一個簡單的請求，用於檢索單個資源，是否會實際返回 "ETag” 標頭：

@Test
public void givenResourceExists_whenRetrievingResource_thenEtagIsAlsoReturned() {
    // Given
    String uriOfResource = createAsUri();

    // When
    Response findOneResponse = RestAssured.given().
      header("Accept", "application/json").get(uriOfResource);

    // Then
    assertNotNull(findOneResponse.getHeader("ETag"));
}

接下來，我們驗證 ETag 行為的正常流程。如果從服務器獲取 資源的請求使用正確的 ETag 值，則服務器不會獲取該資源：

@Test
public void givenResourceWasRetrieved_whenRetrievingAgainWithEtag_thenNotModifiedReturned() {
    // Given
    String uriOfResource = createAsUri();
    Response findOneResponse = RestAssured.given().
      header("Accept", "application/json").get(uriOfResource);
    String etagValue = findOneResponse.getHeader(HttpHeaders.ETAG);

    // When
    Response secondFindOneResponse= RestAssured.given().
      header("Accept", "application/json").headers("If-None-Match", etagValue)
      .get(uriOfResource);

    // Then
    assertTrue(secondFindOneResponse.getStatusCode() == 304);
}

逐步操作:

• 我們創建並檢索一個資源，存儲 ETag 值
• 發送一個新的檢索請求，這次包含“If-None-Match” 標頭，指定先前存儲的 ETag 值
• 在第二個請求中，服務器會簡單地返回 304 Not Modified 響應，因為在兩次檢索操作之間資源確實沒有被修改

最後，我們驗證資源在第一次和第二次檢索請求之間是否被修改的情況：

@Test
public void 
  givenResourceWasRetrievedThenModified_whenRetrievingAgainWithEtag_thenResourceIsReturned() {
    // Given
    String uriOfResource = createAsUri();
    Response findOneResponse = RestAssured.given().
      header("Accept", "application/json").get(uriOfResource);
    String etagValue = findOneResponse.getHeader(HttpHeaders.ETAG);

    existingResource.setName(randomAlphabetic(6));
    update(existingResource);

    // When
    Response secondFindOneResponse= RestAssured.given().
      header("Accept", "application/json").headers("If-None-Match", etagValue)
      .get(uriOfResource);

    // Then
    assertTrue(secondFindOneResponse.getStatusCode() == 200);
}

逐步操作:

• 首先，我們創建並檢索一個 Resource – 並存儲 ETag 值以供後續使用
• 然後，我們更新相同的 Resource
• 發送一個新的 GET 請求，這次帶有 “If-None-Match” 標頭，指定我們之前存儲的 ETag 值
• 在第二個請求中，服務器將返回一個 200 OK 響應，以及完整的 Resource，因為 ETag 值不再正確，因為我們已經更新了 Resource

最後一次測試 – 由於該功能尚未在 Spring 中實現，因此將無法正常工作 – 是 對 If-Match HTTP 標頭的支持：

@Test
public void givenResourceExists_whenRetrievedWithIfMatchIncorrectEtag_then412IsReceived() {
    // Given
    T existingResource = getApi().create(createNewEntity());

    // When
    String uriOfResource = baseUri + "/" + existingResource.getId();
    Response findOneResponse = RestAssured.given().header("Accept", "application/json").
      headers("If-Match", randomAlphabetic(8)).get(uriOfResource);

    // Then
    assertTrue(findOneResponse.getStatusCode() == 412);
}

逐步操作:

• 我們創建資源
• 然後使用“If-Match”標頭指定錯誤的 ETag 值 – 這是一個條件 GET 請求
• 服務器應返回 412 Precondition Failed

6. ETags 體積較大