SpringWebFluxフィルター

投稿日: 2019-10-19 2022-10-17
タグ: Reactive, Spring 5, Spring Web

1. 概要

フィルタの使用は、エンドポイントを変更せずに要求または応答を変更する方法を提供するため、Webアプリケーションで広く使用されています。

このクイックチュートリアルでは、WebFluxフレームワークを使用してそれらを実装するための可能な方法について説明します。

WebFluxフレームワーク自体の詳細については説明しませんので、詳細についてはこの記事を確認することをお勧めします。

2. Mavenの依存関係

まず、WebFluxMavenの依存関係を宣言しましょう。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

3. エンドポイント

最初にいくつかのエンドポイントを作成する必要があります。メソッドごとに1つ：アノテーションベースと機能ベース。

注釈ベースのコントローラーから始めましょう。

@GetMapping(path = "/users/{name}")
public Mono<String> getName(@PathVariable String name) {
    return Mono.just(name);
}

機能エンドポイントの場合、最初にハンドラーを作成する必要があります。

@Component
public class PlayerHandler {
    public Mono<ServerResponse> getName(ServerRequest request) {
        Mono<String> name = Mono.just(request.pathVariable("name"));
        return ok().body(name, String.class);
    }
}

また、ルーター構成のマッピング：

@Bean
public RouterFunction<ServerResponse> route(PlayerHandler playerHandler) {
    return RouterFunctions
      .route(GET("/players/{name}"), playerHandler::getName)
      .filter(new ExampleHandlerFilterFunction());
}

4. WebFluxフィルターの種類

WebFluxフレームワークは、WebFiltersとHandlerFilterFunctionsの2種類のフィルターを提供します。

それらの主な違いは、WebFilter実装はすべてのエンドポイントで機能しおよびHandlerFilterFunction実装はルーターベースのものでのみ機能することです。

4.1. WebFilter

WebFilter を実装して、応答に新しいヘッダーを追加します。結果として、すべての応答は次のように動作するはずです。

@Component
public class ExampleWebFilter implements WebFilter {
 
    @Override
    public Mono<Void> filter(ServerWebExchange serverWebExchange, 
      WebFilterChain webFilterChain) {
        
        serverWebExchange.getResponse()
          .getHeaders().add("web-filter", "web-filter-test");
        return webFilterChain.filter(serverWebExchange);
    }
}

4.2. HandlerFilterFunction

これには、「name」パラメーターが「test」と等しい場合にHTTPステータスをFORBIDDENに設定するロジックを実装します。

public class ExampleHandlerFilterFunction 
  implements HandlerFilterFunction<ServerResponse, ServerResponse> {
 
    @Override
    public Mono<ServerResponse> filter(ServerRequest serverRequest,
      HandlerFunction<ServerResponse> handlerFunction) {
        if (serverRequest.pathVariable("name").equalsIgnoreCase("test")) {
            return ServerResponse.status(FORBIDDEN).build();
        }
        return handlerFunction.handle(serverRequest);
    }
}

5. テスト

WebFlux Frameworkには、フィルターをテストする簡単な方法があります：WebTestClient。これにより、エンドポイントへのHTTP呼び出しをテストできます。

注釈ベースのエンドポイントの例を次に示します。

@Test
public void whenUserNameIsBaeldung_thenWebFilterIsApplied() {
    EntityExchangeResult<String> result = webTestClient.get()
      .uri("/users/baeldung")
      .exchange()
      .expectStatus().isOk()
      .expectBody(String.class)
      .returnResult();

    assertEquals(result.getResponseBody(), "baeldung");
    assertEquals(
      result.getResponseHeaders().getFirst("web-filter"), 
      "web-filter-test");
}

@Test
public void whenUserNameIsTest_thenHandlerFilterFunctionIsNotApplied() {
    webTestClient.get().uri("/users/test")
      .exchange()
      .expectStatus().isOk();
}

そして、機能エンドポイントの場合：

@Test
public void whenPlayerNameIsBaeldung_thenWebFilterIsApplied() {
    EntityExchangeResult<String> result = webTestClient.get()
      .uri("/players/baeldung")
      .exchange()
      .expectStatus().isOk()
      .expectBody(String.class)
      .returnResult();

    assertEquals(result.getResponseBody(), "baeldung");
    assertEquals(
      result.getResponseHeaders().getFirst("web-filter"),
      "web-filter-test");
} 

@Test 
public void whenPlayerNameIsTest_thenHandlerFilterFunctionIsApplied() {
    webTestClient.get().uri("/players/test")
      .exchange()
      .expectStatus().isForbidden(); 
}

6. 結論

このチュートリアルでは、両方のタイプのWebFluxフィルターについて説明し、いくつかのコード例を確認しました。

WebFlux Frameworkの詳細については、ドキュメントを参照してください。

いつものように、例の完全なソースコードは、GitHubのにあります。

getdocs

13036