SpringBoot 基本原理

SpringBoot 為我們做的自動配置，確實方便快捷，但一直搞不明白它的內部啟動原理，這次就來一步步解開 SpringBoot 的神秘面紗，讓它不再神秘。

SpringBootApplication 背后的秘密?

@Configuration

@ComponentScan

@EnableAutoConfiguration?

AutoConfigurationPackage 注解：

Import(AutoConfigurationImportSelector.class)注解：

#自動配置幕后英雄：SpringFactoriesLoader 詳解

@SpringBootApplication
public class Application {
? ? public static void main(String[] args) {
? ? ? ? SpringApplication.run(Application.class, args);
? ? }
}
?

從上面代碼可以看出，**Annotation 定義（@SpringBootApplication）和類定義（SpringApplication.run）**最為耀眼，所以要揭開 SpringBoot 的神秘面紗，我們要從這兩位開始就可以了。

SpringBootApplication 背后的秘密?

@Target(ElementType.TYPE) ? ? ? ? ? ?// 注解的適用范圍，其中TYPE用于描述類、接口（包括包注解類型）或enum聲明
@Retention(RetentionPolicy.RUNTIME) ?// 注解的生命周期，保留到class文件中（三個生命周期）
@Documented ? ? ? ? ? ? ? ? ? ? ? ? ?// 表明這個注解應該被javadoc記錄
@Inherited ? ? ? ? ? ? ? ? ? ? ? ? ? // 子類可以繼承該注解
@SpringBootConfiguration ? ? ? ? ? ? // 繼承了Configuration，表示當前是注解類
@EnableAutoConfiguration ? ? ? ? ? ? // 開啟springboot的注解功能，springboot的四大神器之一，其借助@import的幫助
@ComponentScan(excludeFilters = { ? ?// 掃描路徑設置（具體使用待確認）
? ? ? ? @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
? ? ? ? @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
...
}
?

雖然定義使用了多個 Annotation 進行了原信息標注，但實際上重要的只有三個 Annotation：

@Configuration（@SpringBootConfiguration 點開查看發現里面還是應用了@Configuration）?@EnableAutoConfiguration @ComponentScan?所以，如果我們使用如下的 SpringBoot 啟動類，整個 SpringBoot 應用依然可以與之前的啟動類功能對等：

?@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {
? ? public static void main(String[] args) {
? ? ? ? SpringApplication.run(Application.class, args);
? ? }
}

每次寫這 3 個比較累，所以寫一個@SpringBootApplication 方便點。接下來分別介紹這 3 個 Annotation。?

@Configuration

這里的@Configuration 對我們來說不陌生，它就是 JavaConfig 形式的 Spring Ioc 容器的配置類使用的那個@Configuration，SpringBoot 社區推薦使用基于 JavaConfig 的配置形式，所以，這里的啟動類標注了@Configuration 之后，本身其實也是一個 IoC 容器的配置類。舉幾個簡單例子回顧下，XML 跟 config 配置方式的區別：

表達形式層面基于 XML 配置的方式是這樣：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
? ? ? ?xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
? ? ? ?xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"
? ? ? ?default-lazy-init="true">
? ? 
</beans>
?

而基于 JavaConfig 的配置方式是這樣：?

@Configuration
public class MockConfiguration{
? ? //bean定義
}
?

任何一個標注了@Configuration 的 Java 類定義都是一個 JavaConfig 配置類。

注冊 bean 定義層面基于 XML 的配置形式是這樣：

<bean id="mockService" class="..MockServiceImpl">
? ? ...
</bean>
?

而基于 JavaConfig 的配置形式是這樣的：?

@Configuration
public class MockConfiguration{
? ? @Bean
? ? public MockService mockService(){
? ? ? ? return new MockServiceImpl();
? ? }
}
?

任何一個標注了@Bean 的方法，其返回值將作為一個 bean 定義注冊到 Spring 的 IoC 容器，方法名將默認成該 bean 定義的 id。

表達依賴注入關系層面為了表達 bean 與 bean 之間的依賴關系，在 XML 形式中一般是這樣：

<bean id="mockService" class="..MockServiceImpl">
? ? <propery name ="dependencyService" ref="dependencyService" />
</bean>

<bean id="dependencyService" class="DependencyServiceImpl"></bean>
?

而基于 JavaConfig 的配置形式是這樣的：?

?????????

@Configuration
public class MockConfiguration{
? ? @Bean
? ? public MockService mockService(){
? ? ? ? return new MockServiceImpl(dependencyService());
? ? }

? ? @Bean
? ? public DependencyService dependencyService(){
? ? ? ? return new DependencyServiceImpl();
? ? }
}
?

如果一個 bean 的定義依賴其他 bean,則直接調用對應的 JavaConfig 類中依賴 bean 的創建方法就可以了。

@ComponentScan

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

我們可以通過 basePackages 等屬性來細粒度的定制@ComponentScan 自動掃描的范圍，如果不指定，則默認 Spring 框架實現會從聲明@ComponentScan 所在類的 package 進行掃描。

注：所以 SpringBoot 的啟動類最好是放在 root package 下，因為默認不指定 basePackages。

@EnableAutoConfiguration?

個人感覺**@EnableAutoConfiguration 這個 Annotation 最為重要**，所以放在最后來解讀，大家是否還記得 Spring 框架提供的各種名字為@Enable 開頭的 Annotation 定義？比如@EnableScheduling、@EnableCaching、@EnableMBeanExport 等，@EnableAutoConfiguration 的理念和做事方式其實一脈相承，簡單概括一下就是，借助@Import 的支持，收集和注冊特定場景相關的 bean 定義。

@EnableScheduling是通過@Import 將 Spring 調度框架相關的 bean 定義都加載到 IoC 容器。?@EnableMBeanExport是通過@Import 將 JMX 相關的 bean 定義加載到 IoC 容器。而**@EnableAutoConfiguration**也是借助@Import 的幫助，將所有符合自動配置條件的 bean 定義加載到 IoC 容器，僅此而已！

@EnableAutoConfiguration 作為一個復合 Annotation,其自身定義關鍵信息如下：

@SuppressWarnings("deprecation")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
? ? ...
}
?

兩個比較重要的注解：

@AutoConfigurationPackage：自動配置包

@Import: 導入自動配置的組件

AutoConfigurationPackage 注解：

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {

? ? ? ? @Override
? ? ? ? public void registerBeanDefinitions(AnnotationMetadata metadata,
? ? ? ? ? ? ? ? BeanDefinitionRegistry registry) {
? ? ? ? ? ? register(registry, new PackageImport(metadata).getPackageName());
? ? ? ? }
?

?

它其實是注冊了一個 Bean 的定義。

new PackageImport(metadata).getPackageName()，它其實返回了當前主程序類的同級以及子級的包組件。

以上圖為例，DemoApplication 是和 demo 包同級，但是 demo2 這個類是 DemoApplication 的父級，和 example 包同級

也就是說，DemoApplication 啟動加載的 Bean 中，并不會加載 demo2，這也就是為什么，我們要把 DemoApplication 放在項目的最高級中。

Import(AutoConfigurationImportSelector.class)注解：

可以從圖中看出 AutoConfigurationImportSelector 繼承了 DeferredImportSelector 繼承了 ImportSelector

ImportSelector 有一個方法為：selectImports。

@Override
? ? public String[] selectImports(AnnotationMetadata annotationMetadata) {
? ? ? ? if (!isEnabled(annotationMetadata)) {
? ? ? ? ? ? return NO_IMPORTS;
? ? ? ? }
? ? ? ? AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
? ? ? ? ? ? ? ? .loadMetadata(this.beanClassLoader);
? ? ? ? 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 StringUtils.toStringArray(configurations);
? ? }
?

可以看到第九行，它其實是去加載 public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";外部文件。這個外部文件，有很多自動配置的類。如下：

image

其中，最關鍵的要屬**@Import(EnableAutoConfigurationImportSelector.class)，借助EnableAutoConfigurationImportSelector**，@EnableAutoConfiguration可以幫助 SpringBoot 應用將所有符合條件的**@Configuration**配置都加載到當前 SpringBoot 創建并使用的 IoC 容器。就像一只“八爪魚”一樣。

#自動配置幕后英雄：SpringFactoriesLoader 詳解

借助于 Spring 框架原有的一個工具類：SpringFactoriesLoader 的支持，@EnableAutoConfiguration 可以智能的自動配置功效才得以大功告成！

SpringFactoriesLoader 屬于 Spring 框架私有的一種擴展方案，其主要功能就是從指定的配置文件 META-INF/spring.factories 加載配置。

public abstract class SpringFactoriesLoader {
? ? //...
? ? public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader) {
? ? ? ? ...
? ? }

? ? public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
? ? ? ? ....
? ? }
}
?

配合**@EnableAutoConfiguration使用的話，它更多是提供一種配置查找的功能支持，即根據@EnableAutoConfiguration 的完整類名 org.springframework.boot.autoconfigure.EnableAutoConfiguration 作為查找的 Key,獲取對應的一組@Configuration**類

上圖就是從 SpringBoot 的 autoconfigure 依賴包中的 META-INF/spring.factories 配置文件中摘錄的一段內容，可以很好地說明問題。

所以，@EnableAutoConfiguration 自動配置的魔法騎士就變成了：從 classpath 中搜尋所有的 META-INF/spring.factories 配置文件，并將其中 org.springframework.boot.autoconfigure.EnableutoConfiguration 對應的配置項通過反射（Java Refletion）實例化為對應的標注了@Configuration 的 JavaConfig 形式的 IoC 容器配置類，然后匯總為一個并加載到 IoC 容器。