本章目的
探索springboot背后的注解料睛,逐漸解開其神秘面紗垮抗。
系統(tǒng)版本
- jdk1.8
- springboot 2.1.6.RELEASE
- 開發(fā)工具(IntelliJ IDEA 2018.1.5 x64)
- apache maven(3.6.0,本章采用maven形式管理jar包,具體配置環(huán)境變量以及使用請自行查找資料)
開始。。价说。
我們首先分析入口類Application的啟動注解@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 {
...
}
顯然 @SpringBootApplication
是一個復(fù)合注解澡匪,包括以下三個注解:
- @SpringBootConfiguration
- @EnableAutoConfiguration
- @ComponentScan
下面我們一起來看下
@SpringBootConfiguration
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}
@SpringBootConfiguration
繼承自@Configuration熔任,二者功能也一致,標(biāo)注當(dāng)前類是配置類唁情,
并會將當(dāng)前類內(nèi)聲明的一個或多個以@Bean注解標(biāo)記的方法的實例納入到spring容器中疑苔,并且實例名就是方法名。
@ComponentScan
@ComponentScan
自動掃描并加載符合條件的組件(比如@Component和@Repository等)或者bean定義甸鸟,最終將這些bean定義加載到IoC容器中惦费。是以前的<context:component-scan>(以前使用在XML中使用的標(biāo)簽兵迅,用來掃描包配置的平行支持)。
我們可以通過basePackages等屬性來細(xì)粒度的定制@ComponentScan自動掃描的范圍薪贫,如果不指定恍箭,則默認(rèn)Spring框架實現(xiàn)會從聲明@ComponentScan所在類的package進行掃描。
這兩個注解瞧省,并不是 springboot特有的扯夭,spring時代已經(jīng)有了,對我們來說并不陌生鞍匾,今天咱們的主角是:@EnableAutoConfiguration
@EnableAutoConfiguration
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
//是否開啟自動裝配 默認(rèn)為true交洗,可在yml文件中設(shè)置
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
//根據(jù)class來排除
Class<?>[] exclude() default {};
//根據(jù)class name來排除
String[] excludeName() default {};
}
@EnableAutoConfiguration
自動配置是springboot的最大亮點,完美的展示了CoC約定由于配置橡淑。此注解构拳,正是開啟自動配置的核心。
從源碼中梁棠,可以看到注解@Import置森,@Import(AutoConfigurationImportSelector.class)
@AutoConfigurationImportSelector
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
...
AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,
annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata,
AnnotationMetadata annotationMetadata) {
...
//獲取類路徑下spring.factories下key為EnableAutoConfiguration全限定名對應(yīng)值
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
...
}
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
//EnableAutoConfiguration.class
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
getBeanClassLoader());
...
}
@SpringFactoriesLoader
public static <T> List<T> loadFactories(Class<T> factoryClass, @Nullable ClassLoader classLoader) {
...
List<String> factoryNames = loadFactoryNames(factoryClass, classLoaderToUse);
...
}
public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
String factoryClassName = factoryClass.getName();
return loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
}
private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
...
//讀取META-INF/spring.factories文件的配置,并返回一個字符串?dāng)?shù)組
Enumeration<URL> urls = (classLoader != null ?
classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
result = new LinkedMultiValueMap<>();
...
}
至此符糊,springboot自動裝配的神秘面紗已經(jīng)解開凫海。
總結(jié):@EnableAutoConfiguration作用
- 從classpath中搜索所有META-INF/spring.factories配置文件,將其中key為org.springframework.boot.autoconfigure.EnableAutoConfiguration對應(yīng)的配置項加載到spring容器濒蒋。
- spring.boot.enableautoconfiguration為true(默認(rèn)為true)的時候盐碱,才啟用自動配置
- 自定義排除某些不需要的自動配置
- 根據(jù)class來排除(exclude)
- 根據(jù)class name來排除(excludeName)
代碼關(guān)鍵點
- ImportSelector(AutoConfigurationImportSelector) 該接口的方法的返回值都會被納入到spring容器管理中
- SpringFactoriesLoader 從classpath中搜索所有META-INF/spring.factories配置文件把兔,并讀取配置沪伙。
疑問
-
@import
、ImportSelector
县好、ImportBeanDefinitionRegistrar
各有什么用围橡? - spring的
bpp
是什么? -
Enable*
的原理是什么缕贡?
下一章翁授,我們帶著這些疑問,繼續(xù)探索源碼晾咪。