クラス RouterFunctions

メソッドの詳細

• route

  public static RouterFunctions.Builder route()

  WebFlux ビルダースタイルのインターフェースを通じてルーター関数を作成するための検出可能な方法を提供します。

  戻り値:

  ルーター関数ビルダー

  導入:

  5.1

• route

  public static <T extends ServerResponse> RouterFunction<T> route(RequestPredicate predicate, HandlerFunction<T> handlerFunction)

  指定されたリクエスト述語が適用される場合、指定されたハンドラー関数にルーティングします。

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

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

  型パラメーター:

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

  パラメーター:

  predicate - テストする述語

  handlerFunction - 述語が適用される場合にルーティングするハンドラー関数

  戻り値:

  predicate が true と評価された場合に handlerFunction にルーティングするルーター関数

  関連事項:

  • RequestPredicates

• nest

  public static <T extends ServerResponse> RouterFunction<T> nest(RequestPredicate predicate, RouterFunction<T> routerFunction)

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

  たとえば、次の例では、まず GET の場合は listUsers、POST の場合は createUser に解決される合成ルートを作成します。この合成ルートは "/user" パス述語でネストされ、"/user" への GET リクエストではユーザーがリストされ、"/user" への POST リクエストでは新しいユーザーが作成されます。

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

  型パラメーター:

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

  パラメーター:

  predicate - テストする述語

  routerFunction - ネストされたルーター関数

  戻り値:

  predicate が true と評価された場合に routerFunction にルーティングするルーター関数

  関連事項:

  • RequestPredicates

• resource

  public static RouterFunction<ServerResponse> 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

  public static RouterFunction<ServerResponse> 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

  public static RouterFunction<ServerResponse> resources(StringSE pattern, Resource location)

  指定されたパターンに一致するリクエストを、指定されたルートロケーションを基準としたリソースにルーティングします。例:

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

  パラメーター:

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

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

  戻り値:

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

  関連事項:

  • PathPattern
  • resourceLookupFunction(String, Resource)

• resources

  public static RouterFunction<ServerResponse> resources(StringSE pattern, Resource location, BiConsumerSE<Resource, HttpHeaders> headersConsumer)

  指定されたパターンに一致するリクエストを、指定されたルートロケーションを基準としたリソースにルーティングします。例:

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

  パラメーター:

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

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

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

  戻り値:

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

  導入:

  6.1

  関連事項:

  • PathPattern
  • resourceLookupFunction(String, Resource)

• resourceLookupFunction

  public static FunctionSE<ServerRequest, Mono<Resource>> resourceLookupFunction(StringSE pattern, Resource location)

  resources(String, Resource) で使用されるリソース検索関数を返します。返される関数は、任意の組み合わせSEで使用できます。たとえば、検索関数が一致しない場合にデフォルトのリソースを返すには、次のように記述します。

  Mono<Resource> defaultResource = Mono.just(new ClassPathResource("index.html"));
  Function<ServerRequest, Mono<Resource>> lookupFunction =
      RouterFunctions.resourceLookupFunction("/resources/**", new FileUrlResource("public-resources/"))
          .andThen(resourceMono -> resourceMono.switchIfEmpty(defaultResource));
  RouterFunction<ServerResponse> resources = RouterFunctions.resources(lookupFunction);
  

  パラメーター:

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

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

  戻り値:

  指定されたパラメーターのデフォルトのリソース検索関数。

  関連事項:

  • PathPattern

• resources

  public static RouterFunction<ServerResponse> resources(FunctionSE<ServerRequest, Mono<Resource>> lookupFunction)

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

  パラメーター:

  lookupFunction - Resource を提供する機能

  戻り値:

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

• resources

  public static RouterFunction<ServerResponse> resources(FunctionSE<ServerRequest, Mono<Resource>> lookupFunction, BiConsumerSE<Resource, HttpHeaders> headersConsumer)

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

  パラメーター:

  lookupFunction - Resource を提供する機能

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

  戻り値:

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

  導入:

  6.1

• toHttpHandler

  public static HttpHandler toHttpHandler(RouterFunction<?> routerFunction)

  デフォルトの戦略を使用して、指定されたルーター関数を HttpHandler に変換します。

  返されたハンドラーは、次の環境で実行するように適応できます。

  • サーブレットコンテナーの場合は ServletHttpHandlerAdapter を使用する
  • Reactor Netty の場合は ReactorHttpHandlerAdapter を使用します

  HttpWebHandlerAdapter は WebHandler も実装しているため、WebHttpHandlerBuilder を介して追加のフィルターと例外ハンドラーを登録できることに注意してください。

  パラメーター:

  routerFunction - 変換するルーター関数

  戻り値:

  指定されたルーター関数を使用して HTTP リクエストを処理する HTTP ハンドラー

• toHttpHandler

  public static HttpHandler toHttpHandler(RouterFunction<?> routerFunction, HandlerStrategies strategies)

  指定された戦略を使用して、指定されたルーター関数を HttpHandler に変換します。

  返されたハンドラーは、次の環境で実行するように適応できます。

  • サーブレットコンテナーの場合は ServletHttpHandlerAdapter を使用する
  • Reactor Netty の場合は ReactorHttpHandlerAdapter を使用します

  パラメーター:

  routerFunction - 変換するルーター関数

  strategies - 使用する戦略

  戻り値:

  指定されたルーター関数を使用して HTTP リクエストを処理する HTTP ハンドラー

• toWebHandler

  public static WebHandler toWebHandler(RouterFunction<?> routerFunction)

  指定されたルーター関数を WebHandler に変換します。この変換ではデフォルトの戦略が使用されます。

  パラメーター:

  routerFunction - 変換するルーター関数

  戻り値:

  指定されたルーター関数を使用して Web リクエストを処理する Web ハンドラー

• toWebHandler

  public static WebHandler toWebHandler(RouterFunction<?> routerFunction, HandlerStrategies strategies)

  指定された戦略を使用して、指定されたルーター関数を WebHandler に変換します。

  パラメーター:

  routerFunction - 変換するルーター関数

  strategies - 使用する戦略

  戻り値:

  指定されたルーター関数を使用して Web リクエストを処理する Web ハンドラー

• changeParser

  public static <T extends ServerResponse> RouterFunction<T> changeParser(RouterFunction<T> routerFunction, PathPatternParser parser)

  指定されたルーター関数の PathPatternParser を変更します。このメソッドは、PathPatternParser プロパティをデフォルトから変更するために使用できます。たとえば、大文字と小文字の区別を変更するなどです。

  型パラメーター:

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

  パラメーター:

  routerFunction - パーサーを変更するルーター関数

  parser - 変更するパーサー。

  戻り値:

  ルーター変更機能