轉載自:https://www.cnblogs.com/shamo89/p/8184960.html;做了一些適合自己的理解注釋和修改
前言
SpringBoot為我們做的自動配置,確實方便快捷,但是對於新手來說,如果不大懂SpringBoot內部啟動原理,以后難免會吃虧。所以這次博主就跟你們一起一步步揭開SpringBoot的神秘面紗,讓它不在神秘。
正文
我們開發任何一個Spring Boot項目,都會用到如下的啟動類
@SpringBootApplication
public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }
從上面代碼可以看出,Annotation定義(@SpringBootApplication)和類定義(SpringApplication.run)最為耀眼,所以要揭開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 { ... }
雖然定義使用了多個Annotation進行了原信息標注,但實際上重要的只有三個Annotation:
- @Configuration(@SpringBootConfiguration點開查看發現里面還是應用了@Configuration)
- @EnableAutoConfiguration
- @ComponentScan
所以,如果我們使用如下的SpringBoot啟動類,整個SpringBoot應用依然可以與之前的啟動類功能對等:
@Configuration
@EnableAutoConfiguration
@ComponentScan /**(注:經過個人測試@SpringBootApplication注解后並不會將這三個注解應用到Application類上
,但是可以Application.class.getAnnotation(SpringBootApplication.class).annotationType().xx來間接獲取,但是Application.class.getAnnotations()只有一個注解)*/
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"> <!--bean定義--> </beans>
而基於JavaConfig的配置方式是這樣:
@Configuration
public class MockConfiguration{ //bean定義 }
任何一個標注了@Configuration的Java類定義都是一個JavaConfig配置類。
- 注冊bean定義層面
基於XML的配置形式是這樣:
<bean id="mockService" class="..MockServiceImpl"> ... </bean>
而基於JavaConfig的配置形式是這樣的:
@Configuration // 只產生一個MockConfiguration對象,該對象將會作為factory-bean
public class MockConfiguration{ @Bean // 將這個方法作為factory-method,注意一個bean里的factory-method不是只能有一個,且如果通過xml配置的化這個方法不需要做任何特殊的處理(如添加注解) public MockService mockService(){ // 注:方法名就是bean的id,而返回值類型就是bean的class 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 // 只產生一個MockConfiguration對象,這個對象也會作為bean對象由spring管理(但是BeanDefinition應該不需要,畢竟這個bean不應該被外部主動getBean)
public class MockConfiguration{
// TODO 所有的@Bean應該都是認為“實現”了FactoryBean接口(但是這個就跟init-method和InitializingBean接口的對應關系一樣),通過cglib生成MockService類的代理重寫了factory-bean(錯誤總結) @Bean public MockService mockService(){ // 注:方法名就是bean的id,而返回值類型就是bean的class;這里要注意一下方法名和返回值類型已經可以用來構成初級的BeanDefinition對象了,即實例化bean之前dependencyService的BeanDefinition對象早已構建 return new MockServiceImpl(dependencyService()); } @Bean
@Scope("prototype") public DependencyService dependencyService(){ // TODO 這些方法應該都只會執行一次,而且在執行的時候會完善對應的BeanDefinition??(通過動態代理實現) return new DependencyServiceImpl(); }
}
如果一個bean的定義依賴其他bean,則直接調用對應的JavaConfig類中依賴bean的創建方法就可以了。
@ComponentScan
@ComponentScan這個注解在Spring中很重要,它對應XML配置中的元素,@ComponentScan的功能其實就是自動掃描並加載符合條件的組件(比如@Component和@Repository等)或者bean定義,最終將這些bean定義加載到IoC容器中。
我們可以通過basePackages等屬性來細粒度的定制@ComponentScan自動掃描的范圍,如果不指定,則默認Spring框架實現會從聲明@ComponentScan所在類的package進行掃描。
1
|
注:所以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 { ... }
其中,最關鍵的要屬@Import(EnableAutoConfigurationImportSelector.class),借助EnableAutoConfigurationImportSelector,@EnableAutoConfiguration可以幫助SpringBoot應用將所有符合條件的@Configuration配置都加載到當前SpringBoot創建並使用的IoC容器。就像一只“八爪魚”一樣
借助於Spring框架原有的一個工具類:SpringFactoriesLoader的支持,@EnableAutoConfiguration可以智能的自動配置功效才得以大功告成!
自動配置幕后英雄:SpringFactoriesLoader詳解
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容器。
深入探索SpringApplication執行流程
SpringApplication的run方法的實現是我們本次旅程的主要線路,該方法的主要流程大體可以歸納如下:
1) 如果我們使用的是SpringApplication的靜態run方法,那么,這個方法里面首先要創建一個SpringApplication對象實例,然后調用這個創建好的SpringApplication的實例方法。在SpringApplication實例初始化的時候,它會提前做幾件事情:
- 根據classpath里面是否存在某個特征類(org.springframework.web.context.ConfigurableWebApplicationContext)來決定是否應該創建一個為Web應用使用的ApplicationContext類型。
- 使用SpringFactoriesLoader在應用的classpath中查找並加載所有可用的ApplicationContextInitializer。
- 使用SpringFactoriesLoader在應用的classpath中查找並加載所有可用的ApplicationListener。
- 推斷並設置main方法的定義類。
2) SpringApplication實例初始化完成並且完成設置后,就開始執行run方法的邏輯了,方法執行伊始,首先遍歷執行所有通過SpringFactoriesLoader可以查找到並加載的SpringApplicationRunListener。調用它們的started()方法,告訴這些SpringApplicationRunListener,“嘿,SpringBoot應用要開始執行咯!”。
3) 創建並配置當前Spring Boot應用將要使用的Environment(包括配置要使用的PropertySource以及Profile)。
4) 遍歷調用所有SpringApplicationRunListener的environmentPrepared()的方法,告訴他們:“當前SpringBoot應用使用的Environment准備好了咯!”。
5) 如果SpringApplication的showBanner屬性被設置為true,則打印banner。
6) 根據用戶是否明確設置了applicationContextClass類型以及初始化階段的推斷結果,決定該為當前SpringBoot應用創建什么類型的ApplicationContext並創建完成,然后根據條件決定是否添加ShutdownHook,決定是否使用自定義的BeanNameGenerator,決定是否使用自定義的ResourceLoader,當然,最重要的,將之前准備好的Environment設置給創建好的ApplicationContext使用。
7) ApplicationContext創建好之后,SpringApplication會再次借助Spring-FactoriesLoader,查找並加載classpath中所有可用的ApplicationContext-Initializer,然后遍歷調用這些ApplicationContextInitializer的initialize(applicationContext)方法來對已經創建好的ApplicationContext進行進一步的處理。
8) 遍歷調用所有SpringApplicationRunListener的contextPrepared()方法。
9) 最核心的一步,將之前通過@EnableAutoConfiguration獲取的所有配置以及其他形式的IoC容器配置加載到已經准備完畢的ApplicationContext。
10) 遍歷調用所有SpringApplicationRunListener的contextLoaded()方法。
11) 調用ApplicationContext的refresh()方法,完成IoC容器可用的最后一道工序。
12) 查找當前ApplicationContext中是否注冊有CommandLineRunner,如果有,則遍歷執行它們。
13) 正常情況下,遍歷執行SpringApplicationRunListener的finished()方法、(如果整個過程出現異常,則依然調用所有SpringApplicationRunListener的finished()方法,只不過這種情況下會將異常信息一並傳入處理)
去除事件通知點后,整個流程如下:
總結
到此,SpringBoot的核心組件完成了基本的解析,綜合來看,大部分都是Spring框架背后的一些概念和實踐方式,SpringBoot只是在這些概念和實踐上對特定的場景事先進行了固化和升華,而也恰恰是這些固化讓我們開發基於Sping框架的應用更加方便高效。