org.springframework.web.servlet.config.annotation.EnableWebMvc Maven / Gradle / Ivy
/*
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.servlet.config.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.context.annotation.Import;
/**
* Adding this annotation to an {@code @Configuration} class imports the Spring MVC
* configuration from {@link WebMvcConfigurationSupport}, e.g.:
*
*
* @Configuration
* @EnableWebMvc
* @ComponentScan(basePackageClasses = MyConfiguration.class)
* public class MyConfiguration {
* }
*
*
* To customize the imported configuration, implement the interface
* {@link WebMvcConfigurer} and override individual methods, e.g.:
*
*
* @Configuration
* @EnableWebMvc
* @ComponentScan(basePackageClasses = MyConfiguration.class)
* public class MyConfiguration implements WebMvcConfigurer {
*
* @Override
* public void addFormatters(FormatterRegistry formatterRegistry) {
* formatterRegistry.addConverter(new MyConverter());
* }
*
* @Override
* public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
* converters.add(new MyHttpMessageConverter());
* }
*
* }
*
*
* Note: only one {@code @Configuration} class may have the
* {@code @EnableWebMvc} annotation to import the Spring Web MVC
* configuration. There can however be multiple {@code @Configuration} classes
* implementing {@code WebMvcConfigurer} in order to customize the provided
* configuration.
*
*
If {@link WebMvcConfigurer} does not expose some more advanced setting that
* needs to be configured, consider removing the {@code @EnableWebMvc}
* annotation and extending directly from {@link WebMvcConfigurationSupport}
* or {@link DelegatingWebMvcConfiguration}, e.g.:
*
*
* @Configuration
* @ComponentScan(basePackageClasses = { MyConfiguration.class })
* public class MyConfiguration extends WebMvcConfigurationSupport {
*
* @Override
* public void addFormatters(FormatterRegistry formatterRegistry) {
* formatterRegistry.addConverter(new MyConverter());
* }
*
* @Bean
* public RequestMappingHandlerAdapter requestMappingHandlerAdapter() {
* // Create or delegate to "super" to create and
* // customize properties of RequestMappingHandlerAdapter
* }
* }
*
*
* @author Dave Syer
* @author Rossen Stoyanchev
* @since 3.1
* @see org.springframework.web.servlet.config.annotation.WebMvcConfigurer
* @see org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport
* @see org.springframework.web.servlet.config.annotation.DelegatingWebMvcConfiguration
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}