@EnableWebMvc是什么
直接看源碼,@EnableWebMvc實際上引入一個DelegatingWebMvcConfiguration。
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Import({DelegatingWebMvcConfiguration.class})
public @interface EnableWebMvc {
}
DelegatingWebMvcConfiguration繼承了WebMvcConfigurationSupport
@Configuration
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
...
所以@EnableWebMvc=繼承DelegatingWebMvcConfiguration=繼承WebMvcConfigurationSupport
@EnableWebMvc和@EnableAutoConfiguration的關系
@EnableAutoConfiguration是springboot項目的啟動類注解@SpringBootApplication的子元素，主要功能為自動配置。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
excludeFilters = {@Filter(
type = FilterType.CUSTOM,
classes = {TypeExcludeFilter.class}
), @Filter(
type = FilterType.CUSTOM,
classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
...
}
@EnableAutoConfiguration實際是導入了EnableAutoConfigurationImportSelector和Registrar兩個類
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
...
}
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import({Registrar.class})
public @interface AutoConfigurationPackage {
}
這兩個類的具體原理有些復雜，不太清除，主要內容是通過SpringFactoriesLoader.loadFactoryNames()導入jar下面的配置文件META-INF/spring.factories
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
return configurations;
}
配置文件中的內容如下
# Auto Configure org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\ ... org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\ org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration,\ org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,\ ...
其中有WebMvcAutoConfiguration,WebMvcAutoConfiguration源碼如下
@Configuration
@ConditionalOnWebApplication(
type = Type.SERVLET
)
@ConditionalOnClass({Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class})
@ConditionalOnMissingBean({WebMvcConfigurationSupport.class})
@AutoConfigureOrder(-2147483638)
@AutoConfigureAfter({DispatcherServletAutoConfiguration.class, ValidationAutoConfiguration.class})
public class WebMvcAutoConfiguration {
...
}
@ConditionalOnMissingBean({WebMvcConfigurationSupport.class})意思是如果存在它修飾的類的bean
,則不需要再創建這個bean。
由此可得出結論：
如果有配置文件繼承了DelegatingWebMvcConfiguration，
或者WebMvcConfigurationSupport，或者配置文件有@EnableWebMvc，那么 @EnableAutoConfiguration 中的
WebMvcAutoConfiguration 將不會被自動配置，而是使用WebMvcConfigurationSupport的配置。
@EnableWebMvc,WebMvcConfigurationSupport,WebMvcConfigurer和WebMvcConfigurationAdapter使用
WebMvcConfigurationAdapter已經廢棄，最好用implements WebMvcConfigurer代替
@Configuration
public class MyConfig implements WebMvcConfigurer {
}
如果使用繼承,WebMvcConfigurationSupport，DelegatingWebMvcConfiguration，或者使用@EnableWebMvc，
需要注意會覆蓋application.properties中關於WebMvcAutoConfiguration的設置，需要在自定義配置中實現，如
springboot2.0、spring5.0 攔截器配置WebMvcConfigurerAdapter過時使用WebMvcConfigurationSupport來代替 新坑
示例如下
Configuration
@EnableWebMvc
public class MyConfig implements WebMvcConfigurer {
}
@Configuration
public class MyConfig extends WebMvcConfigurationSupport {
}
@Configuration
public class MyConfig extends DelegatingWebMvcConfiguration {
}
上面代碼中需要在類中實現關於WebMvcAutoConfiguration的配置，而不是在application.properties中。
總結
implements WebMvcConfigurer ： 不會覆蓋@EnableAutoConfiguration關於WebMvcAutoConfiguration的配置
@EnableWebMvc + implements WebMvcConfigurer ： 會覆蓋@EnableAutoConfiguration關於WebMvcAutoConfiguration的配置
extends WebMvcConfigurationSupport ：會覆蓋@EnableAutoConfiguration關於WebMvcAutoConfiguration的配置
extends DelegatingWebMvcConfiguration ：會覆蓋@EnableAutoConfiguration關於WebMvcAutoConfiguration的配置