鏈接:http://www.cnblogs.com/xiaoxi/
作者:平凡希
我們開發(fā)任何一個Spring Boot項目皮壁,都會用到如下的啟動類
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
從上面代碼可以看出,Annotation定義(@SpringBootApplication)和類定義(SpringApplication.run)最為耀眼哪审,所以要揭開SpringBoot的神秘面紗蛾魄,我們要從這兩位開始就可以了。
一湿滓、SpringBootApplication背后的秘密
@SpringBootApplication注解是Spring Boot的核心注解滴须,它其實是一個組合注解:
@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點開查看發(fā)現(xiàn)里面還是應用了@Configuration)
@EnableAutoConfiguration
@ComponentScan
即 @SpringBootApplication = (默認屬性)@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。
1赵哲、@Configuration
這里的@Configuration對我們來說不陌生待德,它就是JavaConfig形式的Spring Ioc容器的配置類使用的那個@Configuration,SpringBoot社區(qū)推薦使用基于JavaConfig的配置形式枫夺,所以将宪,這里的啟動類標注了@Configuration之后,本身其實也是一個IoC容器的配置類橡庞。
舉幾個簡單例子回顧下较坛,XML跟config配置方式的區(qū)別:
(1)表達形式層面
基于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配置類。
(2)注冊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。
(3)表達依賴注入關系層面
為了表達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确封,則直接調(diào)用對應的JavaConfig類中依賴bean的創(chuàng)建方法就可以了。
@Configuration:提到@Configuration就要提到他的搭檔@Bean再菊。使用這兩個注解就可以創(chuàng)建一個簡單的spring配置類爪喘,可以用來替代相應的xml配置文件。
@Configuration
public class MockConfiguration{
@Bean
public MockService mockService(){
return new MockServiceImpl(dependencyService());
}
@Bean
public DependencyService dependencyService(){
return new DependencyServiceImpl();
}
}
相當于:
@Configuration
public class Conf {
@Bean
public Car car() {
Car car = new Car();
car.setWheel(wheel());
return car;
}
@Bean
public Wheel wheel() {
return new Wheel();
}
}
@Configuration的注解類標識這個類可以使用Spring IoC容器作為bean定義的來源纠拔。
@Bean注解告訴Spring秉剑,一個帶有@Bean的注解方法將返回一個對象,該對象應該被注冊為在Spring應用程序上下文中的bean稠诲。
2侦鹏、@ComponentScan
@ComponentScan這個注解在Spring中很重要诡曙,它對應XML配置中的元素,@ComponentScan的功能其實就是自動掃描并加載符合條件的組件(比如@Component和@Repository等)或者bean定義略水,最終將這些bean定義加載到IoC容器中价卤。
我們可以通過basePackages等屬性來細粒度的定制@ComponentScan自動掃描的范圍,如果不指定渊涝,則默認Spring框架實現(xiàn)會從聲明@ComponentScan所在類的package進行掃描慎璧。
注:所以SpringBoot的啟動類最好是放在root package下,因為默認不指定basePackages跨释。
3胸私、@EnableAutoConfiguration
個人感覺@EnableAutoConfiguration這個Annotation最為重要,所以放在最后來解讀鳖谈,大家是否還記得Spring框架提供的各種名字為@Enable開頭的Annotation定義岁疼?比如@EnableScheduling、@EnableCaching缆娃、@EnableMBeanExport等捷绒,@EnableAutoConfiguration的理念和做事方式其實一脈相承,簡單概括一下就是贯要,借助@Import的支持暖侨,收集和注冊特定場景相關的bean定義。
@EnableScheduling是通過@Import將Spring調(diào)度框架相關的bean定義都加載到IoC容器郭毕。
@EnableMBeanExport是通過@Import將JMX相關的bean定義加載到IoC容器。
而@EnableAutoConfiguration也是借助@Import的幫助函荣,將所有符合自動配置條件的bean定義加載到IoC容器显押,僅此而已!
@EnableAutoConfiguration會根據(jù)類路徑中的jar依賴為項目進行自動配置傻挂,如:添加了spring-boot-starter-web依賴乘碑,會自動添加Tomcat和Spring MVC的依賴,Spring Boot會對Tomcat和Spring MVC進行自動配置金拒。
@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創(chuàng)建并使用的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使用的話政基,它更多是提供一種配置查找的功能支持,即根據(jù)@EnableAutoConfiguration的完整類名org.springframework.boot.autoconfigure.EnableAutoConfiguration作為查找的Key闹啦,獲取對應的一組@Configuration類沮明。
上圖就是從SpringBoot的autoconfigure依賴包中的META-INF/spring.factories配置文件中摘錄的一段內(nèi)容,可以很好地說明問題窍奋。
所以荐健,@EnableAutoConfiguration自動配置的魔法騎士就變成了:從classpath中搜尋所有的META-INF/spring.factories配置文件,并將其中org.springframework.boot.autoconfigure.EnableutoConfiguration對應的配置項通過反射(Java Refletion)實例化為對應的標注了@Configuration的JavaConfig形式的IoC容器配置類费变,然后匯總為一個并加載到IoC容器摧扇。
二、深入探索SpringApplication執(zhí)行流程
SpringApplication的run方法的實現(xiàn)是我們本次旅程的主要線路挚歧,該方法的主要流程大體可以歸納如下:
1) 如果我們使用的是SpringApplication的靜態(tài)run方法扛稽,那么,這個方法里面首先要創(chuàng)建一個SpringApplication對象實例滑负,然后調(diào)用這個創(chuàng)建好的SpringApplication的實例方法在张。在SpringApplication實例初始化的時候,它會提前做幾件事情:
A.根據(jù)classpath里面是否存在某個特征類(org.springframework.web.context.ConfigurableWebApplicationContext)來決定是否應該創(chuàng)建一個為Web應用使用的ApplicationContext類型矮慕。
B.使用SpringFactoriesLoader在應用的classpath中查找并加載所有可用的ApplicationContextInitializer帮匾。
C.使用SpringFactoriesLoader在應用的classpath中查找并加載所有可用的ApplicationListener。
D.推斷并設置main方法的定義類痴鳄。
2) SpringApplication實例初始化完成并且完成設置后瘟斜,就開始執(zhí)行run方法的邏輯了,方法執(zhí)行伊始痪寻,首先遍歷執(zhí)行所有通過SpringFactoriesLoader可以查找到并加載的SpringApplicationRunListener螺句。調(diào)用它們的started()方法,告訴這些SpringApplicationRunListener橡类,“嘿蛇尚,SpringBoot應用要開始執(zhí)行咯!”顾画。
3) 創(chuàng)建并配置當前Spring Boot應用將要使用的Environment(包括配置要使用的PropertySource以及Profile)取劫。
4) 遍歷調(diào)用所有SpringApplicationRunListener的environmentPrepared()的方法,告訴他們:“當前SpringBoot應用使用的Environment準備好了咯研侣!”谱邪。
5) 如果SpringApplication的showBanner屬性被設置為true,則打印banner庶诡。
6) 根據(jù)用戶是否明確設置了applicationContextClass類型以及初始化階段的推斷結果虾标,決定該為當前SpringBoot應用創(chuàng)建什么類型的ApplicationContext并創(chuàng)建完成,然后根據(jù)條件決定是否添加ShutdownHook,決定是否使用自定義的BeanNameGenerator璧函,決定是否使用自定義的ResourceLoader傀蚌,當然,最重要的蘸吓,將之前準備好的Environment設置給創(chuàng)建好的ApplicationContext使用善炫。
7) ApplicationContext創(chuàng)建好之后,SpringApplication會再次借助Spring-FactoriesLoader库继,查找并加載classpath中所有可用的ApplicationContext-Initializer箩艺,然后遍歷調(diào)用這些ApplicationContextInitializer的initialize(applicationContext)方法來對已經(jīng)創(chuàng)建好的ApplicationContext進行進一步的處理。
8) 遍歷調(diào)用所有SpringApplicationRunListener的contextPrepared()方法宪萄。
9) 最核心的一步艺谆,將之前通過@EnableAutoConfiguration獲取的所有配置以及其他形式的IoC容器配置加載到已經(jīng)準備完畢的ApplicationContext。
10) 遍歷調(diào)用所有SpringApplicationRunListener的contextLoaded()方法拜英。
11) 調(diào)用ApplicationContext的refresh()方法静汤,完成IoC容器可用的最后一道工序。
12) 查找當前ApplicationContext中是否注冊有CommandLineRunner居凶,如果有虫给,則遍歷執(zhí)行它們。
13) 正常情況下侠碧,遍歷執(zhí)行SpringApplicationRunListener的finished()方法抹估、(如果整個過程出現(xiàn)異常,則依然調(diào)用所有SpringApplicationRunListener的finished()方法弄兜,只不過這種情況下會將異常信息一并傳入處理)
去除事件通知點后药蜻,整個流程如下:
本文以調(diào)試一個實際的SpringBoot啟動程序為例,參考流程中主要類類圖替饿,來分析其啟動邏輯和自動化配置原理语泽。
總覽:
上圖為SpringBoot啟動結構圖,我們發(fā)現(xiàn)啟動流程主要分為三個部分盛垦,第一部分進行SpringApplication的初始化模塊湿弦,配置一些基本的環(huán)境變量瓤漏、資源腾夯、構造器、監(jiān)聽器蔬充,第二部分實現(xiàn)了應用具體的啟動方案蝶俱,包括啟動流程的監(jiān)聽模塊、加載配置環(huán)境模塊饥漫、及核心的創(chuàng)建上下文環(huán)境模塊榨呆,第三部分是自動化配置模塊,該模塊作為springboot自動配置核心庸队,在后面的分析中會詳細討論积蜻。在下面的啟動程序中我們會串聯(lián)起結構中的主要功能闯割。
啟動:
每個SpringBoot程序都有一個主入口,也就是main方法竿拆,main里面調(diào)用SpringApplication.run()啟動整個spring-boot程序宙拉,該方法所在類需要使用@SpringBootApplication注解,以及@ImportResource注解(if need)丙笋,@SpringBootApplication包括三個注解谢澈,功能如下:
@EnableAutoConfiguration:SpringBoot根據(jù)應用所聲明的依賴來對Spring框架進行自動配置。
@SpringBootConfiguration(內(nèi)部為@Configuration):被標注的類等于在spring的XML配置文件中(applicationContext.xml)御板,裝配所有bean事務锥忿,提供了一個spring的上下文環(huán)境。
@ComponentScan:組件掃描怠肋,可自動發(fā)現(xiàn)和裝配Bean敬鬓,默認掃描SpringApplication的run方法里的Booter.class所在的包路徑下文件,所以最好將該啟動類放到根包路徑下灶似。
SpringBoot啟動類
首先進入run方法
run方法中去創(chuàng)建了一個SpringApplication實例列林,在該構造方法內(nèi),我們可以發(fā)現(xiàn)其調(diào)用了一個初始化的initialize方法
這里主要是為SpringApplication對象賦一些初值酪惭。構造函數(shù)執(zhí)行完畢后希痴,我們回到run方法
該方法中實現(xiàn)了如下幾個關鍵步驟:
1.創(chuàng)建了應用的監(jiān)聽器SpringApplicationRunListeners并開始監(jiān)聽
2.加載SpringBoot配置環(huán)境(ConfigurableEnvironment),如果是通過web容器發(fā)布春感,會加載StandardEnvironment砌创,其最終也是繼承了ConfigurableEnvironment,類圖如下
可以看出鲫懒,*Environment最終都實現(xiàn)了PropertyResolver接口嫩实,我們平時通過environment對象獲取配置文件中指定Key對應的value方法時,就是調(diào)用了propertyResolver接口的getProperty方法
3.配置環(huán)境(Environment)加入到監(jiān)聽器對象中(SpringApplicationRunListeners)
4.創(chuàng)建run方法的返回對象:ConfigurableApplicationContext(應用配置上下文)窥岩,我們可以看一下創(chuàng)建方法:
方法會先獲取顯式設置的應用上下文(applicationContextClass)甲献,如果不存在,再加載默認的環(huán)境配置(通過是否是web environment判斷)颂翼,默認選擇AnnotationConfigApplicationContext注解上下文(通過掃描所有注解類來加載bean)晃洒,最后通過BeanUtils實例化上下文對象,并返回朦乏。
ConfigurableApplicationContext類圖如下:
主要看其繼承的兩個方向:
LifeCycle:生命周期類球及,定義了start啟動、stop結束呻疹、isRunning是否運行中等生命周期空值方法
ApplicationContext:應用上下文類吃引,其主要繼承了beanFactory(bean的工廠類)
5.回到run方法內(nèi),prepareContext方法將listeners、environment镊尺、applicationArguments蒲列、banner等重要組件與上下文對象關聯(lián)
6.接下來的refreshContext(context)方法(初始化方法如下)將是實現(xiàn)spring-boot-starter-*(mybatis雄妥、redis等)自動化配置的關鍵,包括spring.factories的加載,bean的實例化等核心工作试读。
配置結束后晴埂,Springboot做了一些基本的收尾工作辽狈,返回了應用環(huán)境上下文置逻。回顧整體流程输枯,Springboot的啟動议泵,主要創(chuàng)建了配置環(huán)境(environment)、事件監(jiān)聽(listeners)桃熄、應用上下文(applicationContext)先口,并基于以上條件,在容器中開始實例化我們需要的Bean瞳收,至此碉京,通過SpringBoot啟動的程序已經(jīng)構造完成,接下來我們來探討自動化配置是如何實現(xiàn)螟深。
自動化配置:
之前的啟動結構圖中谐宙,我們注意到無論是應用初始化還是具體的執(zhí)行過程,都調(diào)用了SpringBoot自動配置模塊界弧。
SpringBoot自動配置模塊
該配置模塊的主要使用到了SpringFactoriesLoader凡蜻,即Spring工廠加載器,該對象提供了loadFactoryNames方法垢箕,入?yún)閒actoryClass和classLoader划栓,即需要傳入上圖中的工廠類名稱和對應的類加載器,方法會根據(jù)指定的classLoader条获,加載該類加器搜索路徑下的指定文件忠荞,即spring.factories文件,傳入的工廠類為接口帅掘,而文件中對應的類則是接口的實現(xiàn)類委煤,或最終作為實現(xiàn)類,所以文件中一般為如下圖這種一對多的類名集合锄开,獲取到這些實現(xiàn)類的類名后素标,loadFactoryNames方法返回類名集合称诗,方法調(diào)用方得到這些集合后萍悴,再通過反射獲取這些類的類對象、構造方法,最終生成實例癣诱。
工廠接口與其若干實現(xiàn)類接口名稱
下圖有助于我們形象理解自動配置流程计维。
SpringBoot自動化配置關鍵組件關系圖
mybatis-spring-boot-starter、spring-boot-starter-web等組件的META-INF文件下均含有spring.factories文件撕予,自動配置模塊中鲫惶,SpringFactoriesLoader收集到文件中的類全名并返回一個類全名的數(shù)組,返回的類全名通過反射被實例化实抡,就形成了具體的工廠實例欠母,工廠實例來生成組件具體需要的bean。
之前我們提到了EnableAutoConfiguration注解吆寨,其類圖如下:
可以發(fā)現(xiàn)其最終實現(xiàn)了ImportSelector(選擇器)和BeanClassLoaderAware(bean類加載器中間件)赏淌,重點關注一下AutoConfigurationImportSelector的selectImports方法。
該方法在springboot啟動流程——bean實例化前被執(zhí)行啄清,返回要實例化的類信息列表六水。我們知道,如果獲取到類信息辣卒,spring自然可以通過類加載器將類加載到jvm中掷贾,現(xiàn)在我們已經(jīng)通過spring-boot的starter依賴方式依賴了我們需要的組件,那么這些組建的類信息在select方法中也是可以被獲取到的荣茫,不要急我們繼續(xù)向下分析想帅。
該方法中的getCandidateConfigurations方法,通過方法注釋了解到啡莉,其返回一個自動配置類的類名列表博脑,方法調(diào)用了loadFactoryNames方法,查看該方法
在上面的代碼可以看到自動配置器會根據(jù)傳入的factoryClass.getName()到項目系統(tǒng)路徑下所有的spring.factories文件中找到相應的key票罐,從而加載里面的類叉趣。我們就選取這個mybatis-spring-boot-autoconfigure下的spring.factories文件
進入org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration中,主要看一下類頭:
發(fā)現(xiàn)Spring的@Configuration该押,儼然是一個通過注解標注的springBean疗杉,繼續(xù)向下看,
@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class})這個注解的意思是:當存在SqlSessionFactory.class, SqlSessionFactoryBean.class這兩個類時才解析MybatisAutoConfiguration配置類蚕礼,否則不解析這一個配置類烟具,make sence,我們需要mybatis為我們返回會話對象奠蹬,就必須有會話工廠相關類朝聋。
@CondtionalOnBean(DataSource.class):只有處理已經(jīng)被聲明為bean的dataSource。
@ConditionalOnMissingBean(MapperFactoryBean.class)這個注解的意思是如果容器中不存在name指定的bean則創(chuàng)建bean注入囤躁,否則不執(zhí)行(該類源碼較長冀痕,篇幅限制不全粘貼)
以上配置可以保證sqlSessionFactory荔睹、sqlSessionTemplate、dataSource等mybatis所需的組件均可被自動配置言蛇,@Configuration注解已經(jīng)提供了Spring的上下文環(huán)境僻他,所以以上組件的配置方式與Spring啟動時通過mybatis.xml文件進行配置起到一個效果。通過分析我們可以發(fā)現(xiàn)腊尚,只要一個基于SpringBoot項目的類路徑下存在SqlSessionFactory.class, SqlSessionFactoryBean.class吨拗,并且容器中已經(jīng)注冊了dataSourceBean,就可以觸發(fā)自動化配置婿斥,意思說我們只要在maven的項目中加入了mybatis所需要的若干依賴劝篷,就可以觸發(fā)自動配置,但引入mybatis原生依賴的話民宿,每集成一個功能都要去修改其自動化配置類携龟,那就得不到開箱即用的效果了。所以Spring-boot為我們提供了統(tǒng)一的starter可以直接配置好相關的類勘高,觸發(fā)自動配置所需的依賴(mybatis)如下:
這里是截取的mybatis-spring-boot-starter的源碼中pom.xml文件中所有依賴:
因為maven依賴的傳遞性峡蟋,我們只要依賴starter就可以依賴到所有需要自動配置的類,實現(xiàn)開箱即用的功能华望。也體現(xiàn)出Springboot簡化了Spring框架帶來的大量XML配置以及復雜的依賴管理蕊蝗,讓開發(fā)人員可以更加關注業(yè)務邏輯的開發(fā)。