インターフェース WebMvcConfigurer

メソッドの詳細

• configurePathMatch

  default void configurePathMatch(PathMatchConfigurer configurer)

  解析済み PathPatterns または PathMatcher での文字列パターンマッチングを使用するかどうか、末尾のスラッシュを一致させるかどうかなど、HandlerMapping パスマッチングオプションの構成を支援します。

  導入:

  4.0.3

  関連事項:

  • PathMatchConfigurer

• configureContentNegotiation

  default void configureContentNegotiation(ContentNegotiationConfigurer configurer)

  コンテンツネゴシエーションオプションを構成します。

• configureApiVersioning

  default void configureApiVersioning(ApiVersionConfigurer configurer)

  アプリケーションの API バージョン管理を構成します。バージョン管理を有効にするには、リクエストから API バージョンを解決する方法 (リクエストヘッダー経由など) を少なくとも 1 つ構成する必要があります。

  導入:

  7.0

• configureAsyncSupport

  default void configureAsyncSupport(AsyncSupportConfigurer configurer)

  非同期リクエスト処理オプションを構成します。

• configureDefaultServletHandling

  default void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)

  サーブレットコンテナーの "default" サーブレットに転送して、未処理のリクエストを委譲するハンドラーを設定します。これの一般的な使用例は、DispatcherServlet が "/" にマップされ、サーブレットコンテナーの静的リソースのデフォルトの処理がオーバーライドされる場合です。

• addFormatters

  default void addFormatters(FormatterRegistry registry)

  デフォルトで登録されているものに加えて、Converters および Formatters を追加します。

• addInterceptors

  default void addInterceptors(InterceptorRegistry registry)

  コントローラーメソッド呼び出しとリソースハンドラーリクエストの前後処理用に Spring MVC ライフサイクルインターセプターを追加します。インターセプターは、すべてのリクエストに適用するか、URL パターンのサブセットに限定するように登録できます。

• addResourceHandlers

  default void addResourceHandlers(ResourceHandlerRegistry registry)

  Web アプリケーションルート、クラスパスなどの特定の場所からイメージ、js、css ファイルなどの静的リソースを提供するハンドラーを追加します。

  関連事項:

  • ResourceHandlerRegistry

• addCorsMappings

  default void addCorsMappings(CorsRegistry registry)

  「グローバル」クロスオリジンリクエスト処理を設定します。構成された CORS マッピングは、アノテーション付きコントローラー、関数エンドポイント、静的リソースに適用されます。

  アノテーション付きコントローラーは、@CrossOrigin を介してさらにきめ細かい構成を宣言できます。このような場合、ここで宣言される「グローバル」CORS 構成は、コントローラーメソッドで定義されたローカル CORS 構成を持つ combined です。

  導入:

  4.2

  関連事項:

  • CorsRegistry
  • CorsConfiguration.combine(CorsConfiguration)

• addViewControllers

  default void addViewControllers(ViewControllerRegistry registry)

  レスポンスステータスコードやレスポンス本文をレンダリングするビューが事前に構成された、シンプルな自動コントローラーを構成します。これは、カスタムコントローラーロジックが必要ない場合に役立ちます。たとえば、ホームページをレンダリングしたり、シンプルなサイト URL リダイレクトを実行したり、HTML コンテンツを含む 404 ステータスやコンテンツなしの 204 ステータスを返すなどです。

  関連事項:

  • ViewControllerRegistry

• configureViewResolvers

  default void configureViewResolvers(ViewResolverRegistry registry)

  ビューリゾルバーを構成して、コントローラーから返された文字列ベースのビュー名を、レンダリングを実行する具体的な View 実装に変換します。

  導入:

  4.1

• addArgumentResolvers

  default void addArgumentResolvers(ListSE<HandlerMethodArgumentResolver> resolvers)

  リゾルバーを追加して、カスタムコントローラーメソッドの引数型をサポートします。

  これは、ハンドラーメソッドの引数を解決するための組み込みサポートをオーバーライドしません。引数解決の組み込みサポートをカスタマイズするには、RequestMappingHandlerAdapter を直接構成します。

  パラメーター:

  resolvers - 最初は空のリスト

• addReturnValueHandlers

  default void addReturnValueHandlers(ListSE<HandlerMethodReturnValueHandler> handlers)

  カスタムコントローラーメソッドの戻り値の型をサポートするハンドラーを追加します。

  このオプションを使用しても、戻り値を処理するための組み込みのサポートは無効になりません。戻り値を処理するための組み込みサポートをカスタマイズするには、RequestMappingHandlerAdapter を直接構成します。

  パラメーター:

  handlers - 最初は空のリスト

• configureMessageConverters

  default void configureMessageConverters(HttpMessageConverters.ServerBuilder builder)

  構築中の HttpMessageConverters インスタンスを構成します。

  パラメーター:

  builder - 構成するビルダー

  導入:

  7.0

• configureMessageConverters

  @DeprecatedSE(since="7.0", forRemoval=true) default void configureMessageConverters(ListSE<HttpMessageConverter<?>> converters)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  7.0 以降、configureMessageConverters(HttpMessageConverters.ServerBuilder) のコンバーターの構成を推奨

  HttpMessageConverter を、リクエスト本文からの読み取りとレスポンス本文への書き込み用に構成します。

  デフォルトでは、Jackson JSON、JAXB2 などの対応するサードパーティライブラリがクラスパスに存在する限り、すべての組み込みコンバーターが構成されます。

  このメソッドを使用すると、デフォルトのコンバーターの登録がオフになることに注意してください。ただし、Spring Boot アプリケーションでは、WebMvcAutoConfiguration によって HttpMessageConverter Bean とデフォルトのコンバーターが追加されます。Boot アプリケーションでは HttpMessageConverters を使用します。あるいは、どのようなシナリオでも、extendMessageConverters(java.util.List) を使用してメッセージコンバーターの構成済みリストを変更します。

  パラメーター:

  converters - 最初は空のコンバーターのリスト

• extendMessageConverters

  @DeprecatedSE(since="7.0", forRemoval=true) default void extendMessageConverters(ListSE<HttpMessageConverter<?>> converters)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  7.0 以降、configureMessageConverters(HttpMessageConverters.ServerBuilder) のコンバーターの構成を推奨

  configured またはデフォルトリストで初期化された後に、コンバーターのリストを拡張または変更します。

  コンバーターの登録順序が重要であることに注意してください。特に、クライアントが MediaType.ALL を受け入れる場合は、以前に構成されたコンバーターが優先されます。

  パラメーター:

  converters - 拡張する構成済みコンバーターのリスト

  導入:

  4.1.3

• configureHandlerExceptionResolvers

  default void configureHandlerExceptionResolvers(ListSE<HandlerExceptionResolver> resolvers)

  例外リゾルバーを構成します。

  指定されたリストは空で始まります。空のままにすると、フレームワークはデフォルトのリゾルバーのセットを構成します。WebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List, org.springframework.web.accept.ContentNegotiationManager) を参照してください。または、例外リゾルバーがリストに追加された場合、アプリケーションが効果的に引き継ぎ、完全に初期化された例外リゾルバーを提供する必要があります。

  あるいは、extendHandlerExceptionResolvers(List) を使用して、デフォルトで構成された例外リゾルバーのリストを継承または変更できます。

  パラメーター:

  resolvers - 最初は空のリスト

  関連事項:

  • extendHandlerExceptionResolvers(List)
  • WebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List, org.springframework.web.accept.ContentNegotiationManager)

• extendHandlerExceptionResolvers

  default void extendHandlerExceptionResolvers(ListSE<HandlerExceptionResolver> resolvers)

  デフォルトで構成された例外リゾルバーのリストを拡張または変更します。これは、デフォルトの例外リゾルバーを妨げることなく、カスタム例外リゾルバーを挿入できます。

  パラメーター:

  resolvers - 拡張する構成済みリゾルバーのリスト

  導入:

  4.3

  関連事項:

  • WebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List, org.springframework.web.accept.ContentNegotiationManager)

• addErrorResponseInterceptors

  default void addErrorResponseInterceptors(ListSE<ErrorResponse.Interceptor> interceptors)

  RFC 9457 ProblemDetail エラーレスポンスをレンダリングするときに適用する ErrorResponse.Interceptor のリストに追加します。

  パラメーター:

  interceptors - 使用する迎撃機

  導入:

  6.2

• getValidator

  default @Nullable Validator getValidator()

  デフォルトで作成されたものではなく、カスタム Validator を提供します。JSR-303 がクラスパス上にあると仮定した場合のデフォルトの実装は、OptionalValidatorFactoryBean です。戻り値を null のままにして、デフォルトのままにします。

• getMessageCodesResolver

  default @Nullable MessageCodesResolver getMessageCodesResolver()

  データバインディングおよび検証エラーコードからメッセージコードを構築するためのカスタム MessageCodesResolver を提供します。戻り値を null のままにして、デフォルトのままにします。