クラス WebMvcConfigurationSupport

メソッドの詳細

• setApplicationContext

  public void setApplicationContext(@Nullable ApplicationContext applicationContext)

  たとえば、リソースの読み込みには Spring ApplicationContext を設定します。

  次で指定:

  インターフェース ApplicationContextAware の setApplicationContext 

  パラメーター:

  applicationContext - このオブジェクトによって使用される ApplicationContext オブジェクト

  関連事項:

  • BeanInitializationException

• getApplicationContext

  public final @Nullable ApplicationContext getApplicationContext()

  関連する Spring ApplicationContext を返します。

  導入:

  4.2

• setServletContext

  public void setServletContext(@Nullable jakarta.servlet.ServletContext servletContext)

  たとえば、リソースの処理、ファイル拡張子の検索などには、ServletContext を設定します。

  次で指定:

  インターフェース ServletContextAware の setServletContext 

  パラメーター:

  servletContext - このオブジェクトによって使用される ServletContext オブジェクト

  関連事項:

  • InitializingBean.afterPropertiesSet()
  • ApplicationContextAware.setApplicationContext(ApplicationContext)

• getServletContext

  public final @Nullable jakarta.servlet.ServletContext getServletContext()

  関連する ServletContext を返します。

  導入:

  4.2

• requestMappingHandlerMapping

  @Bean public RequestMappingHandlerMapping requestMappingHandlerMapping(@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager, @Qualifier("mvcApiVersionStrategy") @Nullable ApiVersionStrategy apiVersionStrategy, @Qualifier("mvcConversionService") FormattingConversionService conversionService, @Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider)

  リクエストをアノテーション付きコントローラーにマッピングするために、0 で順序付けされた RequestMappingHandlerMapping を返します。

• createRequestMappingHandlerMapping

  protected RequestMappingHandlerMapping createRequestMappingHandlerMapping()

  RequestMappingHandlerMapping のカスタムサブクラスにプラグインするための protected メソッド。

  導入:

  4.0

• getInterceptors

  protected final ObjectSE[] getInterceptors(FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider)

  HandlerMapping インスタンスの構成に使用される共有ハンドラーインターセプターへのアクセスを提供します。

  このメソッドはオーバーライドできません。代わりに addInterceptors(InterceptorRegistry) を使用してください。

• addInterceptors

  protected void addInterceptors(InterceptorRegistry registry)

  このメソッドをオーバーライドして、コントローラー呼び出しの前後処理用に Spring MVC インターセプターを追加します。

  関連事項:

  • InterceptorRegistry

• getPathMatchConfigurer

  protected PathMatchConfigurer getPathMatchConfigurer()

  PathMatchConfigurer をビルドするためのコールバック。configurePathMatch(PathMatchConfigurer) へのデリゲート。

  導入:

  4.1

• configurePathMatch

  protected void configurePathMatch(PathMatchConfigurer configurer)

  パス一致オプションを構成するには、このメソッドをオーバーライドします。

  導入:

  4.0.3

  関連事項:

  • PathMatchConfigurer

• mvcPatternParser

  @Bean public PathPatternParser mvcPatternParser()

  RequestPath に一致するパターンの解析に使用するグローバル PathPatternParser インスタンスを返します。返されるインスタンスは、configurePathMatch(PathMatchConfigurer) を使用して構成できます。

  導入:

  5.3.4

• mvcUrlPathHelper

  @DeprecatedSE(since="7.0", forRemoval=true) @Bean public UrlPathHelper mvcUrlPathHelper()

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

  PathMatcher および UrlPathHelper の使用は、Web モジュールでの実行時の使用では非推奨となり、代わりに PathPatternParser による解析パターンが推奨されます。

  アプリケーションのリクエストマッピングパスを解決するために使用されるグローバル UrlPathHelper インスタンスを返します。インスタンスは configurePathMatch(PathMatchConfigurer) を介して構成できます。

  注意 : これは、解析されたパターンが enabled でない場合にのみ使用されます。

  導入:

  4.1

• mvcPathMatcher

  @DeprecatedSE(since="7.0", forRemoval=true) @Bean public PathMatcher mvcPathMatcher()

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

  PathMatcher および UrlPathHelper の使用は、Web モジュールでの実行時の使用では非推奨となり、代わりに PathPatternParser による解析パターンが推奨されます。

  文字列パターンとの URL パスマッチングに使用されるグローバル PathMatcher インスタンスを返します。返されるインスタンスは、configurePathMatch(PathMatchConfigurer) を使用して構成できます。

  注意 : これは、解析されたパターンが enabled でない場合にのみ使用されます。

  導入:

  4.1

• mvcContentNegotiationManager

  @Bean public ContentNegotiationManager mvcContentNegotiationManager()

  指定されたリクエストでリクエストされたメディア型を判別するために使用する ContentNegotiationManager インスタンスを返します。

• getDefaultMediaTypes

  protected MapSE<StringSE, MediaType> getDefaultMediaTypes()

• configureContentNegotiation

  protected void configureContentNegotiation(ContentNegotiationConfigurer configurer)

  コンテンツネゴシエーションを構成するには、このメソッドをオーバーライドします。

  関連事項:

  • DefaultServletHandlerConfigurer

• mvcApiVersionStrategy

  @Bean public @Nullable ApiVersionStrategy mvcApiVersionStrategy()

  API のバージョン管理に使用する中心的な戦略を返します。アプリケーションでバージョン管理を使用しない場合は、null を返します。

  導入:

  7.0

• configureApiVersioning

  protected void configureApiVersioning(ApiVersionConfigurer configurer)

  API のバージョン管理を構成するには、このメソッドをオーバーライドします。

  導入:

  7.0

• viewControllerHandlerMapping

  @Bean public @Nullable HandlerMapping viewControllerHandlerMapping(@Qualifier("mvcConversionService") FormattingConversionService conversionService, @Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider)

  URL パスをビュー名に直接マップするために 1 の順序でハンドラーマッピングを返します。ビューコントローラーを構成するには、addViewControllers(ViewControllerRegistry) をオーバーライドします。

• addViewControllers

  protected void addViewControllers(ViewControllerRegistry registry)

  このメソッドをオーバーライドして、ビューコントローラーを追加します。

  関連事項:

  • ViewControllerRegistry

• beanNameHandlerMapping

  @Bean public BeanNameUrlHandlerMapping beanNameHandlerMapping(@Qualifier("mvcConversionService") FormattingConversionService conversionService, @Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider)

  URL パスをコントローラー Bean 名にマップするには、2 で順序付けされた BeanNameUrlHandlerMapping を返します。

• routerFunctionMapping

  @Bean public RouterFunctionMapping routerFunctionMapping(@Qualifier("mvcConversionService") FormattingConversionService conversionService, @Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider, @Qualifier("mvcApiVersionStrategy") @Nullable ApiVersionStrategy versionStrategy)

  ルーター関数をマップするために、-1 で順序付けされた RouterFunctionMapping を返します。他のより詳細なメソッドのいずれかをオーバーライドすることを検討してください。

  • ハンドラーインターセプタを追加するための addInterceptors(InterceptorRegistry)。
  • addCorsMappings(CorsRegistry) は、クロスオリジンリクエスト処理を構成します。
  • カスタムメッセージコンバーターを追加するための configureMessageConverters(HttpMessageConverters.ServerBuilder)。
  • PathPatternParser をカスタマイズするための configurePathMatch(PathMatchConfigurer)。

  導入:

  5.2

• resourceHandlerMapping

  @Bean public @Nullable HandlerMapping resourceHandlerMapping(@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager, @Qualifier("mvcConversionService") FormattingConversionService conversionService, @Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider)

  マップされたリソースハンドラーと共に Integer.MAX_VALUE-1 で順序付けされたハンドラーマッピングを返します。リソース処理を構成するには、addResourceHandlers(ResourceHandlerRegistry) をオーバーライドします。

• addResourceHandlers

  protected void addResourceHandlers(ResourceHandlerRegistry registry)

  このメソッドをオーバーライドして、静的リソースを提供するためのリソースハンドラーを追加します。

  関連事項:

  • ResourceHandlerRegistry

• mvcResourceUrlProvider

  @Bean public ResourceUrlProvider mvcResourceUrlProvider()

  MVC ディスパッチャーで使用する ResourceUrlProvider Bean。

  導入:

  4.1

• defaultServletHandlerMapping

  @Bean public @Nullable HandlerMapping defaultServletHandlerMapping()

  マップされたデフォルトのサーブレットハンドラーを使用して、Integer.MAX_VALUE で順序付けされたハンドラーマッピングを返します。"default" サーブレット処理を構成するには、configureDefaultServletHandling(DefaultServletHandlerConfigurer) をオーバーライドします。

• configureDefaultServletHandling

  protected void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)

  このメソッドをオーバーライドして、"default" サーブレット処理を構成します。

  関連事項:

  • DefaultServletHandlerConfigurer

• requestMappingHandlerAdapter

  @Bean public RequestMappingHandlerAdapter requestMappingHandlerAdapter(@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager, @Qualifier("mvcConversionService") FormattingConversionService conversionService, @Qualifier("mvcValidator") Validator validator)

  アノテーション付きコントローラーメソッドを介してリクエストを処理するための RequestMappingHandlerAdapter を返します。これらの他のよりきめの細かいメソッドの 1 つをオーバーライドすることを検討してください。

  • カスタム引数リゾルバーを追加するための addArgumentResolvers(List)。
  • カスタム戻り値ハンドラーを追加するための addReturnValueHandlers(List)。
  • カスタムメッセージコンバーターを追加するための configureMessageConverters(HttpMessageConverters.ServerBuilder)。

• createRequestMappingHandlerAdapter

  protected RequestMappingHandlerAdapter createRequestMappingHandlerAdapter()

  RequestMappingHandlerAdapter のカスタムサブクラスにプラグインするための protected メソッド。

  導入:

  4.3

• handlerFunctionAdapter

  @Bean public HandlerFunctionAdapter handlerFunctionAdapter()

  ハンドラー関数を介してリクエストを処理する場合は、HandlerFunctionAdapter を返します。

  導入:

  5.2

• getConfigurableWebBindingInitializer

  protected ConfigurableWebBindingInitializer getConfigurableWebBindingInitializer(FormattingConversionService mvcConversionService, Validator mvcValidator)

  すべての WebDataBinder インスタンスの初期化に使用する ConfigurableWebBindingInitializer を返します。

• getMessageCodesResolver

  protected @Nullable MessageCodesResolver getMessageCodesResolver()

  このメソッドをオーバーライドして、カスタム MessageCodesResolver を提供します。

• mvcConversionService

  @Bean public FormattingConversionService mvcConversionService()

  アノテーション付きコントローラーで使用するために FormattingConversionService を返します。

  このメソッドをオーバーライドする代わりの方法として addFormatters(FormatterRegistry) を参照してください。

• addFormatters

  protected void addFormatters(FormatterRegistry registry)

  このメソッドをオーバーライドして、共通の FormattingConversionService にカスタム Converter および / または Formatter デリゲートを追加します。

  関連事項:

  • mvcConversionService()

• mvcValidator

  @Bean public Validator mvcValidator()

  たとえば、@ModelAttribute および @RequestBody メソッドの引数を検証するために、グローバル Validator インスタンスを返します。最初に getValidator() にデリゲートし、それが null を返す場合、OptionalValidatorFactoryBean を作成する前にクラスパスで JSR-303 実装が存在するかどうかを確認します。JSR-303 実装が使用できない場合は、no-op Validator が返されます。

• getValidator

  protected @Nullable Validator getValidator()

  このメソッドをオーバーライドして、カスタム Validator を提供します。

• getArgumentResolvers

  protected final ListSE<HandlerMethodArgumentResolver> getArgumentResolvers()

  RequestMappingHandlerAdapter および ExceptionHandlerExceptionResolver が使用する共有カスタム引数リゾルバーへのアクセスを提供します。

  このメソッドはオーバーライドできません。代わりに addArgumentResolvers(List) を使用してください。

  導入:

  4.3

• addArgumentResolvers

  protected void addArgumentResolvers(ListSE<HandlerMethodArgumentResolver> argumentResolvers)

  デフォルトで登録されているものに加えて、使用するカスタム HandlerMethodArgumentResolvers を追加します。

  カスタム引数リゾルバーは、アノテーションの存在に依存するもの (たとえば、@RequestParameter、@PathVariable など) を除き、組み込みリゾルバーの前に呼び出されます。後者は、RequestMappingHandlerAdapter を直接構成することでカスタマイズできます。

  パラメーター:

  argumentResolvers - カスタムコンバーターのリスト (最初は空のリスト)

• getReturnValueHandlers

  protected final ListSE<HandlerMethodReturnValueHandler> getReturnValueHandlers()

  RequestMappingHandlerAdapter および ExceptionHandlerExceptionResolver で使用される共有戻り値ハンドラーへのアクセスを提供します。

  このメソッドはオーバーライドできません。代わりに addReturnValueHandlers(List) を使用してください。

  導入:

  4.3

• addReturnValueHandlers

  protected void addReturnValueHandlers(ListSE<HandlerMethodReturnValueHandler> returnValueHandlers)

  デフォルトで登録されているものに加えて、カスタム HandlerMethodReturnValueHandlers を追加します。

  カスタム戻り値ハンドラーは、アノテーションの存在に依存するハンドラー (たとえば、@ResponseBody、@ModelAttribute など) を除き、組み込みハンドラーの前に呼び出されます。後者は、RequestMappingHandlerAdapter を直接構成することでカスタマイズできます。

  パラメーター:

  returnValueHandlers - カスタムハンドラーのリスト (最初は空のリスト)

• getMessageConverters

  protected final ListSE<HttpMessageConverter<?>> getMessageConverters()

  RequestMappingHandlerAdapter および ExceptionHandlerExceptionResolver が使用する共有 HttpMessageConverters へのアクセスを提供します。

  このメソッドはオーバーライドできません。代わりに configureMessageConverters(HttpMessageConverters.ServerBuilder) を使用してください。デフォルトのメッセージコンバーターの追加については、addDefaultHttpMessageConverters(List) も参照してください。

• createMessageConverters

  protected HttpMessageConverters createMessageConverters()

  このメソッドをオーバーライドしてカスタム HttpMessageConverters を作成します。コンバーターは RequestMappingHandlerAdapter および ExceptionHandlerExceptionResolver で使用されます。

  デフォルトでは、クラスパス上に存在する場合、デフォルトのメッセージコンバーターが登録されたインスタンスが作成されます。

  導入:

  7.0

• configureMessageConverters

  protected void configureMessageConverters(HttpMessageConverters.ServerBuilder builder)

  指定された builder 上のメッセージコンバーターを構成するには、このメソッドをオーバーライドします。

  パラメーター:

  builder - HttpMessageConverters ビルダーを設定する

  導入:

  7.0

• configureMessageConverters

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

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

  7.0 以降、configureMessageConverters(HttpMessageConverters.ServerBuilder) を推奨

  RequestMappingHandlerAdapter および ExceptionHandlerExceptionResolver で使用するカスタム messsage converters を追加するには、このメソッドをオーバーライドします。

  リストにコンバーターを追加すると、デフォルトで登録されるデフォルトのコンバーターがオフになります。デフォルトのメッセージコンバーターの追加については、addDefaultHttpMessageConverters(List) も参照してください。

  パラメーター:

  converters - メッセージコンバーターを追加するリスト (最初は空のリスト)

• extendMessageConverters

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

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

  7.0 以降、configureMessageConverters(HttpMessageConverters.ServerBuilder) を推奨

  このメソッドをオーバーライドして、構成後にコンバーターのリストを継承または変更します。これは、デフォルトのコンバーターを登録して、このメソッドを介してカスタムコンバーターを挿入できるようにする場合などに役立ちます。

  パラメーター:

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

  導入:

  4.1.3

• addDefaultHttpMessageConverters

  @DeprecatedSE(since="7.0", forRemoval=true) protected final void addDefaultHttpMessageConverters(ListSE<HttpMessageConverter<?>> messageConverters)

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

  7.0 以降、createMessageConverters() を推奨

  指定されたリストにデフォルトの HttpMessageConverter インスタンスのセットを追加します。サブクラスは configureMessageConverters(HttpMessageConverters.ServerBuilder) からこのメソッドを呼び出すことができます。

  パラメーター:

  messageConverters - デフォルトのメッセージコンバーターを追加するリスト

• getAsyncSupportConfigurer

  protected AsyncSupportConfigurer getAsyncSupportConfigurer()

  AsyncSupportConfigurer をビルドするためのコールバック。configureAsyncSupport(AsyncSupportConfigurer) へのデリゲート。

  導入:

  5.3.2

• configureAsyncSupport

  protected void configureAsyncSupport(AsyncSupportConfigurer configurer)

  このメソッドをオーバーライドして、非同期リクエスト処理オプションを構成します。

  関連事項:

  • AsyncSupportConfigurer

• mvcUriComponentsContributor

  @Bean public CompositeUriComponentsContributor mvcUriComponentsContributor(@Qualifier("mvcConversionService") FormattingConversionService conversionService, @Qualifier("requestMappingHandlerAdapter") RequestMappingHandlerAdapter requestMappingHandlerAdapter)

  MvcUriComponentsBuilder で使用するために CompositeUriComponentsContributor のインスタンスを返します。

  導入:

  4.0

• httpRequestHandlerAdapter

  @Bean public HttpRequestHandlerAdapter httpRequestHandlerAdapter()

  HttpRequestHandlers でリクエストを処理するために HttpRequestHandlerAdapter を返します。

• simpleControllerHandlerAdapter

  @Bean public SimpleControllerHandlerAdapter simpleControllerHandlerAdapter()

  インターフェースベースのコントローラーでリクエストを処理するための SimpleControllerHandlerAdapter を返します。

• handlerExceptionResolver

  @Bean public HandlerExceptionResolver handlerExceptionResolver(@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager)

  configureHandlerExceptionResolvers(List) または addDefaultHandlerExceptionResolvers(List, ContentNegotiationManager) のいずれかで取得した例外リゾルバーのリストを含む HandlerExceptionResolverComposite を返します。

  注意 : この方法は、CGLIB の制約により、最終的にすることはできません。それをオーバーライドするのではなく、リゾルバーのリストを提供できる configureHandlerExceptionResolvers(List) をオーバーライドすることを検討してください。

• configureHandlerExceptionResolvers

  protected void configureHandlerExceptionResolvers(ListSE<HandlerExceptionResolver> exceptionResolvers)

  使用する HandlerExceptionResolvers のリストを構成するには、このメソッドをオーバーライドします。

  リストにリゾルバーを追加すると、デフォルトで登録されるデフォルトのリゾルバーがオフになります。デフォルトの例外リゾルバーを追加するために使用できる addDefaultHandlerExceptionResolvers(List, ContentNegotiationManager) も参照してください。

  パラメーター:

  exceptionResolvers - 例外リゾルバーを追加するリスト (最初は空のリスト)

• extendHandlerExceptionResolvers

  protected void extendHandlerExceptionResolvers(ListSE<HandlerExceptionResolver> exceptionResolvers)

  HandlerExceptionResolvers の構成後にリストを継承または変更するには、このメソッドをオーバーライドします。

  これは、たとえば、デフォルトのリゾルバーを登録し、このメソッドを介してカスタムのリゾルバーを挿入できるようにする場合に便利です。

  パラメーター:

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

  導入:

  4.3

• addDefaultHandlerExceptionResolvers

  protected final void addDefaultHandlerExceptionResolvers(ListSE<HandlerExceptionResolver> exceptionResolvers, ContentNegotiationManager mvcContentNegotiationManager)

  デフォルトの HandlerExceptionResolvers を追加するためにサブクラスで使用できるメソッド。

  次の例外リゾルバーを追加します。

  • ExceptionHandler メソッドを介して例外を処理するための ExceptionHandlerExceptionResolver。
  • ResponseStatus でアノテーションされた例外の場合は ResponseStatusExceptionResolver。
  • 既知の Spring 例外型を解決するための DefaultHandlerExceptionResolver

• createExceptionHandlerExceptionResolver

  protected ExceptionHandlerExceptionResolver createExceptionHandlerExceptionResolver()

  ExceptionHandlerExceptionResolver のカスタムサブクラスにプラグインするための protected メソッド。

  導入:

  4.3

• getErrorResponseInterceptors

  protected final ListSE<ErrorResponse.Interceptor> getErrorResponseInterceptors()

  エラーレスポンスをレンダリングするときに適用する ErrorResponse.Interceptor のリストへのアクセスを提供します。

  このメソッドはオーバーライドできません。代わりに configureErrorResponseInterceptors(List) を使用してください。

  導入:

  6.2

• configureErrorResponseInterceptors

  protected void configureErrorResponseInterceptors(ListSE<ErrorResponse.Interceptor> interceptors)

  エラーレスポンスをレンダリングするときに適用する ErrorResponse.Interceptor を制御するには、このメソッドをオーバーライドします。

  パラメーター:

  interceptors - ハンドラーを追加するリスト

  導入:

  6.2

• mvcViewResolver

  @Bean public ViewResolver mvcViewResolver(@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager)

  ビューの解決に使用するビューリゾルバーのチェーンを含む ViewResolverComposite を登録します。デフォルトでは、コンテンツネゴシエーションビューの解決が使用されていない限り、このリゾルバーは 0 で順序付けられます。使用されている場合、順序は Ordered.HIGHEST_PRECEDENCE にプルアップられます。

  他のリゾルバーが構成されていない場合、他の潜在的な ViewResolver Bean がビューを解決できるようにするために、ViewResolverComposite.resolveViewName(String, Locale) は null を返します。

  導入:

  4.1

• configureViewResolvers

  protected void configureViewResolvers(ViewResolverRegistry registry)

  このメソッドをオーバーライドして、ビューリゾルバーを構成します。

  関連事項:

  • ViewResolverRegistry

• getCorsConfigurations

  protected final MapSE<StringSE, CorsConfiguration> getCorsConfigurations()

  パスパターンをキーとして、登録されている CorsConfiguration オブジェクトを返します。

  導入:

  4.2

• addCorsMappings

  protected void addCorsMappings(CorsRegistry registry)

  このメソッドをオーバーライドして、クロスオリジンリクエスト処理を構成します。

  導入:

  4.2

  関連事項:

  • CorsRegistry

• mvcHandlerMappingIntrospector

  @Bean @Lazy public HandlerMappingIntrospector mvcHandlerMappingIntrospector()

• localeResolver

  @Bean public LocaleResolver localeResolver()

• flashMapManager

  @Bean public FlashMapManager flashMapManager()

• viewNameTranslator

  @Bean public RequestToViewNameTranslator viewNameTranslator()