インターフェース WebFluxConfigurer
- すべての既知の実装クラス:
WebFluxConfigurerComposite
public interface WebFluxConfigurer
@EnableWebFlux を介して有効化された WebFlux アプリケーションの構成をカスタマイズするためのコールバックメソッドを定義します。@EnableWebFlux - アノテーション付き構成クラスは、このインターフェースを実装してコールバックし、デフォルト構成をカスタマイズする機会を与えることができます。このインターフェースを実装し、必要に応じて関連するメソッドをオーバーライドすることを検討してください。
- 導入:
- 5.0
- 作成者:
- Brian Clozel, Rossen Stoyanchev
- 関連事項:
メソッドのサマリー
修飾子と型メソッド説明default voidaddCorsMappings(CorsRegistry registry) 「グローバル」クロスオリジンリクエスト処理を設定します。default voidaddErrorResponseInterceptors(ListSE<ErrorResponse.Interceptor> interceptors) RFC 9457ProblemDetailエラーレスポンスをレンダリングするときに呼び出すErrorResponse.Interceptorのリストに追加します。default voidaddFormatters(FormatterRegistry registry) アノテーション付きコントローラーメソッドの引数の型変換とフォーマットを実行するためのカスタムConvertersおよびFormattersを追加します。default voidaddResourceHandlers(ResourceHandlerRegistry registry) 静的リソースを提供するためのリソースハンドラーを追加します。default voidconfigureApiVersioning(ApiVersionConfigurer configurer) アプリケーションの API バージョン管理を構成します。default voidconfigureArgumentResolvers(ArgumentResolverConfigurer configurer) カスタム@RequestMappingメソッド引数のリゾルバーを構成します。default voidWebFlux で実行のブロックに関する設定を行います。default voidアノテーション付きコントローラーでリクエストを処理するときに、レスポンスにリクエストされたコンテンツ型を解決する方法を構成します。default voidconfigureHttpMessageCodecs(ServerCodecConfigurer configurer) アノテーション付きコントローラーおよび関数エンドポイントで、リクエスト本文からの読み取りとレスポンス本文への書き込み用に HTTP メッセージのリーダーとライターを構成します。default voidconfigurePathMatching(PathMatchConfigurer configurer) パスマッチングオプションを設定します。default voidconfigureViewResolvers(ViewResolverRegistry registry) ビューとモデルを使用してレスポンスをレンダリングするためのビュー解決を構成します。ビューは通常 HTML テンプレートですが、HTTP メッセージライター (JSON、XML など) に基づくこともできます。default @Nullable MessageCodesResolverDataBinderでデフォルトで作成されたものではなく、アノテーション付きコントローラーメソッドの引数でデータバインディングに使用するカスタムMessageCodesResolverを提供します。カスタムValidatorを提供します。default @Nullable WebSocketServiceWebSocketHandlerAdapterを作成するためのWebSocketServiceを提供します。
メソッドの詳細
configureHttpMessageCodecs
アノテーション付きコントローラーおよび関数エンドポイントで、リクエスト本文からの読み取りとレスポンス本文への書き込み用に HTTP メッセージのリーダーとライターを構成します。デフォルトでは、Jackson JSON、JAXB2 などの対応するサードパーティライブラリがクラスパスに存在する限り、すべての組み込みリーダーとライターが構成されます。
- パラメーター:
configurer- リーダーとライターをカスタマイズするためのコンフィギュレーター
addFormatters
アノテーション付きコントローラーメソッドの引数の型変換とフォーマットを実行するためのカスタムConvertersおよびFormattersを追加します。getValidator
getMessageCodesResolver
DataBinderでデフォルトで作成されたものではなく、アノテーション付きコントローラーメソッドの引数でデータバインディングに使用するカスタムMessageCodesResolverを提供します。addCorsMappings
「グローバル」クロスオリジンリクエスト処理を設定します。構成された CORS マッピングは、アノテーション付きコントローラー、関数エンドポイント、静的リソースに適用されます。アノテーション付きコントローラーは、
@CrossOriginを介してさらにきめ細かい構成を宣言できます。このような場合、ここで宣言される「グローバル」CORS 構成は、コントローラーメソッドで定義されたローカル CORS 構成を持つcombinedです。- 関連事項:
configureBlockingExecution
WebFlux で実行のブロックに関する設定を行います。- 導入:
- 6.1
configureContentTypeResolver
アノテーション付きコントローラーでリクエストを処理するときに、レスポンスにリクエストされたコンテンツ型を解決する方法を構成します。- パラメーター:
builder- 使用するリゾルバーを構成するため
configureApiVersioning
アプリケーションの API バージョン管理を構成します。バージョン管理を有効にするには、リクエストから API バージョンを解決する方法 (リクエストヘッダー経由など) を少なくとも 1 つ構成する必要があります。- 導入:
- 7.0
configurePathMatching
パスマッチングオプションを設定します。構成されたパスマッチングオプションは、アノテーション付きコントローラーおよび
static resourcesへのマッピングに使用されます。- パラメーター:
configurer-PathMatchConfigurerインスタンス
configureArgumentResolvers
カスタム@RequestMappingメソッド引数のリゾルバーを構成します。- パラメーター:
configurer- 使用するコンフィギュレーターへ
addErrorResponseInterceptors
RFC 9457ProblemDetailエラーレスポンスをレンダリングするときに呼び出すErrorResponse.Interceptorのリストに追加します。- パラメーター:
interceptors- 使用するハンドラー- 導入:
- 6.2
configureViewResolvers
ビューとモデルを使用してレスポンスをレンダリングするためのビュー解決を構成します。ビューは通常 HTML テンプレートですが、HTTP メッセージライター (JSON、XML など) に基づくこともできます。構成されたビューリゾルバーは、アノテーション付きコントローラーと関数エンドポイントの両方に使用されます。
addResourceHandlers
静的リソースを提供するためのリソースハンドラーを追加します。- 関連事項:
getWebSocketService
WebSocketHandlerAdapterを作成するためのWebSocketServiceを提供します。これは、RequestUpgradeStrategyを介してサーバー固有のプロパティを構成するために使用できます。- 導入:
- 5.3