メソッドの詳細

• GET

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

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

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - pattern に一致するすべての GET リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• GET

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

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

  たとえば、次の例では、JSON を受け入れる "/user" の GET リクエストを userController の listUsers メソッドにルーティングします。

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

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - pattern に一致するすべての GET リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

  関連事項:

  RequestPredicates

• HEAD

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

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

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - pattern に一致するすべての HEAD リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• HEAD

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

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

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - pattern に一致するすべての HEAD リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• POST

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

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

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - pattern に一致するすべての POST リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• POST

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

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

  たとえば、次の例では、JSON を含む "/user" の POST リクエストを userController の addUser メソッドにルーティングします。

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

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - pattern に一致するすべての POST リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• PUT

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

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

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - pattern に一致するすべての PUT リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• PUT

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

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

  たとえば、次の例では、JSON を含む "/user" の PUT リクエストを userController の editUser メソッドにルーティングします。

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

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - pattern に一致するすべての PUT リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• PATCH

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

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

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - pattern に一致するすべての PATCH リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• PATCH

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

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

  たとえば、次の例では、JSON を含む "/user" の PATCH リクエストを userController の editUser メソッドにルーティングします。

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

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - pattern に一致するすべての PATCH リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• DELETE

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

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

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - pattern に一致するすべての DELETE リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• DELETE

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

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

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - pattern に一致するすべての DELETE リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• OPTIONS

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

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

  パラメーター:

  pattern - 照合するパターン

  handlerFunction - pattern に一致するすべての OPTIONS リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• OPTIONS

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

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

  パラメーター:

  pattern - 照合するパターン

  predicate - 一致する追加の述語

  handlerFunction - pattern に一致するすべての OPTIONS リクエストを処理するハンドラー関数

  戻り値:

  このビルダー

• add

  RouterFunctions.Builder add(RouterFunction<ServerResponse> routerFunction)

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

  たとえば、次の例では、OrderController.routerFunction() から返されたルーター関数を追加しています。userController の changeUser メソッドに:

   RouterFunctionlt;ServerResponsegt; route =
     RouterFunctions.route()
       .GET("/users", userController::listUsers)
       .add(orderController.routerFunction());
       .build();
   

  パラメーター:

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

  戻り値:

  このビルダー

  関連事項:

  RequestPredicates

• resources

  RouterFunctions.Builder resources(StringSE pattern,
                                    Resource location)

  指定されたパターンに一致するリクエストを、指定されたルートの場所を基準にしたリソースにルーティングします。たとえば

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

  パラメーター:

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

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

  戻り値:

  このビルダー

• resources

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

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

  パラメーター:

  lookupFunction - ServerRequest を指定して Resource を提供する関数

  戻り値:

  このビルダー

• nest

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

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

  たとえば、次の例では、"/user" パス述語を使用してネストされたルートを作成します。これにより、"/user" の GET リクエストはユーザーを一覧表示し、"/user" の POST リクエストは新しいユーザーを作成します。

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

  パラメーター:

  predicate - テストする述語

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

  戻り値:

  このビルダー

  関連事項:

  RequestPredicates

• nest

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

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

  たとえば、次の例では、"/user" パス述語を使用してネストされたルートを作成します。これにより、"/user" の GET リクエストはユーザーを一覧表示し、"/user" の POST リクエストは新しいユーザーを作成します。

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

  パラメーター:

  predicate - テストする述語

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

  戻り値:

  このビルダー

  関連事項:

  RequestPredicates

• path

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

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

  たとえば、次の例では、userController で定義されたルーター関数に委譲する "/user" パス述語と、orderController に委譲する "/order" パスを使用してネストされたルートを作成します。

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

  パラメーター:

  pattern - 照合するパターン

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

  戻り値:

  このビルダー

• path

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

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

  たとえば、次の例では、"/user" パス述語を使用してネストされたルートを作成します。これにより、"/user" の GET リクエストはユーザーを一覧表示し、"/user" の POST リクエストは新しいユーザーを作成します。

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

  パラメーター:

  pattern - 照合するパターン

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

  戻り値:

  このビルダー

• filter

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

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

  たとえば、次の例では、リクエストに必要な認証ヘッダーが含まれていない場合に 401 Unauthorized レスポンスを返すフィルターを作成します。

   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();
   

  パラメーター:

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

  戻り値:

  このビルダー

• before

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

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

  たとえば、次の例では、ハンドラー関数が実行される前にリクエストをログに記録するフィルターを作成します。

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

  パラメーター:

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

  戻り値:

  このビルダー

• after

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

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

  たとえば、次の例では、ハンドラー関数の実行後にレスポンスを記録するフィルターを作成します。

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

  パラメーター:

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

  戻り値:

  このビルダー

• onError

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

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

  たとえば、次の例では、IllegalStateException が発生したときに 500 レスポンスステータスを返すフィルターを作成します。

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

  パラメーター:

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

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

  戻り値:

  このビルダー

• onError

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

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

  たとえば、次の例では、IllegalStateException が発生したときに 500 レスポンスステータスを返すフィルターを作成します。

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

  パラメーター:

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

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

  戻り値:

  このビルダー

• build

  RouterFunction<ServerResponse> build()

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

  戻り値:

  内蔵ルーター関数