クラス WebHttpHandlerBuilder
java.lang.ObjectSE
org.springframework.web.server.adapter.WebHttpHandlerBuilder
このビルダーには 2 つの目的があります。
1 つは、ターゲット WebHandler
で構成される処理チェーンを組み立て、次に WebFilters
のセットで装飾し、さらに WebExceptionHandlers
のセットで装飾することです。
2 番目の目的は、結果の処理チェーンを HttpHandler
に適合させることです。これは、サポートされる任意のランタイムで使用できる、最低レベルのリアクティブ HTTP 処理抽象化です。適応は HttpWebHandlerAdapter
の助けを借りて行われます。
処理 チェーンは、ビルダーメソッドを介して手動でアセンブルするか、applicationContext
を介して Spring ApplicationContext
から検出するか、その両方を組み合わせて行うことができます。
- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev, Sebastien Deleuze
- 関連事項:
ネストされたクラスのサマリー
ネストされたクラス修飾子と型クラス説明static class
spring-web クラスのBlockHoundIntegration
。フィールドのサマリー
フィールド修飾子と型フィールド説明static final StringSE
Bean ファクトリの ForwardedHeaderTransformer のよく知られた名前。static final StringSE
Bean ファクトリの LocaleContextResolver のよく知られた名前。static final StringSE
Bean ファクトリの ServerCodecConfigurer のよく知られた名前。static final StringSE
Bean ファクトリのターゲット WebHandler の既知の名前。static final StringSE
Bean ファクトリの WebSessionManager のよく知られた名前。メソッドのサマリー
修飾子と型メソッド説明static WebHttpHandlerBuilder
applicationContext
(ApplicationContext context) ApplicationContext
で Bean を検出して新しいビルダーインスタンスを作成する静的ファクトリメソッド。build()
HttpHandler
をビルドします。clone()
このWebHttpHandlerBuilder
を複製します。codecConfigurer
(ServerCodecConfigurer codecConfigurer) ServerCodecConfigurer
を構成して、WebServerExchange
に設定します。exceptionHandler
(WebExceptionHandler... handlers) 指定された例外ハンドラーを追加します。exceptionHandlers
(ConsumerSE<ListSE<WebExceptionHandler>> consumer) 現在構成されている例外ハンドラーの「ライブ」リストを操作します。指定されたフィルターを追加します。filters
(ConsumerSE<ListSE<WebFilter>> consumer) 現在構成されているフィルターの「ライブ」リストを操作します。forwardedHeaderTransformer
(ForwardedHeaderTransformer transformer) 転送されたヘッダーを抽出または削除するためにForwardedHeaderTransformer
を構成します。boolean
ServerCodecConfigurer
が構成されているかどうか (ApplicationContext
から検出されたか、codecConfigurer
を介して明示的に構成されたか)。boolean
ForwardedHeaderTransformer
が構成されているかどうかにかかわらず、ApplicationContext
から検出されるか、forwardedHeaderTransformer(ForwardedHeaderTransformer)
を介して明示的に構成されます。boolean
HttpHandler
のデコレータがhttpHandlerDecorator(Function)
を介して設定されているかどうか。boolean
LocaleContextResolver
が構成されているかどうか (ApplicationContext
から検出されたか、localeContextResolver
を介して明示的に構成されたか)。boolean
WebSessionManager
が構成されているかどうか (ApplicationContext
から検出されたか、sessionManager
を介して明示的に構成されたか)。httpHandlerDecorator
(FunctionSE<HttpHandler, HttpHandler> handlerDecorator) チェーンを処理するWebExceptionHandler
-WebFilter
-WebHandler
全体を効果的にラップするこのビルダーによって返されるHttpHandler
を装飾するようにFunction
SE を構成します。localeContextResolver
(LocaleContextResolver localeContextResolver) WebServerExchange
で設定するようにLocaleContextResolver
を構成します。observationConvention
(ServerRequestObservationConvention observationConvention) サーバー監視に使用するようにServerRequestObservationConvention
を構成します。observationRegistry
(io.micrometer.observation.ObservationRegistry observationRegistry) サーバー交換の観測を記録するためにObservationRegistry
を構成します。sessionManager
(WebSessionManager manager) WebServerExchange
で設定するようにWebSessionManager
を構成します。static WebHttpHandlerBuilder
webHandler
(WebHandler webHandler) 新しいビルダーインスタンスを作成する静的ファクトリメソッド。
フィールドの詳細
WEB_HANDLER_BEAN_NAME
Bean ファクトリのターゲット WebHandler の既知の名前。- 関連事項:
WEB_SESSION_MANAGER_BEAN_NAME
Bean ファクトリの WebSessionManager のよく知られた名前。- 関連事項:
SERVER_CODEC_CONFIGURER_BEAN_NAME
Bean ファクトリの ServerCodecConfigurer のよく知られた名前。- 関連事項:
LOCALE_CONTEXT_RESOLVER_BEAN_NAME
Bean ファクトリの LocaleContextResolver のよく知られた名前。- 関連事項:
FORWARDED_HEADER_TRANSFORMER_BEAN_NAME
Bean ファクトリの ForwardedHeaderTransformer のよく知られた名前。- 関連事項:
メソッドの詳細
webHandler
新しいビルダーインスタンスを作成する静的ファクトリメソッド。- パラメーター:
webHandler
- リクエストのターゲットハンドラー- 戻り値:
- 準備されたビルダー
applicationContext
ApplicationContext
で Bean を検出することによって新しいビルダーインスタンスを作成する静的ファクトリメソッド。以下が検出されます:WebHandler
[1]-WEB_HANDLER_BEAN_NAME
という名前で検索されます。WebFilter
[0..N]- 型によって検出され、順序付けされます。AnnotationAwareOrderComparator
を参照してください。WebExceptionHandler
[0..N]- 型によって検出され、オーダーされました。HttpHandlerDecoratorFactory
[0..N]- 型によって検出され、オーダーされました。ObservationRegistry
-- 型によって検出され、一意であれば構成されます。ServerRequestObservationConvention
-- 型によって検出され、一意であれば構成されます。WebSessionManager
[0..1]-WEB_SESSION_MANAGER_BEAN_NAME
という名前で検索されます。ServerCodecConfigurer
[0..1]-SERVER_CODEC_CONFIGURER_BEAN_NAME
という名前で検索されます。LocaleContextResolver
[0..1]-LOCALE_CONTEXT_RESOLVER_BEAN_NAME
という名前で検索されます。
- パラメーター:
context
- 検索に使用するアプリケーションコンテキスト- 戻り値:
- 準備されたビルダー
filter
指定されたフィルターを追加します。- パラメーター:
filters
- 追加するフィルター
filters
現在構成されているフィルターの「ライブ」リストを操作します。- パラメーター:
consumer
- 使用するコンシューマー
exceptionHandler
指定された例外ハンドラーを追加します。- パラメーター:
handlers
- 例外ハンドラー
exceptionHandlers
現在構成されている例外ハンドラーの「ライブ」リストを操作します。- パラメーター:
consumer
- 使用するコンシューマー
sessionManager
- パラメーター:
manager
- セッションマネージャー- 関連事項:
hasSessionManager
public boolean hasSessionManager()WebSessionManager
が構成されているかどうか (ApplicationContext
から検出されたか、sessionManager
を介して明示的に構成されたか)。- 導入:
- 5.0.9
codecConfigurer
ServerCodecConfigurer
を構成して、WebServerExchange
に設定します。- パラメーター:
codecConfigurer
- コーデック設定
hasCodecConfigurer
public boolean hasCodecConfigurer()ServerCodecConfigurer
が構成されているかどうか (ApplicationContext
から検出されたか、codecConfigurer
を介して明示的に構成されたか)。- 導入:
- 5.0.9
localeContextResolver
WebServerExchange
で設定するようにLocaleContextResolver
を構成します。- パラメーター:
localeContextResolver
- ロケールコンテキストリゾルバー
hasLocaleContextResolver
public boolean hasLocaleContextResolver()LocaleContextResolver
が構成されているかどうか (ApplicationContext
から検出されたか、localeContextResolver
を介して明示的に構成されたか)。- 導入:
- 5.0.9
forwardedHeaderTransformer
転送されたヘッダーを抽出または削除するためにForwardedHeaderTransformer
を構成します。- パラメーター:
transformer
- トランスフォーマー- 導入:
- 5.1
hasForwardedHeaderTransformer
public boolean hasForwardedHeaderTransformer()ForwardedHeaderTransformer
が構成されているかどうかにかかわらず、ApplicationContext
から検出されるか、forwardedHeaderTransformer(ForwardedHeaderTransformer)
を介して明示的に構成されます。- 導入:
- 5.1
observationRegistry
public WebHttpHandlerBuilder observationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry) サーバー交換の観測を記録するためにObservationRegistry
を構成します。デフォルトでは、no-op
レジストリが構成されます。- パラメーター:
observationRegistry
- 観測記録- 導入:
- 6.1
observationConvention
public WebHttpHandlerBuilder observationConvention(ServerRequestObservationConvention observationConvention) サーバー監視に使用するようにServerRequestObservationConvention
を構成します。デフォルトでは、DefaultServerRequestObservationConvention
が使用されます。- パラメーター:
observationConvention
- 記録されたすべての観測に使用する規則- 導入:
- 6.1
httpHandlerDecorator
public WebHttpHandlerBuilder httpHandlerDecorator(FunctionSE<HttpHandler, HttpHandler> handlerDecorator) チェーンを処理するWebExceptionHandler
-WebFilter
-WebHandler
全体を効果的にラップするこのビルダーによって返されるHttpHandler
を装飾するようにFunction
SE を構成します。これにより、チェーン全体の前にリクエストとレスポンスにアクセスでき、同様にチェーン全体の結果を監視することができます。- パラメーター:
handlerDecorator
- 適用するデコレータ- 導入:
- 5.3
hasHttpHandlerDecorator
public boolean hasHttpHandlerDecorator()HttpHandler
のデコレータがhttpHandlerDecorator(Function)
を介して設定されているかどうか。- 導入:
- 5.3
build
HttpHandler
をビルドします。clone
このWebHttpHandlerBuilder
を複製します。