神秘又強大的@SpringBootApplication註解

一、前言

大部分的配置都可以用Java類+註解來代替，而在 SpringBoot專案中見的最多的莫過於@SpringBootApplication註解了，它在每個SpringBoot的啟動類上都有標註。

這個註解對 SpringBoot的啟動和自動配置到底有什麼樣的影響呢？本文將為各位大佬解析它的原始碼，揭開@SpringBootApplication註解神秘的面紗。

二、正文

對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 {
...
}

可以看到這是一個複合註解，一共包括7個不同的註解，下面對這7個不同的註解進行分析。

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

放在註解上，當父類加了@SpringBootApplication註解時，子類也會繼承這個註解（對介面的實現類無效）。

2.1.5 註解5：@SpringBootConfiguration

底層仍是@Configuration註解, 原始碼如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}

2.1.6 註解6：@ComponetScan

@ComponentScan這個註解在Spring中很重要，它對應XML配置中的元素@ComponentScan的功能其實就是自動掃描並載入符合條件的元件（比如@Component和@Repository等）或者bean定義，最終將這些bean定義載入到IoC容器中。

可以透過basePackages等屬性來細粒度的定製@ComponentScan自動掃描的範圍，如果不指定，則預設Spring框架實現會從宣告@ComponentScan所在類的package進行掃描。所以SpringBoot的啟動類最好是放在root package下，因為預設不指定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 {};
}

這裡需要關注@AutoConfigurationPackage和@Import(AutoConfigurationImportSelector.class)兩個註解。

2.2.1 註釋：@AutoConfigurationPackage

原始碼如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
}

可以發現這個註解的核心其實也是Import註解，表示對於標註該註解的類的包，應當使用AutoConfigurationPackages註冊。接著看Registrar這個類：

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
    @Override
      //metadata是我們註解所在的元資訊
    public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
            //將我們註解所在包下所有的元件進行註冊
      register(registry, new PackageImport(metadata).getPackageName());
    }
    @Override
    public Set<Object> determineImports(AnnotationMetadata metadata) {
      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已經被註冊，就獲取它的建構函式引數值，並將包名新增進去；否則就建立一個新的bean定義並進行註冊。透過@AutoConfigurationPackage這個註解，可以將註解所在包下所有的元件進行註冊。

2.2.2 註解： @Import(AutoConfigurationImportSelector.class)

這個註解匯入了AutoConfigurationImportSelector這個類這個類的核心方法是selectImports方法，實現ImportSelector介面。方法基於我們在pom.xml檔案中配置的jar包和元件進行匯入。所以方法返回的是一個Class全路徑的String陣列，返回的Class會被Spring容器管理。方法原始碼如下：

@Override
public 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());
}

這個方法的結構也很清晰，首先透過isEnabled方法判斷是否需要進行匯入，如果需要匯入的話，透過loadMetadata方法獲取配置資訊，並透過getAutoConfigurationEntry進行自動裝配。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這個配置項進行判斷是否需要自動配置，預設為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<URL> 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<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
    configurations = removeDuplicates(configurations);
    Set<String> exclusions = getExclusions(annotationMetadata, attributes);
    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<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    List<String> 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載入給定型別的工廠實現的完全限定類名；

3.去重；

4.得到需要排除的類的類名，這些類可以在@EnableAutoConfiguration註解中配置；

5.檢查這兩個集合；

6.把需要排除的類移除；

7.根據OnBeanCondition、OnClassCondition等條件進行過濾（有興趣可以深入瞭解）；

8.廣播事件，得到AutoConfigurationImportListener所有實現類，然後生成事件進行廣播；

9.把需要裝配和排除的類完全限定名封裝成了AutoConfigurationEntry物件返回。

因此，@EnableAutoConfiguration可以簡單總結為：從classpath中搜尋所有的META-INF/spring.factories配置檔案，並將其中EnableAutoConfiguration對應的配置項透過反射例項化為對應的標註了@Configuration的IoC容器配置類，並載入到IoC容器。

三、小結

透過以上分析可知@ SpringBootApplica tion註解的運作是透過@SpringApplicationConfiguration宣告被標註類為配置類，從而被AnnotationConfigApplicationContext掃描並初始化Spring容器。

透過@EnableAutoConfiguration來掃描，過濾並載入所需要的元件；透過@ComponentScan掃描並註冊所有標註了@Component及其子註解的類；這些註解的共同運作實現了springboot工程強大的自動配置能力。

以上就是本次總結的全部內容，希望能對大家有所幫助。如果有疏漏錯誤之處，還請大家不吝指正。

作者：vivo 網際網路開發團隊-Peng peng