Springboot通過run啟動web應(yīng)用的方法
我們開發(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進行了原信息標(biāo)注,但實際上重要的只有三個Annotation:
- @Configuration(@SpringBootConfiguration點開查看發(fā)現(xiàn)里面還是應(yīng)用了@Configuration)
- @EnableAutoConfiguration
- @ComponentScan
即 @SpringBootApplication = (默認(rèn)屬性)@Configuration + @EnableAutoConfiguration + @ComponentScan。
所以,如果我們使用如下的SpringBoot啟動類,整個SpringBoot應(yīng)用依然可以與之前的啟動類功能對等:
@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的配置形式,所以,這里的啟動類標(biāo)注了@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定義 }
任何一個標(biāo)注了@Configuration的Java類定義都是一個JavaConfig配置類。
(2)注冊bean定義層面
基于XML的配置形式是這樣:
<bean id="mockService" class="..MockServiceImpl"> ... </bean>
而基于JavaConfig的配置形式是這樣的:
@Configuration public class MockConfiguration{ @Bean public MockService mockService(){ return new MockServiceImpl(); } }
任何一個標(biāo)注了@Bean的方法,其返回值將作為一個bean定義注冊到Spring的IoC容器,方法名將默認(rèn)成該bean定義的id。
(3)表達依賴注入關(guān)系層面
為了表達bean與bean之間的依賴關(guān)系,在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)用對應(yīng)的JavaConfig類中依賴bean的創(chuàng)建方法就可以了。
@Configuration:提到@Configuration就要提到他的搭檔@Bean。使用這兩個注解就可以創(chuàng)建一個簡單的spring配置類,可以用來替代相應(yīng)的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>
相當(dāng)于:
@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的注解類標(biāo)識這個類可以使用Spring IoC容器作為bean定義的來源。
@Bean注解告訴Spring,一個帶有@Bean的注解方法將返回一個對象,該對象應(yīng)該被注冊為在Spring應(yīng)用程序上下文中的bean。
2、@ComponentScan
@ComponentScan這個注解在Spring中很重要,它對應(yīng)XML配置中的元素,@ComponentScan的功能其實就是自動掃描并加載符合條件的組件(比如@Component和@Repository等)或者bean定義,最終將這些bean定義加載到IoC容器中。
我們可以通過basePackages等屬性來細(xì)粒度的定制@ComponentScan自動掃描的范圍,如果不指定,則默認(rèn)Spring框架實現(xiàn)會從聲明@ComponentScan所在類的package進行掃描。
注:所以SpringBoot的啟動類最好是放在root package下,因為默認(rèn)不指定basePackages。
3、@EnableAutoConfiguration
個人感覺@EnableAutoConfiguration這個Annotation最為重要,所以放在最后來解讀,大家是否還記得Spring框架提供的各種名字為@Enable開頭的Annotation定義?比如@EnableScheduling、@EnableCaching、@EnableMBeanExport等,@EnableAutoConfiguration的理念和做事方式其實一脈相承,簡單概括一下就是,借助@Import的支持,收集和注冊特定場景相關(guān)的bean定義。
- @EnableScheduling是通過@Import將Spring調(diào)度框架相關(guān)的bean定義都加載到IoC容器。
- @EnableMBeanExport是通過@Import將JMX相關(guān)的bean定義加載到IoC容器。
而@EnableAutoConfiguration也是借助@Import的幫助,將所有符合自動配置條件的bean定義加載到IoC容器,僅此而已!
@EnableAutoConfiguration會根據(jù)類路徑中的jar依賴為項目進行自動配置,如:添加了spring-boot-starter-web依賴,會自動添加Tomcat和Spring MVC的依賴,Spring Boot會對Tomcat和Spring MVC進行自動配置。
@EnableAutoConfiguration作為一個復(fù)合Annotation,其自身定義關(guān)鍵信息如下:
@SuppressWarnings("deprecation") @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @AutoConfigurationPackage @Import(EnableAutoConfigurationImportSelector.class) public @interface EnableAutoConfiguration { ... }
其中,最關(guān)鍵的要屬@Import(EnableAutoConfigurationImportSelector.class),借助EnableAutoConfigurationImportSelector,@EnableAutoConfiguration可以幫助SpringBoot應(yīng)用將所有符合條件的@Configuration配置都加載到當(dāng)前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,獲取對應(yīng)的一組@Configuration類。
上圖就是從SpringBoot的autoconfigure依賴包中的META-INF/spring.factories配置文件中摘錄的一段內(nèi)容,可以很好地說明問題。
所以,@EnableAutoConfiguration自動配置的魔法騎士就變成了:從classpath中搜尋所有的META-INF/spring.factories配置文件,并將其中org.springframework.boot.autoconfigure.EnableutoConfiguration對應(yīng)的配置項通過反射(Java Refletion)實例化為對應(yīng)的標(biāo)注了@Configuration的JavaConfig形式的IoC容器配置類,然后匯總為一個并加載到IoC容器。
二、深入探索SpringApplication執(zhí)行流程
SpringApplication的run方法的實現(xiàn)是我們本次旅程的主要線路,該方法的主要流程大體可以歸納如下:
1) 如果我們使用的是SpringApplication的靜態(tài)run方法,那么,這個方法里面首先要創(chuàng)建一個SpringApplication對象實例,然后調(diào)用這個創(chuàng)建好的SpringApplication的實例方法。在SpringApplication實例初始化的時候,它會提前做幾件事情:
根據(jù)classpath里面是否存在某個特征類(org.springframework.web.context.ConfigurableWebApplicationContext)來決定是否應(yīng)該創(chuàng)建一個為Web應(yīng)用使用的ApplicationContext類型。使用SpringFactoriesLoader在應(yīng)用的classpath中查找并加載所有可用的ApplicationContextInitializer。使用SpringFactoriesLoader在應(yīng)用的classpath中查找并加載所有可用的ApplicationListener。推斷并設(shè)置main方法的定義類。
2) SpringApplication實例初始化完成并且完成設(shè)置后,就開始執(zhí)行run方法的邏輯了,方法執(zhí)行伊始,首先遍歷執(zhí)行所有通過SpringFactoriesLoader可以查找到并加載的SpringApplicationRunListener。調(diào)用它們的started()方法,告訴這些SpringApplicationRunListener,“嘿,SpringBoot應(yīng)用要開始執(zhí)行咯!”。
3) 創(chuàng)建并配置當(dāng)前Spring Boot應(yīng)用將要使用的Environment(包括配置要使用的PropertySource以及Profile)。
4) 遍歷調(diào)用所有SpringApplicationRunListener的environmentPrepared()的方法,告訴他們:“當(dāng)前SpringBoot應(yīng)用使用的Environment準(zhǔn)備好了咯!”。
5) 如果SpringApplication的showBanner屬性被設(shè)置為true,則打印banner。
6) 根據(jù)用戶是否明確設(shè)置了applicationContextClass類型以及初始化階段的推斷結(jié)果,決定該為當(dāng)前SpringBoot應(yīng)用創(chuàng)建什么類型的ApplicationContext并創(chuàng)建完成,然后根據(jù)條件決定是否添加ShutdownHook,決定是否使用自定義的BeanNameGenerator,決定是否使用自定義的ResourceLoader,當(dāng)然,最重要的,將之前準(zhǔn)備好的Environment設(shè)置給創(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)準(zhǔn)備完畢的ApplicationContext。
10) 遍歷調(diào)用所有SpringApplicationRunListener的contextLoaded()方法。
11) 調(diào)用ApplicationContext的refresh()方法,完成IoC容器可用的最后一道工序。
12) 查找當(dāng)前ApplicationContext中是否注冊有CommandLineRunner,如果有,則遍歷執(zhí)行它們。
13) 正常情況下,遍歷執(zhí)行SpringApplicationRunListener的finished()方法、(如果整個過程出現(xiàn)異常,則依然調(diào)用所有SpringApplicationRunListener的finished()方法,只不過這種情況下會將異常信息一并傳入處理)
去除事件通知點后,整個流程如下:
本文以調(diào)試一個實際的SpringBoot啟動程序為例,參考流程中主要類類圖,來分析其啟動邏輯和自動化配置原理。
總覽:
上圖為SpringBoot啟動結(jié)構(gòu)圖,我們發(fā)現(xiàn)啟動流程主要分為三個部分,第一部分進行SpringApplication的初始化模塊,配置一些基本的環(huán)境變量、資源、構(gòu)造器、監(jiān)聽器,第二部分實現(xiàn)了應(yīng)用具體的啟動方案,包括啟動流程的監(jiān)聽模塊、加載配置環(huán)境模塊、及核心的創(chuàng)建上下文環(huán)境模塊,第三部分是自動化配置模塊,該模塊作為springboot自動配置核心,在后面的分析中會詳細(xì)討論。在下面的啟動程序中我們會串聯(lián)起結(jié)構(gòu)中的主要功能。
啟動:
每個SpringBoot程序都有一個主入口,也就是main方法,main里面調(diào)用SpringApplication.run()啟動整個spring-boot程序,該方法所在類需要使用@SpringBootApplication注解,以及@ImportResource注解(if need),@SpringBootApplication包括三個注解,功能如下:
@EnableAutoConfiguration:SpringBoot根據(jù)應(yīng)用所聲明的依賴來對Spring框架進行自動配置。
@SpringBootConfiguration(內(nèi)部為@Configuration):被標(biāo)注的類等于在spring的XML配置文件中(applicationContext.xml),裝配所有bean事務(wù),提供了一個spring的上下文環(huán)境。
@ComponentScan:組件掃描,可自動發(fā)現(xiàn)和裝配Bean,默認(rèn)掃描SpringApplication的run方法里的Booter.class所在的包路徑下文件,所以最好將該啟動類放到根包路徑下。
SpringBoot啟動類
首先進入run方法
run方法中去創(chuàng)建了一個SpringApplication實例,在該構(gòu)造方法內(nèi),我們可以發(fā)現(xiàn)其調(diào)用了一個初始化的initialize方法
這里主要是為SpringApplication對象賦一些初值。構(gòu)造函數(shù)執(zhí)行完畢后,我們回到run方法
該方法中實現(xiàn)了如下幾個關(guān)鍵步驟:
1.創(chuàng)建了應(yīng)用的監(jiān)聽器SpringApplicationRunListeners并開始監(jiān)聽
2.加載SpringBoot配置環(huán)境(ConfigurableEnvironment),如果是通過web容器發(fā)布,會加載StandardEnvironment,其最終也是繼承了ConfigurableEnvironment,類圖如下
可以看出,*Environment最終都實現(xiàn)了PropertyResolver接口,我們平時通過environment對象獲取配置文件中指定Key對應(yīng)的value方法時,就是調(diào)用了propertyResolver接口的getProperty方法
3.配置環(huán)境(Environment)加入到監(jiān)聽器對象中(SpringApplicationRunListeners)
4.創(chuàng)建run方法的返回對象:ConfigurableApplicationContext(應(yīng)用配置上下文),我們可以看一下創(chuàng)建方法:
方法會先獲取顯式設(shè)置的應(yīng)用上下文(applicationContextClass),如果不存在,再加載默認(rèn)的環(huán)境配置(通過是否是web environment判斷),默認(rèn)選擇AnnotationConfigApplicationContext注解上下文(通過掃描所有注解類來加載bean),最后通過BeanUtils實例化上下文對象,并返回。
ConfigurableApplicationContext類圖如下:
主要看其繼承的兩個方向:
LifeCycle:生命周期類,定義了start啟動、stop結(jié)束、isRunning是否運行中等生命周期空值方法
ApplicationContext:應(yīng)用上下文類,其主要繼承了beanFactory(bean的工廠類)
5.回到run方法內(nèi),prepareContext方法將listeners、environment、applicationArguments、banner等重要組件與上下文對象關(guān)聯(lián)
6.接下來的refreshContext(context)方法(初始化方法如下)將是實現(xiàn)spring-boot-starter-*(mybatis、redis等)自動化配置的關(guān)鍵,包括spring.factories的加載,bean的實例化等核心工作。
配置結(jié)束后,Springboot做了一些基本的收尾工作,返回了應(yīng)用環(huán)境上下文。回顧整體流程,Springboot的啟動,主要創(chuàng)建了配置環(huán)境(environment)、事件監(jiān)聽(listeners)、應(yīng)用上下文(applicationContext),并基于以上條件,在容器中開始實例化我們需要的Bean,至此,通過SpringBoot啟動的程序已經(jīng)構(gòu)造完成,接下來我們來探討自動化配置是如何實現(xiàn)。
自動化配置:
之前的啟動結(jié)構(gòu)圖中,我們注意到無論是應(yīng)用初始化還是具體的執(zhí)行過程,都調(diào)用了SpringBoot自動配置模塊。
SpringBoot自動配置模塊
該配置模塊的主要使用到了SpringFactoriesLoader,即Spring工廠加載器,該對象提供了loadFactoryNames方法,入?yún)閒actoryClass和classLoader,即需要傳入上圖中的工廠類名稱和對應(yīng)的類加載器,方法會根據(jù)指定的classLoader,加載該類加器搜索路徑下的指定文件,即spring.factories文件,傳入的工廠類為接口,而文件中對應(yīng)的類則是接口的實現(xiàn)類,或最終作為實現(xiàn)類,所以文件中一般為如下圖這種一對多的類名集合,獲取到這些實現(xiàn)類的類名后,loadFactoryNames方法返回類名集合,方法調(diào)用方得到這些集合后,再通過反射獲取這些類的類對象、構(gòu)造方法,最終生成實例。
工廠接口與其若干實現(xiàn)類接口名稱
下圖有助于我們形象理解自動配置流程。
SpringBoot自動化配置關(guān)鍵組件關(guān)系圖
mybatis-spring-boot-starter、spring-boot-starter-web等組件的META-INF文件下均含有spring.factories文件,自動配置模塊中,SpringFactoriesLoader收集到文件中的類全名并返回一個類全名的數(shù)組,返回的類全名通過反射被實例化,就形成了具體的工廠實例,工廠實例來生成組件具體需要的bean。
之前我們提到了EnableAutoConfiguration注解,其類圖如下:
可以發(fā)現(xiàn)其最終實現(xiàn)了ImportSelector(選擇器)和BeanClassLoaderAware(bean類加載器中間件),重點關(guān)注一下AutoConfigurationImportSelector的selectImports方法。
該方法在springboot啟動流程——bean實例化前被執(zhí)行,返回要實例化的類信息列表。我們知道,如果獲取到類信息,spring自然可以通過類加載器將類加載到j(luò)vm中,現(xiàn)在我們已經(jīng)通過spring-boot的starter依賴方式依賴了我們需要的組件,那么這些組建的類信息在select方法中也是可以被獲取到的,不要急我們繼續(xù)向下分析。
該方法中的getCandidateConfigurations方法,通過方法注釋了解到,其返回一個自動配置類的類名列表,方法調(diào)用了loadFactoryNames方法,查看該方法
在上面的代碼可以看到自動配置器會根據(jù)傳入的factoryClass.getName()到項目系統(tǒng)路徑下所有的spring.factories文件中找到相應(yīng)的key,從而加載里面的類。我們就選取這個mybatis-spring-boot-autoconfigure下的spring.factories文件
進入org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration中,主要看一下類頭:
發(fā)現(xiàn)Spring的@Configuration,儼然是一個通過注解標(biāo)注的springBean,繼續(xù)向下看,
@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class})這個注解的意思是:當(dāng)存在SqlSessionFactory.class, SqlSessionFactoryBean.class這兩個類時才解析MybatisAutoConfiguration配置類,否則不解析這一個配置類,make sence,我們需要mybatis為我們返回會話對象,就必須有會話工廠相關(guān)類。
@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可以直接配置好相關(guān)的類,觸發(fā)自動配置所需的依賴(mybatis)如下:
這里是截取的mybatis-spring-boot-starter的源碼中pom.xml文件中所有依賴:
因為maven依賴的傳遞性,我們只要依賴starter就可以依賴到所有需要自動配置的類,實現(xiàn)開箱即用的功能。也體現(xiàn)出Springboot簡化了Spring框架帶來的大量XML配置以及復(fù)雜的依賴管理,讓開發(fā)人員可以更加關(guān)注業(yè)務(wù)邏輯的開發(fā)。
到此這篇關(guān)于Springboot通過run啟動web應(yīng)用的方法的文章就介紹到這了,更多相關(guān)Springboot啟動web應(yīng)用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring Data JPA踩坑記錄(@id @GeneratedValue)
這篇文章主要介紹了Spring Data JPA踩坑記錄(@id @GeneratedValue),具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-07-07詳解Servlet3.0新特性(從注解配置到websocket編程)
Servlet3.0的出現(xiàn)是servlet史上最大的變革,其中的許多新特性大大的簡化了web應(yīng)用的開發(fā),為廣大勞苦的程序員減輕了壓力,提高了web開發(fā)的效率。2017-04-04SpringBoot實現(xiàn)ORM操作MySQL的幾種方法
本文主要介紹了SpringBoot實現(xiàn)ORM操作MySQL的幾種方法,文中通過示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下2022-02-02SpringCloud Ribbon與OpenFeign詳解如何實現(xiàn)服務(wù)調(diào)用
這篇文章主要介紹了SpringCloud Ribbon與OpenFeign實現(xiàn)服務(wù)調(diào)用的過程,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-09-09JAVA多線程之中斷機制stop()、interrupted()、isInterrupted()
這篇文章主要介紹了JAVA多線程之中斷機制stop()、interrupted()、isInterrupted()的相關(guān)資料,需要的朋友可以參考下2016-05-05