public interface WebMvcConfigurer
@EnableWebMvc
を介して有効化された Spring MVC の Java ベースの構成をカスタマイズするためのコールバックメソッドを定義します。@EnableWebMvc
- アノテーション付きの構成クラスは、このインターフェースを実装してコールバックし、デフォルト構成をカスタマイズする機会を与えられます。
修飾子と型 | メソッドと説明 |
---|---|
default void | addArgumentResolvers(ListSE<HandlerMethodArgumentResolver> resolvers) リゾルバーを追加して、カスタムコントローラーメソッドの引数型をサポートします。 |
default void | addCorsMappings(CorsRegistry registry) 「グローバル」クロスオリジンリクエスト処理を構成します。 |
default void | addFormatters(FormatterRegistry registry) デフォルトで登録されているものに加えて、 Converters および Formatters を追加します。 |
default void | addInterceptors(InterceptorRegistry registry) コントローラーメソッド呼び出しとリソースハンドラーリクエストの前後処理用に Spring MVC ライフサイクルインターセプターを追加します。 |
default void | addResourceHandlers(ResourceHandlerRegistry registry) Web アプリケーションルート、クラスパスなどの特定の場所からイメージ、js、css ファイルなどの静的リソースを提供するハンドラーを追加します。 |
default void | addReturnValueHandlers(ListSE<HandlerMethodReturnValueHandler> handlers) カスタムコントローラーメソッドの戻り値の型をサポートするハンドラーを追加します。 |
default void | addViewControllers(ViewControllerRegistry registry) レスポンスステータスコードおよび / またはビューで事前構成された単純な自動コントローラーを構成して、レスポンス本文をレンダリングします。 |
default void | configureAsyncSupport(AsyncSupportConfigurer configurer) 非同期リクエスト処理オプションを構成します。 |
default void | configureContentNegotiation(ContentNegotiationConfigurer configurer) コンテンツネゴシエーションオプションを構成します。 |
default void | configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) サーブレットコンテナーの "default" サーブレットに転送して、未処理のリクエストを委譲するハンドラーを設定します。 |
default void | configureHandlerExceptionResolvers(ListSE<HandlerExceptionResolver> resolvers) 例外リゾルバーを構成します。 |
default void | configureMessageConverters(ListSE<HttpMessageConverter<?>> converters) HttpMessageConverter を、リクエスト本文からの読み取りとレスポンス本文への書き込み用に構成します。 |
default void | configurePathMatch(PathMatchConfigurer configurer) 解析済み PathPatterns または PathMatcher での文字列パターンマッチングを使用するかどうか、末尾のスラッシュを一致させるかどうかなど、HandlerMapping パスマッチングオプションの構成を支援します。 |
default void | configureViewResolvers(ViewResolverRegistry registry) ビューリゾルバーを構成して、コントローラーから返された文字列ベースのビュー名を、レンダリングを実行する具体的な View 実装に変換します。 |
default void | extendHandlerExceptionResolvers(ListSE<HandlerExceptionResolver> resolvers) デフォルトで構成された例外リゾルバーのリストを拡張または変更します。 |
default void | extendMessageConverters(ListSE<HttpMessageConverter<?>> converters) configured またはデフォルトのリストで初期化された後、コンバーターのリストを拡張または変更します。 |
default MessageCodesResolver | getMessageCodesResolver() データバインディングおよび検証エラーコードからメッセージコードを構築するためのカスタム MessageCodesResolver を提供します。 |
default Validator | getValidator() デフォルトで作成されたものではなく、カスタム Validator を提供します。 |
default void configurePathMatch(PathMatchConfigurer configurer)
PathPatterns
または PathMatcher
での文字列パターンマッチングを使用するかどうか、末尾のスラッシュを一致させるかどうかなど、HandlerMapping
パスマッチングオプションの構成を支援します。PathMatchConfigurer
default void configureContentNegotiation(ContentNegotiationConfigurer configurer)
default void configureAsyncSupport(AsyncSupportConfigurer configurer)
default void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)
DispatcherServlet
が "/" にマップされ、サーブレットコンテナーの静的リソースのデフォルトの処理がオーバーライドされる場合です。default void addFormatters(FormatterRegistry registry)
Converters
および Formatters
を追加します。default void addInterceptors(InterceptorRegistry registry)
default void addResourceHandlers(ResourceHandlerRegistry registry)
default void addCorsMappings(CorsRegistry registry)
アノテーション付きコントローラーは、@CrossOrigin
を介してさらにきめ細かい構成を宣言できます。このような場合、ここで宣言される「グローバル」CORS 構成は、コントローラーメソッドで定義されたローカル CORS 構成を持つ combined
です。
CorsRegistry
, CorsConfiguration.combine(CorsConfiguration)
default void addViewControllers(ViewControllerRegistry registry)
default void configureViewResolvers(ViewResolverRegistry registry)
View
実装に変換します。default void addArgumentResolvers(ListSE<HandlerMethodArgumentResolver> resolvers)
これは、ハンドラーメソッドの引数を解決するための組み込みサポートをオーバーライドしません。引数解決の組み込みサポートをカスタマイズするには、RequestMappingHandlerAdapter
を直接構成します。
resolvers
- 最初は空のリスト default void addReturnValueHandlers(ListSE<HandlerMethodReturnValueHandler> handlers)
このオプションを使用しても、戻り値を処理するための組み込みのサポートは無効になりません。戻り値を処理するための組み込みサポートをカスタマイズするには、RequestMappingHandlerAdapter を直接構成します。
handlers
- 最初は空のリスト default void configureMessageConverters(ListSE<HttpMessageConverter<?>> converters)
HttpMessageConverter
を、リクエスト本文からの読み取りとレスポンス本文への書き込み用に構成します。デフォルトでは、Jackson JSON、JAXB2 などの対応するサードパーティライブラリがクラスパスに存在する限り、すべての組み込みコンバーターが構成されます。
この方法を使用すると、デフォルトのコンバーター登録がオフになることに注意してください。または、extendMessageConverters(java.util.List)
を使用して、コンバーターのデフォルトリストを変更します。
converters
- 最初は空のコンバーターのリスト default void extendMessageConverters(ListSE<HttpMessageConverter<?>> converters)
configured
またはデフォルトのリストで初期化された後、コンバーターのリストを拡張または変更します。 コンバーターの登録順序が重要であることに注意してください。特に、クライアントが MediaType.ALL
を受け入れる場合は、以前に構成されたコンバーターが優先されます。
converters
- 拡張する構成済みコンバーターのリスト default void configureHandlerExceptionResolvers(ListSE<HandlerExceptionResolver> resolvers)
指定されたリストは空で始まります。空のままにすると、フレームワークはデフォルトのリゾルバーのセットを構成します。WebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List, org.springframework.web.accept.ContentNegotiationManager)
を参照してください。または、例外リゾルバーがリストに追加された場合、アプリケーションが効果的に引き継ぎ、完全に初期化された例外リゾルバーを提供する必要があります。
あるいは、extendHandlerExceptionResolvers(List)
を使用して、デフォルトで構成された例外リゾルバーのリストを継承または変更できます。
default void extendHandlerExceptionResolvers(ListSE<HandlerExceptionResolver> resolvers)
resolvers
- 拡張する構成済みリゾルバーのリスト WebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List, org.springframework.web.accept.ContentNegotiationManager)
@Nullable default Validator getValidator()
Validator
を提供します。JSR-303 がクラスパス上にあると仮定した場合のデフォルトの実装は、OptionalValidatorFactoryBean
です。戻り値を null
のままにして、デフォルトのままにします。@Nullable default MessageCodesResolver getMessageCodesResolver()
MessageCodesResolver
を提供します。戻り値を null
のままにして、デフォルトのままにします。