文章轉(zhuǎn)載: SpringBoot啟動(dòng)流程分析(一):SpringApplication類初始化過(guò)程
目錄
SpringBoot系列文章簡(jiǎn)介
SpringBoot源碼閱讀輔助篇:
Spring IoC容器與應(yīng)用上下文的設(shè)計(jì)與實(shí)現(xiàn)
SpringBoot啟動(dòng)流程源碼分析:
- SpringBoot啟動(dòng)流程分析(一):SpringApplication類初始化過(guò)程
- SpringBoot啟動(dòng)流程分析(二):SpringApplication的run方法
- SpringBoot啟動(dòng)流程分析(三):SpringApplication的run方法之prepareContext()方法
- SpringBoot啟動(dòng)流程分析(四):IoC容器的初始化過(guò)程
- SpringBoot啟動(dòng)流程分析(五):SpringBoot自動(dòng)裝配原理實(shí)現(xiàn)
- SpringBoot啟動(dòng)流程分析(六):IoC容器依賴注入
筆者注釋版Spring Framework與SpringBoot源碼git傳送門:請(qǐng)不要吝嗇小星星
一袋励、SpringApplication初始化過(guò)程
1.1、SpringBoot項(xiàng)目的mian函數(shù)
常規(guī)的這個(gè)主類如下圖所示,我們一般會(huì)這樣去寫醉箕。
在這個(gè)類中需要關(guān)注的是
- @SpringBootApplication
- SpringApplication.run()
關(guān)于 @SpringBootApplication 注解,在后面分析SpringBoot自動(dòng)裝配的章節(jié)會(huì)展開(kāi)去分析。
本章節(jié)中我們需要關(guān)注的就是 SpringApplication.run() 方法损肛。
查看run()方法的實(shí)現(xiàn),如下面代碼所示忍啤,我們發(fā)現(xiàn)其實(shí)其首先是創(chuàng)建了 SpringApplication 的實(shí)例,然后調(diào)用了 SpringApplication 的run()方法未檩,那本章我們關(guān)注的就是 SpringApplication 創(chuàng)建實(shí)例的過(guò)程。
/**
* Static helper that can be used to run a {@link SpringApplication} from the
* specified sources using default settings and user supplied arguments.
*
* @param primarySources the primary sources to load
* @param args the application arguments (usually passed from a Java main method)
* @return the running {@link ApplicationContext}
*/
public static ConfigurableApplicationContext run(Class<?>[] primarySources,
String[] args) {
return new SpringApplication(primarySources).run(args);
}
1.2、 SpringApplication() 構(gòu)造方法
繼續(xù)查看源碼合瓢, SpringApplication 實(shí)例化過(guò)程顿苇,首先是進(jìn)入但參數(shù)的構(gòu)造方法,最終回來(lái)到兩個(gè)參數(shù)的構(gòu)造方法幔翰。
public SpringApplication(Class<?>... primarySources) {
this(null, primarySources);
}
@SuppressWarnings({"unchecked", "rawtypes"})
public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {
this.resourceLoader = resourceLoader;
Assert.notNull(primarySources, "PrimarySources must not be null");
this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
//推斷應(yīng)用類型,后面會(huì)根據(jù)類型初始化對(duì)應(yīng)的環(huán)境。常用的一般都是servlet環(huán)境
this.webApplicationType = deduceWebApplicationType();//2.2.1
//初始化classpath下 META-INF/spring.factories中已配置的ApplicationContextInitializer
setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));//2.2.2
//初始化classpath下所有已配置的 ApplicationListener
setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));//2.2.3
//根據(jù)調(diào)用棧,推斷出 main 方法的類名
this.mainApplicationClass = deduceMainApplicationClass();
}
1.2.1、deduceWebApplicationType();該方法推斷應(yīng)用的類型签杈。 SERVLET REACTIVE NONE
//常量值
private static final String[] WEB_ENVIRONMENT_CLASSES = {"javax.servlet.Servlet",
"org.springframework.web.context.ConfigurableWebApplicationContext"};
private static final String REACTIVE_WEB_ENVIRONMENT_CLASS = "org.springframework."
+ "web.reactive.DispatcherHandler";
private static final String MVC_WEB_ENVIRONMENT_CLASS = "org.springframework."
+ "web.servlet.DispatcherServlet";
private static final String JERSEY_WEB_ENVIRONMENT_CLASS = "org.glassfish.jersey.server.ResourceConfig";
/**
* 判斷 應(yīng)用的類型
* NONE: 應(yīng)用程序不是web應(yīng)用,也不應(yīng)該用web服務(wù)器去啟動(dòng)
* SERVLET: 應(yīng)用程序應(yīng)作為基于servlet的web應(yīng)用程序運(yùn)行,并應(yīng)啟動(dòng)嵌入式servlet web(tomcat)服務(wù)器敲长。
* REACTIVE: 應(yīng)用程序應(yīng)作為 reactive web應(yīng)用程序運(yùn)行,并應(yīng)啟動(dòng)嵌入式 reactive web服務(wù)器辑鲤。
* @return
*/
private WebApplicationType deduceWebApplicationType() {
//classpath下必須存在org.springframework.web.reactive.DispatcherHandler
if (ClassUtils.isPresent(REACTIVE_WEB_ENVIRONMENT_CLASS, null)
&& !ClassUtils.isPresent(MVC_WEB_ENVIRONMENT_CLASS, null)
&& !ClassUtils.isPresent(JERSEY_WEB_ENVIRONMENT_CLASS, null)) {
return WebApplicationType.REACTIVE;
}
for (String className : WEB_ENVIRONMENT_CLASSES) {
if (!ClassUtils.isPresent(className, null)) {
return WebApplicationType.NONE;
}
}
//classpath環(huán)境下存在javax.servlet.Servlet或者org.springframework.web.context.ConfigurableWebApplicationContext
return WebApplicationType.SERVLET;
}
返回類型是WebApplicationType的枚舉類型, WebApplicationType 有三個(gè)枚舉撵幽,三個(gè)枚舉的解釋如其中注釋
具體的判斷邏輯如下:
WebApplicationType.REACTIVE classpath下存在org.springframework.web.reactive.DispatcherHandler
WebApplicationType.SERVLET classpath下存在javax.servlet.Servlet或者org.springframework.web.context.ConfigurableWebApplicationContext
WebApplicationType.NONE 不滿足以上條件。
1.2.2、 setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
初始化classpath下 META-INF/spring.factories中已配置的ApplicationContextInitializer强衡。
private <T> Collection<T> getSpringFactoriesInstances(Class<T> type) {
return getSpringFactoriesInstances(type, new Class<?>[]{});
}
/**
* 通過(guò)指定的classloader 從META-INF/spring.factories獲取指定的Spring的工廠實(shí)例
* @param type
* @param parameterTypes
* @param args
* @param <T>
* @return
*/
private <T> Collection<T> getSpringFactoriesInstances(Class<T> type,
Class<?>[] parameterTypes, Object... args) {
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
// Use names and ensure unique to protect against duplicates
//通過(guò)指定的classLoader從 META-INF/spring.factories 的資源文件中,
//讀取 key 為 type.getName() 的 value
Set<String> names = new LinkedHashSet<>(SpringFactoriesLoader.loadFactoryNames(type, classLoader));
//創(chuàng)建Spring工廠實(shí)例
List<T> instances = createSpringFactoriesInstances(type, parameterTypes,
classLoader, args, names);
//對(duì)Spring工廠實(shí)例排序(org.springframework.core.annotation.Order注解指定的順序)
AnnotationAwareOrderComparator.sort(instances);
return instances;
}
看看 getSpringFactoriesInstances 都干了什么,看源碼,有一個(gè)方法很重要 loadFactoryNames() 這個(gè)方法很重要亿傅,這個(gè)方法是spring-core中提供的從META-INF/spring.factories中獲取指定的類(key)的同一入口方法。
在這里坪蚁,獲取的是key為 org.springframework.context.ApplicationContextInitializer 的類。
debug看看都獲取到了哪些
上面說(shuō)了,是從classpath下 META-INF/spring.factories中獲取耗拓,我們驗(yàn)證一下:
發(fā)現(xiàn)在上圖所示的兩個(gè)工程中找到了debug中看到的6條結(jié)果韵洋。 ApplicationContextInitializer 是Spring框架的類, 這個(gè)類的主要目的就是在 ConfigurableApplicationContext 調(diào)用refresh()方法之前食拜,回調(diào)這個(gè)類的initialize方法负甸。通過(guò) ConfigurableApplicationContext 的實(shí)例獲取容器的環(huán)境Environment,從而實(shí)現(xiàn)對(duì)配置文件的修改完善等工作带污。
關(guān)于怎么實(shí)現(xiàn)自定義的 ApplicationContextInitializer 請(qǐng)看我的另一篇專門介紹該類的博客报破。
1.2.3梗脾、 setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
初始化classpath下 META-INF/spring.factories中已配置的 ApplicationListener。
ApplicationListener 的加載過(guò)程和上面的 ApplicationContextInitializer 類的加載過(guò)程是一樣的梭冠。不多說(shuō)了,至于 ApplicationListener 是spring的事件監(jiān)聽(tīng)器偶翅,典型的觀察者模式聚谁,通過(guò) ApplicationEvent 類和 ApplicationListener 接口,可以實(shí)現(xiàn)對(duì)spring容器全生命周期的監(jiān)聽(tīng)骤宣,當(dāng)然也可以自定義監(jiān)聽(tīng)事件。為了梳理springboot的啟動(dòng)流程在這里先不說(shuō)這個(gè)了。后面有時(shí)間的話再介紹锰霜。
關(guān)于ApplicationContextInitializer的詳細(xì)介紹請(qǐng)看<SpringBoot之ApplicationContextInitializer的理解和使用>
二、總結(jié)
關(guān)于 SpringApplication 類的構(gòu)造過(guò)程友存,到這里我們就梳理完了√招疲縱觀 SpringApplication 類的實(shí)例化過(guò)程屡立,我們可以看到,合理的利用該類搀军,我們能在spring容器創(chuàng)建之前做一些預(yù)備工作膨俐,和定制化的需求罩句。
比如焚刺,自定義SpringBoot的Banner,比如自定義事件監(jiān)聽(tīng)器的止,再比如在容器refresh之前通過(guò)自定義 ApplicationContextInitializer 修改配置一些配置或者獲取指定的bean都是可以的檩坚。。。