- Interface WebMvcConfigurer
- Method Summary
- Method Details
- configurePathMatch
- configureContentNegotiation
- configureAsyncSupport
- configureDefaultServletHandling
- addFormatters
- addInterceptors
- addResourceHandlers
- addCorsMappings
- addViewControllers
- configureViewResolvers
- addArgumentResolvers
- addReturnValueHandlers
- configureMessageConverters
- extendMessageConverters
- configureHandlerExceptionResolvers
- extendHandlerExceptionResolvers
- getValidator
- getMessageCodesResolver
Interface WebMvcConfigurer
Defines callback methods to customize the Java-based configuration for Spring MVC enabled via @EnableWebMvc .
@EnableWebMvc -annotated configuration classes may implement this interface to be called back and given a chance to customize the default configuration.
Method Summary
Add Spring MVC lifecycle interceptors for pre- and post-processing of controller method invocations and resource handler requests.
Add handlers to serve static resources such as images, js, and, css files from specific locations under web application root, the classpath, and others.
Configure simple automated controllers pre-configured with the response status code and/or a view to render the response body.
Configure a handler to delegate unhandled requests by forwarding to the Servlet container’s «default» servlet.
Configure the HttpMessageConverter s for reading from the request body and for writing to the response body.
Help with configuring HandlerMapping path matching options such as whether to use parsed PathPatterns or String pattern matching with PathMatcher , whether to match trailing slashes, and more.
Configure view resolvers to translate String-based view names returned from controllers into concrete View implementations to perform rendering with.
Extend or modify the list of converters after it has been, either configured or initialized with a default list.
Provide a custom MessageCodesResolver for building message codes from data binding and validation error codes.
Method Details
configurePathMatch
Help with configuring HandlerMapping path matching options such as whether to use parsed PathPatterns or String pattern matching with PathMatcher , whether to match trailing slashes, and more.
configureContentNegotiation
configureAsyncSupport
configureDefaultServletHandling
Configure a handler to delegate unhandled requests by forwarding to the Servlet container’s «default» servlet. A common use case for this is when the DispatcherServlet is mapped to «/» thus overriding the Servlet container’s default handling of static resources.
addFormatters
addInterceptors
Add Spring MVC lifecycle interceptors for pre- and post-processing of controller method invocations and resource handler requests. Interceptors can be registered to apply to all requests or be limited to a subset of URL patterns.
addResourceHandlers
Add handlers to serve static resources such as images, js, and, css files from specific locations under web application root, the classpath, and others.
addCorsMappings
Configure «global» cross-origin request processing. The configured CORS mappings apply to annotated controllers, functional endpoints, and static resources. Annotated controllers can further declare more fine-grained config via @CrossOrigin . In such cases «global» CORS configuration declared here is combined with local CORS configuration defined on a controller method.
addViewControllers
Configure simple automated controllers pre-configured with the response status code and/or a view to render the response body. This is useful in cases where there is no need for custom controller logic — e.g. render a home page, perform simple site URL redirects, return a 404 status with HTML content, a 204 with no content, and more.
configureViewResolvers
Configure view resolvers to translate String-based view names returned from controllers into concrete View implementations to perform rendering with.
addArgumentResolvers
Add resolvers to support custom controller method argument types. This does not override the built-in support for resolving handler method arguments. To customize the built-in support for argument resolution, configure RequestMappingHandlerAdapter directly.
addReturnValueHandlers
Add handlers to support custom controller method return value types. Using this option does not override the built-in support for handling return values. To customize the built-in support for handling return values, configure RequestMappingHandlerAdapter directly.
configureMessageConverters
Configure the HttpMessageConverter s for reading from the request body and for writing to the response body. By default, all built-in converters are configured as long as the corresponding 3rd party libraries such Jackson JSON, JAXB2, and others are present on the classpath. Note that use of this method turns off default converter registration. However, in a Spring Boot application the WebMvcAutoConfiguration adds any HttpMessageConverter beans as well as default converters. Hence, in a Boot application use HttpMessageConverters. Alternatively, for any scenario, use extendMessageConverters(java.util.List) to modify the configured list of message converters.
extendMessageConverters
Extend or modify the list of converters after it has been, either configured or initialized with a default list. Note that the order of converter registration is important. Especially in cases where clients accept MediaType.ALL the converters configured earlier will be preferred.
configureHandlerExceptionResolvers
Configure exception resolvers. The given list starts out empty. If it is left empty, the framework configures a default set of resolvers, see WebMvcConfigurationSupport.addDefaultHandlerExceptionResolvers(List, org.springframework.web.accept.ContentNegotiationManager) . Or if any exception resolvers are added to the list, then the application effectively takes over and must provide, fully initialized, exception resolvers. Alternatively you can use extendHandlerExceptionResolvers(List) which allows you to extend or modify the list of exception resolvers configured by default.
extendHandlerExceptionResolvers
Extending or modify the list of exception resolvers configured by default. This can be useful for inserting a custom exception resolver without interfering with default ones.
getValidator
Provide a custom Validator instead of the one created by default. The default implementation, assuming JSR-303 is on the classpath, is: OptionalValidatorFactoryBean . Leave the return value as null to keep the default.
getMessageCodesResolver
Provide a custom MessageCodesResolver for building message codes from data binding and validation error codes. Leave the return value as null to keep the default.