类 WebMvcConfigurationSupport

构造器详细资料

• WebMvcConfigurationSupport

  public WebMvcConfigurationSupport()

方法详细资料

• setApplicationContext

  public void setApplicationContext​(@Nullable
                                    ApplicationContext applicationContext)

  Set the Spring ApplicationContext, e.g. for resource loading.

  指定者:

  setApplicationContext 在接口中 ApplicationContextAware

  参数:

  applicationContext - the ApplicationContext object to be used by this object

  另请参阅:

  BeanInitializationException

• getApplicationContext

  @Nullable
  public final ApplicationContext getApplicationContext()

  Return the associated Spring ApplicationContext.

  从以下版本开始:

  4.2

• setServletContext

  public void setServletContext​(@Nullable
                                ServletContext servletContext)

  Set the ServletContext, e.g. for resource handling, looking up file extensions, etc.

  指定者:

  setServletContext 在接口中 ServletContextAware

  参数:

  servletContext - the ServletContext object to be used by this object

  另请参阅:

  InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)

• getServletContext

  @Nullable
  public final ServletContext getServletContext()

  Return the associated ServletContext.

  从以下版本开始:

  4.2

• requestMappingHandlerMapping

  @Bean
  public RequestMappingHandlerMapping requestMappingHandlerMapping​(@Qualifier("mvcContentNegotiationManager")
                                                                   ContentNegotiationManager contentNegotiationManager,
                                                                   @Qualifier("mvcConversionService")
                                                                   FormattingConversionService conversionService,
                                                                   @Qualifier("mvcResourceUrlProvider")
                                                                   ResourceUrlProvider resourceUrlProvider)

  Return a RequestMappingHandlerMapping ordered at 0 for mapping requests to annotated controllers.

• createRequestMappingHandlerMapping

  protected RequestMappingHandlerMapping createRequestMappingHandlerMapping()

  Protected method for plugging in a custom subclass of RequestMappingHandlerMapping.

  从以下版本开始:

  4.0

• getInterceptors

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

  Provide access to the shared handler interceptors used to configure HandlerMapping instances with.

  This method cannot be overridden; use addInterceptors(org.springframework.web.servlet.config.annotation.InterceptorRegistry) instead.

• addInterceptors

  protected void addInterceptors​(InterceptorRegistry registry)

  Override this method to add Spring MVC interceptors for pre- and post-processing of controller invocation.

  另请参阅:

  InterceptorRegistry

• getPathMatchConfigurer

  protected PathMatchConfigurer getPathMatchConfigurer()

  Callback for building the PathMatchConfigurer. Delegates to configurePathMatch(org.springframework.web.servlet.config.annotation.PathMatchConfigurer).

  从以下版本开始:

  4.1

• configurePathMatch

  protected void configurePathMatch​(PathMatchConfigurer configurer)

  Override this method to configure path matching options.

  从以下版本开始:

  4.0.3

  另请参阅:

  PathMatchConfigurer

• mvcPathMatcher

  @Bean
  public PathMatcher mvcPathMatcher()

  Return a global PathMatcher instance for path matching patterns in HandlerMappings. This instance can be configured using the PathMatchConfigurer in configurePathMatch(PathMatchConfigurer).

  从以下版本开始:

  4.1

• mvcUrlPathHelper

  @Bean
  public UrlPathHelper mvcUrlPathHelper()

  Return a global UrlPathHelper instance for path matching patterns in HandlerMappings. This instance can be configured using the PathMatchConfigurer in configurePathMatch(PathMatchConfigurer).

  从以下版本开始:

  4.1

• mvcContentNegotiationManager

  @Bean
  public ContentNegotiationManager mvcContentNegotiationManager()

  Return a ContentNegotiationManager instance to use to determine requested media types in a given request.

• getDefaultMediaTypes

  protected Map<String,​MediaType> getDefaultMediaTypes()

• configureContentNegotiation

  protected void configureContentNegotiation​(ContentNegotiationConfigurer configurer)

  Override this method to configure content negotiation.

  另请参阅:

  DefaultServletHandlerConfigurer

• viewControllerHandlerMapping

  @Bean
  @Nullable
  public HandlerMapping viewControllerHandlerMapping​(@Qualifier("mvcPathMatcher")
                                                     PathMatcher pathMatcher,
                                                     @Qualifier("mvcUrlPathHelper")
                                                     UrlPathHelper urlPathHelper,
                                                     @Qualifier("mvcConversionService")
                                                     FormattingConversionService conversionService,
                                                     @Qualifier("mvcResourceUrlProvider")
                                                     ResourceUrlProvider resourceUrlProvider)

  Return a handler mapping ordered at 1 to map URL paths directly to view names. To configure view controllers, override addViewControllers(org.springframework.web.servlet.config.annotation.ViewControllerRegistry).

• addViewControllers

  protected void addViewControllers​(ViewControllerRegistry registry)

  Override this method to add view controllers.

  另请参阅:

  ViewControllerRegistry

• beanNameHandlerMapping

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

  Return a BeanNameUrlHandlerMapping ordered at 2 to map URL paths to controller bean names.

• routerFunctionMapping

  @Bean
  public RouterFunctionMapping routerFunctionMapping​(@Qualifier("mvcConversionService")
                                                     FormattingConversionService conversionService,
                                                     @Qualifier("mvcResourceUrlProvider")
                                                     ResourceUrlProvider resourceUrlProvider)

  Return a RouterFunctionMapping ordered at 3 to map router functions. Consider overriding one of these other more fine-grained methods:

  • addInterceptors(org.springframework.web.servlet.config.annotation.InterceptorRegistry) for adding handler interceptors.
  • addCorsMappings(org.springframework.web.servlet.config.annotation.CorsRegistry) to configure cross origin requests processing.
  • configureMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>>) for adding custom message converters.

  从以下版本开始:

  5.2

• resourceHandlerMapping

  @Bean
  @Nullable
  public HandlerMapping resourceHandlerMapping​(@Qualifier("mvcUrlPathHelper")
                                               UrlPathHelper urlPathHelper,
                                               @Qualifier("mvcPathMatcher")
                                               PathMatcher pathMatcher,
                                               @Qualifier("mvcContentNegotiationManager")
                                               ContentNegotiationManager contentNegotiationManager,
                                               @Qualifier("mvcConversionService")
                                               FormattingConversionService conversionService,
                                               @Qualifier("mvcResourceUrlProvider")
                                               ResourceUrlProvider resourceUrlProvider)

  Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers. To configure resource handling, override addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry).

• addResourceHandlers

  protected void addResourceHandlers​(ResourceHandlerRegistry registry)

  Override this method to add resource handlers for serving static resources.

  另请参阅:

  ResourceHandlerRegistry

• mvcResourceUrlProvider

  @Bean
  public ResourceUrlProvider mvcResourceUrlProvider()

  A ResourceUrlProvider bean for use with the MVC dispatcher.

  从以下版本开始:

  4.1

• defaultServletHandlerMapping

  @Bean
  @Nullable
  public HandlerMapping defaultServletHandlerMapping()

  Return a handler mapping ordered at Integer.MAX_VALUE with a mapped default servlet handler. To configure "default" Servlet handling, override configureDefaultServletHandling(org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer).

• configureDefaultServletHandling

  protected void configureDefaultServletHandling​(DefaultServletHandlerConfigurer configurer)

  Override this method to configure "default" Servlet handling.

  另请参阅:

  DefaultServletHandlerConfigurer

• requestMappingHandlerAdapter

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

  Returns a RequestMappingHandlerAdapter for processing requests through annotated controller methods. Consider overriding one of these other more fine-grained methods:

  • addArgumentResolvers(java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver>) for adding custom argument resolvers.
  • addReturnValueHandlers(java.util.List<org.springframework.web.method.support.HandlerMethodReturnValueHandler>) for adding custom return value handlers.
  • configureMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>>) for adding custom message converters.

• createRequestMappingHandlerAdapter

  protected RequestMappingHandlerAdapter createRequestMappingHandlerAdapter()

  Protected method for plugging in a custom subclass of RequestMappingHandlerAdapter.

  从以下版本开始:

  4.3

• handlerFunctionAdapter

  @Bean
  public HandlerFunctionAdapter handlerFunctionAdapter()

  Returns a HandlerFunctionAdapter for processing requests through handler functions.

  从以下版本开始:

  5.2

• getConfigurableWebBindingInitializer

  protected ConfigurableWebBindingInitializer getConfigurableWebBindingInitializer​(FormattingConversionService mvcConversionService,
                                                                                   Validator mvcValidator)

  Return the ConfigurableWebBindingInitializer to use for initializing all WebDataBinder instances.

• getMessageCodesResolver

  @Nullable
  protected MessageCodesResolver getMessageCodesResolver()

  Override this method to provide a custom MessageCodesResolver.

• configureAsyncSupport

  protected void configureAsyncSupport​(AsyncSupportConfigurer configurer)

  Override this method to configure asynchronous request processing options.

  另请参阅:

  AsyncSupportConfigurer

• mvcConversionService

  @Bean
  public FormattingConversionService mvcConversionService()

  Return a FormattingConversionService for use with annotated controllers.

  See addFormatters(org.springframework.format.FormatterRegistry) as an alternative to overriding this method.

• addFormatters

  protected void addFormatters​(FormatterRegistry registry)

  Override this method to add custom Converter and/or Formatter delegates to the common FormattingConversionService.

  另请参阅:

  mvcConversionService()

• mvcValidator

  @Bean
  public Validator mvcValidator()

  Return a global Validator instance for example for validating @ModelAttribute and @RequestBody method arguments. Delegates to getValidator() first and if that returns null checks the classpath for the presence of a JSR-303 implementations before creating a OptionalValidatorFactoryBean.If a JSR-303 implementation is not available, a no-op Validator is returned.

• getValidator

  @Nullable
  protected Validator getValidator()

  Override this method to provide a custom Validator.

• getArgumentResolvers

  protected final List<HandlerMethodArgumentResolver> getArgumentResolvers()

  Provide access to the shared custom argument resolvers used by the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.

  This method cannot be overridden; use addArgumentResolvers(java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver>) instead.

  从以下版本开始:

  4.3

• addArgumentResolvers

  protected void addArgumentResolvers​(List<HandlerMethodArgumentResolver> argumentResolvers)

  Add custom HandlerMethodArgumentResolvers to use in addition to the ones registered by default.

  Custom argument resolvers are invoked before built-in resolvers except for those that rely on the presence of annotations (e.g. @RequestParameter, @PathVariable, etc). The latter can be customized by configuring the RequestMappingHandlerAdapter directly.

  参数:

  argumentResolvers - the list of custom converters (initially an empty list)

• getReturnValueHandlers

  protected final List<HandlerMethodReturnValueHandler> getReturnValueHandlers()

  Provide access to the shared return value handlers used by the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.

  This method cannot be overridden; use addReturnValueHandlers(java.util.List<org.springframework.web.method.support.HandlerMethodReturnValueHandler>) instead.

  从以下版本开始:

  4.3

• addReturnValueHandlers

  protected void addReturnValueHandlers​(List<HandlerMethodReturnValueHandler> returnValueHandlers)

  Add custom HandlerMethodReturnValueHandlers in addition to the ones registered by default.

  Custom return value handlers are invoked before built-in ones except for those that rely on the presence of annotations (e.g. @ResponseBody, @ModelAttribute, etc). The latter can be customized by configuring the RequestMappingHandlerAdapter directly.

  参数:

  returnValueHandlers - the list of custom handlers (initially an empty list)

• getMessageConverters

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

  Provides access to the shared HttpMessageConverters used by the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.

  This method cannot be overridden; use configureMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>>) instead. Also see addDefaultHttpMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>>) for adding default message converters.

• configureMessageConverters

  protected void configureMessageConverters​(List<HttpMessageConverter<?>> converters)

  Override this method to add custom HttpMessageConverters to use with the RequestMappingHandlerAdapter and the ExceptionHandlerExceptionResolver.

  Adding converters to the list turns off the default converters that would otherwise be registered by default. Also see addDefaultHttpMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>>) for adding default message converters.

  参数:

  converters - a list to add message converters to (initially an empty list)

• extendMessageConverters

  protected void extendMessageConverters​(List<HttpMessageConverter<?>> converters)

  Override this method to extend or modify the list of converters after it has been configured. This may be useful for example to allow default converters to be registered and then insert a custom converter through this method.

  参数:

  converters - the list of configured converters to extend

  从以下版本开始:

  4.1.3

• addDefaultHttpMessageConverters

  protected final void addDefaultHttpMessageConverters​(List<HttpMessageConverter<?>> messageConverters)

  Adds a set of default HttpMessageConverter instances to the given list. Subclasses can call this method from configureMessageConverters(java.util.List<org.springframework.http.converter.HttpMessageConverter<?>>).

  参数:

  messageConverters - the list to add the default message converters to

• mvcUriComponentsContributor

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

  Return an instance of CompositeUriComponentsContributor for use with MvcUriComponentsBuilder.

  从以下版本开始:

  4.0

• httpRequestHandlerAdapter

  @Bean
  public HttpRequestHandlerAdapter httpRequestHandlerAdapter()

  Returns a HttpRequestHandlerAdapter for processing requests with HttpRequestHandlers.

• simpleControllerHandlerAdapter

  @Bean
  public SimpleControllerHandlerAdapter simpleControllerHandlerAdapter()

  Returns a SimpleControllerHandlerAdapter for processing requests with interface-based controllers.

• handlerExceptionResolver

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

  Returns a HandlerExceptionResolverComposite containing a list of exception resolvers obtained either through configureHandlerExceptionResolvers(java.util.List<org.springframework.web.servlet.HandlerExceptionResolver>) or through addDefaultHandlerExceptionResolvers(java.util.List<org.springframework.web.servlet.HandlerExceptionResolver>, org.springframework.web.accept.ContentNegotiationManager).

  Note: This method cannot be made final due to CGLIB constraints. Rather than overriding it, consider overriding configureHandlerExceptionResolvers(java.util.List<org.springframework.web.servlet.HandlerExceptionResolver>) which allows for providing a list of resolvers.

• configureHandlerExceptionResolvers

  protected void configureHandlerExceptionResolvers​(List<HandlerExceptionResolver> exceptionResolvers)

  Override this method to configure the list of HandlerExceptionResolvers to use.

  Adding resolvers to the list turns off the default resolvers that would otherwise be registered by default. Also see addDefaultHandlerExceptionResolvers(java.util.List<org.springframework.web.servlet.HandlerExceptionResolver>, org.springframework.web.accept.ContentNegotiationManager) that can be used to add the default exception resolvers.

  参数:

  exceptionResolvers - a list to add exception resolvers to (initially an empty list)

• extendHandlerExceptionResolvers

  protected void extendHandlerExceptionResolvers​(List<HandlerExceptionResolver> exceptionResolvers)

  Override this method to extend or modify the list of HandlerExceptionResolvers after it has been configured.

  This may be useful for example to allow default resolvers to be registered and then insert a custom one through this method.

  参数:

  exceptionResolvers - the list of configured resolvers to extend.

  从以下版本开始:

  4.3

• addDefaultHandlerExceptionResolvers

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

  A method available to subclasses for adding default HandlerExceptionResolvers.

  Adds the following exception resolvers:

  • ExceptionHandlerExceptionResolver for handling exceptions through ExceptionHandler methods.
  • ResponseStatusExceptionResolver for exceptions annotated with ResponseStatus.
  • DefaultHandlerExceptionResolver for resolving known Spring exception types

• createExceptionHandlerExceptionResolver

  protected ExceptionHandlerExceptionResolver createExceptionHandlerExceptionResolver()

  Protected method for plugging in a custom subclass of ExceptionHandlerExceptionResolver.

  从以下版本开始:

  4.3

• mvcViewResolver

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

  Register a ViewResolverComposite that contains a chain of view resolvers to use for view resolution. By default this resolver is ordered at 0 unless content negotiation view resolution is used in which case the order is raised to Ordered.HIGHEST_PRECEDENCE.

  If no other resolvers are configured, ViewResolverComposite.resolveViewName(String, Locale) returns null in order to allow other potential ViewResolver beans to resolve views.

  从以下版本开始:

  4.1

• configureViewResolvers

  protected void configureViewResolvers​(ViewResolverRegistry registry)

  Override this method to configure view resolution.

  另请参阅:

  ViewResolverRegistry

• getCorsConfigurations

  protected final Map<String,​CorsConfiguration> getCorsConfigurations()

  Return the registered CorsConfiguration objects, keyed by path pattern.

  从以下版本开始:

  4.2

• addCorsMappings

  protected void addCorsMappings​(CorsRegistry registry)

  Override this method to configure cross origin requests processing.

  从以下版本开始:

  4.2

  另请参阅:

  CorsRegistry

• mvcHandlerMappingIntrospector

  @Bean
  @Lazy
  public HandlerMappingIntrospector mvcHandlerMappingIntrospector()