神秘又強(qiáng)大的@SpringBootApplication注解
[導(dǎo)讀]作者：vivo?互聯(lián)網(wǎng)服務(wù)器團(tuán)隊(duì)-Pengpeng一、前言大部分的配置都可以用Java類注解來代替，而在SpringBoot項(xiàng)目中見的最多的莫過于@SpringBootApplication注解了，它在每個SpringBoot的啟動類上都有標(biāo)注。這個注解對SpringBoot的啟...
作者：vivo?互聯(lián)網(wǎng)服務(wù)器團(tuán)隊(duì)-Peng peng
一、前言
大部分的配置都可以用Java類 注解來代替，而在SpringBoot項(xiàng)目中見的最多的莫過于@SpringBootApplication注解了，它在每個SpringBoot的啟動類上都有標(biāo)注。
這個注解對SpringBoot的啟動和自動配置到底有什么樣的影響呢？本文將為各位大佬解析它的源碼，揭開@SpringBootApplication注解神秘的面紗。
二、正文
對SpringBoot工程的自動配置很感興趣，于是學(xué)習(xí)其源碼并整理了其中一些內(nèi)容，如果有錯誤請大家指正~話不多說，直接上源碼；
@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 {...}可以看到這是一個復(fù)合注解，一共包括7個不同的注解，下面對這7個不同的注解進(jìn)行分析。
2.1 注解?
2.1.1 注解1：@Target({ElementType.TYPE})
用來表示注解作用范圍，TYPE表示作用范圍為類或接口。
2.1.2 注解2：@Retention(RetentionPolicy.RUNTIME)2.1.3 注解3：@Documented表明這個注釋是由 javadoc記錄的。
2.1.4 注解4：@Inherited放在注解上，當(dāng)父類加了@SpringBootApplication注解時，子類也會繼承這個注解（對接口的實(shí)現(xiàn)類無效）。
2.1.5 注解5：@SpringBootConfiguration底層仍是@Configuration注解, 源碼如下：
@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Configurationpublic @interface SpringBootConfiguration {}2.1.6 注解6：@ComponetScan
@ComponentScan這個注解在Spring中很重要，它對應(yīng)XML配置中的元素@ComponentScan的功能其實(shí)就是自動掃描并加載符合條件的組件（比如@Component和@Repository等）或者bean定義，最終將這些bean定義加載到IoC容器中。
可以通過basePackages等屬性來細(xì)粒度的定制@ComponentScan自動掃描的范圍，如果不指定，則默認(rèn)Spring框架實(shí)現(xiàn)會從聲明@ComponentScan所在類的package進(jìn)行掃描。所以SpringBoot的啟動類最好是放在root package下，因?yàn)槟J(rèn)不指定basePackages。
2.2 注解：@EnableAutoConfiguration
個人感覺@EnableAutoConfiguration這個Annotation最為重要它的作用可以概括為：借助@Import的幫助，將所有符合自動配置條件的bean定義加載到IoC容器。
其源碼如下：
@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@AutoConfigurationPackage@Import(AutoConfigurationImportSelector.class)public @interface EnableAutoConfiguration { String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration"; Class[] exclude() default {}; String[] excludeName() default {};}這里需要關(guān)注@AutoConfigurationPackage和@Import(AutoConfigurationImportSelector.class)兩個注解。2.2.1 注釋：@AutoConfigurationPackage
源碼如下：
@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@AutoConfigurationPackage@Import(AutoConfigurationImportSelector.class)public @interface EnableAutoConfiguration { String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration"; Class[] exclude() default {}; String[] excludeName() default {};}可以發(fā)現(xiàn)這個注解的核心其實(shí)也是Import注解，表示對于標(biāo)注該注解的類的包，應(yīng)當(dāng)使用AutoConfigurationPackages注冊。
接著看Registrar這個類：
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
@Override //metadata是我們注解所在的元信息 public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) { //將我們注解所在包下所有的組件進(jìn)行注冊 register(registry, new PackageImport(metadata).getPackageName()); }
@Override public Set{ return Collections.singleton(new PackageImport(metadata)); }}這個類中的核心方法是register方法：
private static final String BEAN = AutoConfigurationPackages.class.getName(); public static void register(BeanDefinitionRegistry registry, String... packageNames) { if (registry.containsBeanDefinition(BEAN)) { BeanDefinition beanDefinition = registry.getBeanDefinition(BEAN); ConstructorArgumentValues constructorArguments = beanDefinition.getConstructorArgumentValues(); constructorArguments.addIndexedArgumentValue(0, addBasePackages(constructorArguments, packageNames)); } else { GenericBeanDefinition beanDefinition = new GenericBeanDefinition(); beanDefinition.setBeanClass(BasePackages.class); beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0, packageNames); beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE); registry.registerBeanDefinition(BEAN, beanDefinition); }}register方法的邏輯非常清晰：如果這個bean已經(jīng)被注冊，就獲取它的構(gòu)造函數(shù)參數(shù)值，并將包名添加進(jìn)去；否則就創(chuàng)建一個新的bean定義并進(jìn)行注冊。通過@AutoConfigurationPackage這個注解，可以將注解所在包下所有的組件進(jìn)行注冊。
2.2.2 注解：@Import(AutoConfigurationImportSelector.class)
這個注解導(dǎo)入了AutoConfigurationImportSelector這個類這個類的核心方法是selectImports方法，實(shí)現(xiàn)自ImportSelector接口。方法基于我們在pom.xml文件中配置的jar包和組件進(jìn)行導(dǎo)入。所以方法返回的是一個Class全路徑的String數(shù)組，返回的Class會被Spring容器管理。
方法源碼如下：
@Overridepublic String[] selectImports(AnnotationMetadata annotationMetadata) { if (!isEnabled(annotationMetadata)) { return NO_IMPORTS; } AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader .loadMetadata(this.beanClassLoader); AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata); return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());}這個方法的結(jié)構(gòu)也很清晰，首先通過isEnabled方法判斷是否需要進(jìn)行導(dǎo)入，如果需要導(dǎo)入的話，通過loadMetadata方法獲取配置信息，并通過getAutoConfigurationEntry進(jìn)行自動裝配。
isEnabled方法源碼如下：
protected boolean isEnabled(AnnotationMetadata metadata) { if (getClass() == AutoConfigurationImportSelector.class) { return getEnvironment().getProperty(EnableAutoConfiguration.ENABLED_OVERRIDE_PROPERTY, Boolean.class, true); } return true;}這個方法通過EnableAutoConfiguration.ENABLED_OVERRIDE_PROPERTY這個配置項(xiàng)進(jìn)行判斷是否需要自動配置，默認(rèn)為true。
loadMetadata方法源碼如下：
protected static final String PATH = "META-INF/" "spring-autoconfigure-metadata.properties";
public static AutoConfigurationMetadata loadMetadata(ClassLoader classLoader) { return loadMetadata(classLoader, PATH); }
static AutoConfigurationMetadata loadMetadata(ClassLoader classLoader, String path) { try { Enumeration urls = (classLoader != null) ? classLoader.getResources(path) : ClassLoader.getSystemResources(path); Properties properties = new Properties(); while (urls.hasMoreElements()) { properties.putAll(PropertiesLoaderUtils.loadProperties(new UrlResource(urls.nextElement()))); } return loadMetadata(properties); } catch (IOException ex) { throw new IllegalArgumentException("Unable to load @ConditionalOnClass location [" path "]", ex); } } static AutoConfigurationMetadata loadMetadata(Properties properties) { return new PropertiesAutoConfigurationMetadata(properties); }可以看到這個方法會加載META-INF/spring-autoconfigure-metadata.properties下的所有配置信息并包裝成AutoConfigurationMetadata對象返回。
注：spring-autoconfigure-metadata.properties文件在spring-boot-autoconfigure-2.1.9.RELEASE.jar/META-INF下。
getAutoConfigurationEntry方法源碼如下：
protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) { if (!isEnabled(annotationMetadata)) { return EMPTY_ENTRY; } AnnotationAttributes attributes = getAttributes(annotationMetadata); List configurations = removeDuplicates(configurations); Set checkExcludedClasses(configurations, exclusions); configurations.removeAll(exclusions); configurations = filter(configurations, autoConfigurationMetadata); fireAutoConfigurationImportEvents(configurations, exclusions); return new AutoConfigurationEntry(configurations, exclusions);}這個方法是AutoConfiguration的主流程方法，可以將這個方法的每一行看做一個步驟，那么處理步驟如下：
1.?加載配置了@EnableAutoConfiguration注解的屬性值getAttribute方法：
protected AnnotationAttributes getAttributes(AnnotationMetadata metadata) { String name = getAnnotationClass().getName(); AnnotationAttributes attributes = AnnotationAttributes.fromMap(metadata.getAnnotationAttributes(name, true)); Assert.notNull(attributes, () -> "No auto-configuration attributes found. Is " metadata.getClassName() " annotated with " ClassUtils.getShortName(name) "?"); return attributes;}2.得到META-INF/spring.factories文件中以@EnableAutoConfiguration完全限定類名做key的value，getCandidateConfigurations方法：
protected List getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) { List configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(), 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;}protected Class getSpringFactoriesLoaderFactoryClass() { return EnableAutoConfiguration.class;}其中，SpringFactoriesLoader.loadFactoryNames()這個方法的作用是使用給定的類加載器從META-INF/spring.factories加載給定類型的工廠實(shí)現(xiàn)的完全限定類名；
3.去重；4.得到需要排除的類的類名，這些類可以在@EnableAutoConfiguration注解中配置；5.檢查這兩個集合；6.把需要排除的類移除；
7.根據(jù)OnBeanCondition、OnClassCondition等條件進(jìn)行過濾（有興趣可以深入了解）；
8.廣播事件，得到AutoConfigurationImportListener所有實(shí)現(xiàn)類，然后生成事件進(jìn)行廣播；
9.把需要裝配和排除的類完全限定名封裝成了AutoConfigurationEntry對象返回。
因此，@EnableAutoConfiguration可以簡單總結(jié)為：從classpath中搜尋所有的META-INF/spring.factories配置文件，并將其中EnableAutoConfiguration對應(yīng)的配置項(xiàng)通過反射實(shí)例化為對應(yīng)的標(biāo)注了@Configuration的IoC容器配置類，并加載到IoC容器。
三、小結(jié)
通過以上分析可知@SpringBootApplication注解的運(yùn)作是通過@SpringApplicationConfiguration聲明被標(biāo)注類為配置類，從而被AnnotationConfigApplicationContext掃描并初始化Spring容器。
通過@EnableAutoConfiguration來掃描，過濾并加載所需要的組件；通過@ComponentScan掃描并注冊所有標(biāo)注了@Component及其子注解的類；這些注解的共同運(yùn)作實(shí)現(xiàn)了springboot工程強(qiáng)大的自動配置能力。
下載文檔
