我們開發(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的配置方式是這樣:
@Configurationpublic 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励稳,則直接調用對應的JavaConfig類中依賴bean的創(chuàng)建方法就可以了佃乘。
@Configuration
:提到@Configuration
就要提到他的搭檔@Bean
。使用這兩個注解就可以創(chuàng)建一個簡單的spring配置類驹尼,可以用來替代相應的xml配置文件趣避。
<beans>
<bean id = "car" class="com.test.Car">
<property name="wheel" ref = "wheel"></property>
</bean>
<bean id = "wheel" class="com.test.Wheel"></bean>
</beans>
相當于:
@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調度框架相關的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
配置文件中摘錄的一段內容叨橱,可以很好地說明問題。
所以断盛,@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對象實例,然后調用這個創(chuàng)建好的SpringApplication的實例方法躺翻。在SpringApplication實例初始化的時候丧叽,它會提前做幾件事情:
根據(jù)classpath里面是否存在某個特征類
org.springframework.web.context.ConfigurableWebApplicationContext
來決定是否應該創(chuàng)建一個為Web應用使用的ApplicationContext類型。使用
SpringFactoriesLoader
在應用的classpath中查找并加載所有可用的ApplicationContextInitializer
公你。使用
SpringFactoriesLoader
在應用的classpath中查找并加載所有可用的ApplicationListener
踊淳。推斷并設置main方法的定義類。
2) SpringApplication實例初始化完成并且完成設置后陕靠,就開始執(zhí)行run方法的邏輯了迂尝,方法執(zhí)行伊始,首先遍歷執(zhí)行所有通過SpringFactoriesLoader
可以查找到并加載的SpringApplicationRunListener
剪芥。調用它們的started()
方法垄开,告訴這些SpringApplicationRunListener
,“嘿税肪,SpringBoot應用要開始執(zhí)行咯溉躲!”。
3) 創(chuàng)建并配置當前Spring Boot應用將要使用的Environment(包括配置要使用的PropertySource以及Profile)益兄。
4) 遍歷調用所有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
抵碟,然后遍歷調用這些ApplicationContextInitializer
的initialize
(applicationContext)方法來對已經創(chuàng)建好的ApplicationContext
進行進一步的處理桃漾。
8) 遍歷調用所有SpringApplicationRunListener
的contextPrepared()
方法。
9) 最核心的一步拟逮,將之前通過@EnableAutoConfiguration
獲取的所有配置以及其他形式的IoC容器配置加載到已經準備完畢的ApplicationContext
撬统。
10) 遍歷調用所有SpringApplicationRunListener
的contextLoaded()
方法。
11) 調用ApplicationContext
的refresh()
方法敦迄,完成IoC容器可用的最后一道工序恋追。
12) 查找當前ApplicationContext
中是否注冊有CommandLineRunner
,如果有罚屋,則遍歷執(zhí)行它們苦囱。
13) 正常情況下,遍歷執(zhí)行SpringApplicationRunListener
的finished()
方法脾猛、(如果整個過程出現(xiàn)異常撕彤,則依然調用所有SpringApplicationRunListener
的finished()
方法,只不過這種情況下會將異常信息一并傳入處理)
去除事件通知點后猛拴,整個流程如下:
本文以調試一個實際的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里面調用SpringApplication.run()
啟動整個spring-boot程序掌呜,該方法所在類需要使用@SpringBootApplication
注解,以及@ImportResource
注解(if need)坪哄,@SpringBootApplication
包括三個注解质蕉,功能如下:
@EnableAutoConfiguration
:SpringBoot根據(jù)應用所聲明的依賴來對Spring框架進行自動配置。@SpringBootConfiguration
(內部為@Configuration
):被標注的類等于在spring的XML配置文件中(applicationContext.xml
)翩肌,裝配所有bean事務模暗,提供了一個spring的上下文環(huán)境。@ComponentScan
:組件掃描念祭,可自動發(fā)現(xiàn)和裝配Bean兑宇,默認掃描SpringApplication的run方法里的Booter.class
所在的包路徑下文件,所以最好將該啟動類放到根包路徑下粱坤。
SpringBoot啟動類
首先進入run方法
run方法中去創(chuàng)建了一個SpringApplication實例隶糕,在該構造方法內,我們可以發(fā)現(xiàn)其調用了一個初始化的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方法時,就是調用了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方法內,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啟動的程序已經構造完成懈叹,接下來我們來探討自動化配置是如何實現(xiàn)。
自動化配置:
之前的啟動結構圖中分扎,我們注意到無論是應用初始化還是具體的執(zhí)行過程澄成,都調用了SpringBoot自動配置模塊。
SpringBoot自動配置模塊
該配置模塊的主要使用到了SpringFactoriesLoader
畏吓,即Spring工廠加載器墨状,該對象提供了loadFactoryNames
方法,入參為factoryClass和classLoader菲饼,即需要傳入上圖中的工廠類名稱和對應的類加載器肾砂,方法會根據(jù)指定的classLoader,加載該類加器搜索路徑下的指定文件宏悦,即spring.factories
文件镐确,傳入的工廠類為接口,而文件中對應的類則是接口的實現(xiàn)類饼煞,或最終作為實現(xiàn)類源葫,所以文件中一般為如下圖這種一對多的類名集合,獲取到這些實現(xiàn)類的類名后砖瞧,loadFactoryNames
方法返回類名集合息堂,方法調用方得到這些集合后,再通過反射獲取這些類的類對象块促、構造方法储矩,最終生成實例感耙。
工廠接口與其若干實現(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)在我們已經通過spring-boot的starter依賴方式依賴了我們需要的組件祖乳,那么這些組建的類信息在select方法中也是可以被獲取到的逗堵,不要急我們繼續(xù)向下分析。
該方法中的getCandidateConfigurations
方法眷昆,通過方法注釋了解到蜒秤,其返回一個自動配置類的類名列表,方法調用了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)
:只有處理已經被聲明為bean的dataSource抡爹。@ConditionalOnMissingBean(MapperFactoryBean.class)
這個注解的意思是如果容器中不存在name指定的bean則創(chuàng)建bean注入掩驱,否則不執(zhí)行(該類源碼較長,篇幅限制不全粘貼)
以上配置可以保證sqlSessionFactory、sqlSessionTemplate欧穴、dataSource
等mybatis所需的組件均可被自動配置民逼,@Configuration
注解已經提供了Spring的上下文環(huán)境,所以以上組件的配置方式與Spring啟動時通過mybatis.xml文件進行配置起到一個效果涮帘。
通過分析我們可以發(fā)現(xiàn)拼苍,只要一個基于SpringBoot項目的類路徑下存在SqlSessionFactory.class
, SqlSessionFactoryBean.class
,并且容器中已經注冊了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ā)桃序。
作者:平凡希
來源:cnblogs.com/xiaoxi/p/7999885.html