インターフェース RouterFunctions.Builder

メソッドの詳細

• GET

  <T extends ServerResponse> RouterFunctions.Builder GET(HandlerFunction<T> handlerFunction)

  HTTP GET リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  handlerFunction - handler for GET requests

  戻り値:

  このビルダー

  導入:

  5.3

• GET

  <T extends ServerResponse> RouterFunctions.Builder GET(StringSE pattern, HandlerFunction<T> handlerFunction)

  指定されたパターンに一致するすべての HTTP GET リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - handler for GET requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• GET

  <T extends ServerResponse> RouterFunctions.Builder GET(RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定された述語に一致するすべての HTTP GET リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  predicate - 一致する述語

  handlerFunction - handler for GET requests that match predicate

  戻り値:

  このビルダー

  導入:

  5.3

  関連事項:

  • RequestPredicates

• GET

  <T extends ServerResponse> RouterFunctions.Builder GET(StringSE pattern, RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定されたパターンと述語に一致するすべての HTTP GET リクエストを処理する指定されたハンドラー関数にルートを追加します。

  For instance, the below routes GET requests for "/user" that accept JSON to the listUsers method in userController:

  RouterFunction<ServerResponse> route =
      RouterFunctions.route()
          .GET("/user", RequestPredicates.accept(MediaType.APPLICATION_JSON), userController::listUsers)
          .build();
  

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - handler for GET requests that match pattern and the predicate

  戻り値:

  このビルダー

  関連事項:

  • PathPattern
  • RequestPredicates

• HEAD

  <T extends ServerResponse> RouterFunctions.Builder HEAD(HandlerFunction<T> handlerFunction)

  HTTP HEAD リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  handlerFunction - handler for HEAD requests

  戻り値:

  このビルダー

  導入:

  5.3

• HEAD

  <T extends ServerResponse> RouterFunctions.Builder HEAD(StringSE pattern, HandlerFunction<T> handlerFunction)

  指定されたパターンに一致するすべての HTTP HEAD リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - handler for HEAD requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• HEAD

  <T extends ServerResponse> RouterFunctions.Builder HEAD(RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定された述語に一致するすべての HTTP HEAD リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  predicate - 一致する述語

  handlerFunction - handler for HEAD requests that match predicate

  戻り値:

  このビルダー

  導入:

  5.3

  関連事項:

  • RequestPredicates

• HEAD

  <T extends ServerResponse> RouterFunctions.Builder HEAD(StringSE pattern, RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定されたパターンと述語に一致するすべての HTTP HEAD リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - handler for HEAD requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• POST

  <T extends ServerResponse> RouterFunctions.Builder POST(HandlerFunction<T> handlerFunction)

  HTTP POST リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  handlerFunction - handler for POST requests

  戻り値:

  このビルダー

  導入:

  5.3

• POST

  <T extends ServerResponse> RouterFunctions.Builder POST(StringSE pattern, HandlerFunction<T> handlerFunction)

  指定されたパターンに一致するすべての HTTP POST リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - handler for POST requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• POST

  <T extends ServerResponse> RouterFunctions.Builder POST(RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定された述語に一致するすべての HTTP POST リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  predicate - 一致する述語

  handlerFunction - handler for POST requests that match predicate

  戻り値:

  このビルダー

  導入:

  5.3

  関連事項:

  • RequestPredicates

• POST

  <T extends ServerResponse> RouterFunctions.Builder POST(StringSE pattern, RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定されたパターンと述語に一致するすべての HTTP POST リクエストを処理する指定されたハンドラー関数にルートを追加します。

  For instance, the below routes POST requests for "/user" that contain JSON to the addUser method in userController:

  RouterFunction<ServerResponse> route =
      RouterFunctions.route()
          .POST("/user", RequestPredicates.contentType(MediaType.APPLICATION_JSON), userController::addUser)
          .build();
  

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - handler for POST requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• PUT

  <T extends ServerResponse> RouterFunctions.Builder PUT(HandlerFunction<T> handlerFunction)

  HTTP PUT リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  handlerFunction - handler for PUT requests

  戻り値:

  このビルダー

  導入:

  5.3

• PUT

  <T extends ServerResponse> RouterFunctions.Builder PUT(StringSE pattern, HandlerFunction<T> handlerFunction)

  指定されたパターンに一致するすべての HTTP PUT リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - handler for PUT requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• PUT

  <T extends ServerResponse> RouterFunctions.Builder PUT(RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定された述語に一致するすべての HTTP PUT リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  predicate - 一致する述語

  handlerFunction - handler for PUT requests that match predicate

  戻り値:

  このビルダー

  導入:

  5.3

  関連事項:

  • RequestPredicates

• PUT

  <T extends ServerResponse> RouterFunctions.Builder PUT(StringSE pattern, RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定されたパターンと述語に一致するすべての HTTP PUT リクエストを処理する指定されたハンドラー関数にルートを追加します。

  For instance, the below routes PUT requests for "/user" that contain JSON to the editUser method in userController:

  RouterFunction<ServerResponse> route =
      RouterFunctions.route()
          .PUT("/user", RequestPredicates.contentType(MediaType.APPLICATION_JSON), userController::editUser)
          .build();
  

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - handler for PUT requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• PATCH

  <T extends ServerResponse> RouterFunctions.Builder PATCH(HandlerFunction<T> handlerFunction)

  HTTP PATCH リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  handlerFunction - handler for PATCH requests

  戻り値:

  このビルダー

  導入:

  5.3

• PATCH

  <T extends ServerResponse> RouterFunctions.Builder PATCH(StringSE pattern, HandlerFunction<T> handlerFunction)

  指定されたパターンに一致するすべての HTTP PATCH リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - handler for PATCH requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• PATCH

  <T extends ServerResponse> RouterFunctions.Builder PATCH(RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定された述語に一致するすべての HTTP PATCH リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  predicate - 一致する述語

  handlerFunction - handler for PATCH requests that match predicate

  戻り値:

  このビルダー

  導入:

  5.3

  関連事項:

  • RequestPredicates

• PATCH

  <T extends ServerResponse> RouterFunctions.Builder PATCH(StringSE pattern, RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定されたパターンと述語に一致するすべての HTTP PATCH リクエストを処理する指定されたハンドラー関数にルートを追加します。

  For instance, the below routes PATCH requests for "/user" that contain JSON to the editUser method in userController:

  RouterFunction<ServerResponse> route =
      RouterFunctions.route()
          .PATCH("/user", RequestPredicates.contentType(MediaType.APPLICATION_JSON), userController::editUser)
          .build();
  

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - handler for PATCH requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• DELETE

  <T extends ServerResponse> RouterFunctions.Builder DELETE(HandlerFunction<T> handlerFunction)

  HTTP DELETE リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  handlerFunction - handler for DELETE requests

  戻り値:

  このビルダー

  導入:

  5.3

• DELETE

  <T extends ServerResponse> RouterFunctions.Builder DELETE(StringSE pattern, HandlerFunction<T> handlerFunction)

  指定されたパターンに一致するすべての HTTP DELETE リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - handler for DELETE requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• DELETE

  <T extends ServerResponse> RouterFunctions.Builder DELETE(RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定された述語に一致するすべての HTTP DELETE リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  predicate - 一致する述語

  handlerFunction - handler for DELETE requests that match predicate

  戻り値:

  このビルダー

  導入:

  5.3

  関連事項:

  • RequestPredicates

• DELETE

  <T extends ServerResponse> RouterFunctions.Builder DELETE(StringSE pattern, RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定されたパターンと述語に一致するすべての HTTP DELETE リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - handler for DELETE requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• OPTIONS

  <T extends ServerResponse> RouterFunctions.Builder OPTIONS(HandlerFunction<T> handlerFunction)

  HTTP OPTIONS リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  handlerFunction - handler for OPTIONS requests

  戻り値:

  このビルダー

  導入:

  5.3

• OPTIONS

  <T extends ServerResponse> RouterFunctions.Builder OPTIONS(StringSE pattern, HandlerFunction<T> handlerFunction)

  指定されたパターンに一致するすべての HTTP OPTIONS リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - handler for OPTIONS requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• OPTIONS

  <T extends ServerResponse> RouterFunctions.Builder OPTIONS(RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定された述語に一致するすべての HTTP OPTIONS リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  predicate - 一致する述語

  handlerFunction - handler for OPTIONS requests that match predicate

  戻り値:

  このビルダー

  導入:

  5.3

  関連事項:

  • RequestPredicates

• OPTIONS

  <T extends ServerResponse> RouterFunctions.Builder OPTIONS(StringSE pattern, RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定されたパターンと述語に一致するすべての HTTP OPTIONS リクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - handler for OPTIONS requests that match pattern

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• route

  <T extends ServerResponse> RouterFunctions.Builder route(RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定された述語に一致するすべてのリクエストを処理する指定されたハンドラー関数にルートを追加します。

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  predicate - 一致するリクエスト述語

  handlerFunction - handler for requests that match the predicate

  戻り値:

  このビルダー

  導入:

  5.2

  関連事項:

  • RequestPredicates

• add

  <T extends ServerResponse> RouterFunctions.Builder add(RouterFunction<T> routerFunction)

  指定されたルートをこのビルダーに追加します。外部で定義されたルーター関数をこのビルダーにマージするために使用できます。または、RouterFunctions.route(RequestPredicate, HandlerFunction) と組み合わせて、より柔軟な述語マッチングを可能にすることができます。

  For instance, the fbelow adds the router function returned from OrderController.routerFunction() to the changeUser method in userController:

  RouterFunction<ServerResponse> route =
      RouterFunctions.route()
          .GET("/users", userController::listUsers)
          .add(orderController.routerFunction());
          .build();
  

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  routerFunction - 追加するルーター関数

  戻り値:

  このビルダー

  関連事項:

  • RequestPredicates

• resource

  RouterFunctions.Builder resource(RequestPredicate predicate, Resource resource)

  指定された述語に一致するリクエストを指定されたリソースにルーティングします。たとえば

  Resource resource = new ClassPathResource("static/index.html")
  RouterFunction<ServerResponse> resources = RouterFunctions.resource(path("/api/**").negate(), resource);
  

  パラメーター:

  predicate - 一致する述語

  resource - 提供するリソース

  戻り値:

  リソースにルーティングするルーター関数

  導入:

  6.1.4

• resource

  RouterFunctions.Builder resource(RequestPredicate predicate, Resource resource, BiConsumerSE<Resource, HttpHeaders> headersConsumer)

  指定された述語に一致するリクエストを指定されたリソースにルーティングします。例:

  Resource resource = new ClassPathResource("static/index.html")
  RouterFunction<ServerResponse> resources = RouterFunctions.resource(path("/api/**").negate(), resource);
  

  パラメーター:

  predicate - 一致する述語

  resource - 提供するリソース

  headersConsumer - 提供されるリソースの HTTP ヘッダーへのアクセスを提供します

  戻り値:

  リソースにルーティングするルーター関数

  導入:

  6.1.4

• resources

  RouterFunctions.Builder resources(StringSE pattern, Resource location)

  Route requests that match the given pattern to resources relative to the given root location. For instance:

  Resource location = new FileUrlResource("public-resources/");
  RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
  

  パラメーター:

  pattern - マッチングするパターン

  location - リソースを解決する必要のある場所のディレクトリ

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• resources

  RouterFunctions.Builder resources(StringSE pattern, Resource location, BiConsumerSE<Resource, HttpHeaders> headersConsumer)

  Route requests that match the given pattern to resources relative to the given root location. For instance:

  Resource location = new FileUrlResource("public-resources/");
  RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
  

  パラメーター:

  pattern - マッチングするパターン

  location - リソースを解決する必要のある場所のディレクトリ

  headersConsumer - 提供されるリソースの HTTP ヘッダーへのアクセスを提供します

  戻り値:

  このビルダー

  導入:

  6.1

  関連事項:

  • PathPattern

• resources

  RouterFunctions.Builder resources(FunctionSE<ServerRequest, reactor.core.publisher.Mono<Resource>> lookupFunction)

  提供された検索機能を使用してリソースにルーティングします。ルックアップ関数が指定されたリクエストに Resource を提供する場合、GET、HEAD、OPTIONS リクエストを処理する HandlerFunction を使用して公開されます。

  パラメーター:

  lookupFunction - the function to provide a Resource

  戻り値:

  このビルダー

• resources

  RouterFunctions.Builder resources(FunctionSE<ServerRequest, reactor.core.publisher.Mono<Resource>> lookupFunction, BiConsumerSE<Resource, HttpHeaders> headersConsumer)

  提供された検索機能を使用してリソースにルーティングします。ルックアップ関数が指定されたリクエストに Resource を提供する場合、GET、HEAD、OPTIONS リクエストを処理する HandlerFunction を使用して公開されます。

  パラメーター:

  lookupFunction - the function to provide a Resource

  headersConsumer - 提供されるリソースの HTTP ヘッダーへのアクセスを提供します

  戻り値:

  このビルダー

  導入:

  6.1

• nest

  <T extends ServerResponse> RouterFunctions.Builder nest(RequestPredicate predicate, SupplierSE<RouterFunction<T>> routerFunctionSupplier)

  指定されたリクエスト述語が適用される場合、提供されたルーター関数にルーティングします。このメソッドを使用して、ネストされたルートを作成できます。ルートのグループは、共通のパス（プレフィックス）、ヘッダー、その他のリクエスト述語を共有します。

  For instance, the below creates a nested route with a "/user" path predicate, so that GET requests for "/user" will list users, and POST request for "/user" will create a new user:

  RouterFunction<ServerResponse> nestedRoute =
      RouterFunctions.route()
          .nest(RequestPredicates.path("/user"), () ->
              RouterFunctions.route()
                  .GET(this::listUsers)
                  .POST(this::createUser)
                  .build())
          .build();
  

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  predicate - テストする述語

  routerFunctionSupplier - 述語が適用される場合に委譲するネストされたルーター関数のサプライヤー

  戻り値:

  このビルダー

  関連事項:

  • RequestPredicates

• nest

  RouterFunctions.Builder nest(RequestPredicate predicate, ConsumerSE<RouterFunctions.Builder> builderConsumer)

  指定されたリクエスト述語が適用される場合、構築されたルーター関数にルーティングします。このメソッドを使用して、ネストされたルートを作成できます。ルートのグループは、共通のパス（プレフィックス）、ヘッダー、その他のリクエスト述語を共有します。

  For instance, the below creates a nested route with a "/user" path predicate, so that GET requests for "/user" will list users, and POST request for "/user" will create a new user:

  RouterFunction<ServerResponse> nestedRoute =
      RouterFunctions.route()
          .nest(RequestPredicates.path("/user"), builder ->
              builder.GET(this::listUsers).POST(this::createUser))
          .build();
  

  パラメーター:

  predicate - テストする述語

  builderConsumer - ネストされたルーター関数を提供する Builder のコンシューマー

  戻り値:

  このビルダー

  関連事項:

  • RequestPredicates

• path

  <T extends ServerResponse> RouterFunctions.Builder path(StringSE pattern, SupplierSE<RouterFunction<T>> routerFunctionSupplier)

  指定されたパスプレフィックスパターンが適用される場合は、提供されたルーター関数にルーティングします。このメソッドを使用すると、ルートのグループが共通のパスプレフィックスを共有するネストされたルートを作成できます。具体的には、このメソッドを使用して、外部で定義されたルーター関数をパス接頭辞にマージできます。

  For instance, the below creates a nested route with a "/user" path predicate that delegates to the router function defined in userController, and with a "/order" path that delegates to orderController:

  RouterFunction<ServerResponse> nestedRoute =
      RouterFunctions.route()
          .path("/user", userController::routerFunction)
          .path("/order", orderController::routerFunction)
          .build();
  

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  pattern - 照合するパターン

  routerFunctionSupplier - パターンが一致する場合に委譲するネストされたルーター関数のサプライヤー

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• path

  RouterFunctions.Builder path(StringSE pattern, ConsumerSE<RouterFunctions.Builder> builderConsumer)

  指定されたパスプレフィックスパターンが適用される場合、構築されたルーター関数にルーティングします。このメソッドを使用すると、ルートのグループが共通のパスプレフィックスを共有するネストされたルートを作成できます。

  For instance, the following example creates a nested route with a "/user" path predicate, so that GET requests for "/user" will list users, and POST request for "/user" will create a new user:

  RouterFunction<ServerResponse> nestedRoute =
      RouterFunctions.route()
          .path("/user", builder ->
              builder.GET(this::listUsers).POST(this::createUser))
          .build();
  

  パラメーター:

  pattern - 照合するパターン

  builderConsumer - ネストされたルーター関数を提供する Builder のコンシューマー

  戻り値:

  このビルダー

  関連事項:

  • PathPattern

• filter

  <T extends ServerResponse, R extends ServerResponse> RouterFunctions.Builder filter(HandlerFilterFunction<T,R> filterFunction)

  このビルダーによって作成されたすべてのルートを、指定されたフィルター関数でフィルターします。フィルター機能は通常、ロギング、セキュリティなどの横断的問題に対処するために使用されます。

  For instance, the following example creates a filter that returns a 401 Unauthorized response if the request does not contain the necessary authentication headers:

  RouterFunction<ServerResponse> filteredRoute =
      RouterFunctions.route()
          .GET("/user", this::listUsers)
          .filter((request, next) -> {
              // check for authentication headers
              if (isAuthenticated(request)) {
                  return next.handle(request);
             }
             else {
                 return ServerResponse.status(HttpStatus.UNAUTHORIZED).build();
             }
          })
          .build();
  

  型パラメーター:

  T - フィルタリングするハンドラー関数の型

  R - 関数のレスポンスの型

  パラメーター:

  filterFunction - このビルダーによって作成されたすべてのルートをフィルタリングする関数

  戻り値:

  このビルダー

• before

  RouterFunctions.Builder before(FunctionSE<ServerRequest, ServerRequest> requestProcessor)

  指定されたリクエスト処理関数を使用して、このビルダーによって作成されたすべてのルートのリクエストオブジェクトをフィルタリングします。フィルターは通常、ロギング、セキュリティなどの横断的問題に対処するために使用されます。

  For instance, the following example creates a filter that logs the request before the handler function executes:

  RouterFunction<ServerResponse> filteredRoute =
      RouterFunctions.route()
          .GET("/user", this::listUsers)
          .before(request -> {
              log(request);
              return request;
          })
          .build();
  

  パラメーター:

  requestProcessor - リクエストを変換する関数

  戻り値:

  このビルダー

• after

  <T extends ServerResponse, R extends ServerResponse> RouterFunctions.Builder after(BiFunctionSE<ServerRequest, T, R> responseProcessor)

  指定されたレスポンス処理関数を使用して、このビルダーによって作成されたすべてのルートのレスポンスオブジェクトをフィルターに掛けます。フィルターは通常、ロギング、セキュリティなどの横断的問題に対処するために使用されます。

  For instance, the following example creates a filter that logs the response after the handler function executes:

  RouterFunction<ServerResponse> filteredRoute =
      RouterFunctions.route()
          .GET("/user", this::listUsers)
          .after((request, response) -> {
              log(response);
              return response;
           })
          .build();
  

  型パラメーター:

  T - フィルタリングするハンドラー関数の型

  R - 関数のレスポンスの型

  パラメーター:

  responseProcessor - レスポンスを変換する関数

  戻り値:

  このビルダー

• onError

  <T extends ServerResponse> RouterFunctions.Builder onError(PredicateSE<? super ThrowableSE> predicate, BiFunctionSE<? super ThrowableSE, ServerRequest, reactor.core.publisher.Mono<T>> responseProvider)

  指定されたレスポンスプロバイダー関数を適用することにより、述語に一致するすべての例外をフィルターに掛けます。

  For instance, the following example creates a filter that returns a 500 response status when an IllegalStateException occurs:

  RouterFunction<ServerResponse> filteredRoute =
      RouterFunctions.route()
          .GET("/user", this::listUsers)
          .onError(e -> e instanceof IllegalStateException,
              (e, request) -> ServerResponse.status(HttpStatus.INTERNAL_SERVER_ERROR).build())
          .build();
  

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  predicate - フィルタリングする例外の型

  responseProvider - レスポンスを作成する関数

  戻り値:

  このビルダー

• onError

  <T extends ThrowableSE> RouterFunctions.Builder onError(ClassSE<T> exceptionType, BiFunctionSE<? super T, ServerRequest, reactor.core.publisher.Mono<ServerResponse>> responseProvider)

  指定されたレスポンスプロバイダー関数を適用することにより、指定された型のすべての例外をフィルターに掛けます。

  For instance, the following example creates a filter that returns a 500 response status when an IllegalStateException occurs:

  RouterFunction<ServerResponse> filteredRoute =
      RouterFunctions.route()
          .GET("/user", this::listUsers)
          .onError(IllegalStateException.class,
              (e, request) -> ServerResponse.status(HttpStatus.INTERNAL_SERVER_ERROR).build())
          .build();
  

  型パラメーター:

  T - ハンドラー関数によって返されるレスポンスの型

  パラメーター:

  exceptionType - フィルタリングする例外の型

  responseProvider - レスポンスを作成する関数

  戻り値:

  このビルダー

• withAttribute

  RouterFunctions.Builder withAttribute(StringSE name, ObjectSE value)

  Add an attribute to the last route built with this builder.

  パラメーター:

  name - 属性名

  value - 属性値

  戻り値:

  このビルダー

  導入:

  5.3

• withAttributes

  RouterFunctions.Builder withAttributes(ConsumerSE<MapSE<StringSE,ObjectSE>> attributesConsumer)

  Manipulate the attributes of the last route built.

  コンシューマーに提供されるマップは「ライブ」であるため、コンシューマーを使用して、既存の属性を上書きしSEたり、属性を削除しSEたり、その他の MapSE メソッドを使用したりできます。

  パラメーター:

  attributesConsumer - 属性マップを使用する関数

  戻り値:

  このビルダー

  導入:

  5.3

• build

  RouterFunction<ServerResponse> build()

  RouterFunction をビルドします。作成されたすべてのルートは互いに構成され、フィルター（存在する場合）が結果に適用されます。

  戻り値:

  内蔵ルーター関数