首先貼一張很不錯(cuò)的圖,SpringBoot啟動結(jié)構(gòu)圖石窑,圖片出自SpringBoot啟動流程解析牌芋。
本文的分析基于Spring Boot 2.1.5,非Spring的代碼只有下面這個(gè)啟動main函數(shù):
@SpringBootApplication
public class App {
public static void main(String[] args) {
SpringApplication application = new SpringApplication(AppServer.class);
application.run(args);
}
}
構(gòu)造函數(shù)
SpringApplication
的構(gòu)造函數(shù)實(shí)例化了 初始化上下文的各種接口--ApplicationContextInitializer
以及監(jiān)聽器--ApplicationListener
松逊,要注意的是這里的實(shí)例化姜贡,并不像平時(shí)的Spring Components一樣通過注解和掃包完成,而是通過一種不依賴Spring上下文的加載方法棺棵,這樣才能在Spring完成啟動前做各種配置楼咳。Spring的解決方法是以接口的全限定名作為key,實(shí)現(xiàn)類的全限定名作為value記錄在項(xiàng)目的META-INF/spring.factories
文件中烛恤,然后通過SpringFactoriesLoader
工具類提供靜態(tài)方法進(jìn)行類加載并緩存下來母怜,spring.factories
是Spring Boot的核心配置文件,后面會繼續(xù)說明缚柏。另外比較有意思的是兩個(gè)deduce方法苹熏,Spring Boot項(xiàng)目主要的目標(biāo)之一就是自動化配置,通過這兩個(gè)deduce方法可以看出币喧,Spring Boot的判斷方法之一是檢查系統(tǒng)中是否存在的核心類轨域。
public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {
this.resourceLoader = resourceLoader;
Assert.notNull(primarySources, "PrimarySources must not be null");
this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
this.webApplicationType = WebApplicationType.deduceFromClasspath();//通過核心類判斷是否開啟、開啟什么web容器
//實(shí)例化初始器
setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
//實(shí)例化監(jiān)聽器
setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
this.mainApplicationClass = deduceMainApplicationClass();
}
Run
初始化完成之后就進(jìn)到了run方法杀餐,run方法完成了所有Spring的整個(gè)啟動過程:準(zhǔn)備Environment——發(fā)布事件——?jiǎng)?chuàng)建上下文干发、bean——刷新上下文——結(jié)束,其中穿插了很多監(jiān)聽器的動作史翘,并且很多邏輯都是靠各種監(jiān)聽器的實(shí)現(xiàn)類執(zhí)行的枉长,所以在分析run方法之前,先看下各種核心監(jiān)聽器琼讽、接口的作用必峰。
ConfigurableApplicationContext
不得不說,用IDEA分析源碼真的很方便钻蹬,直接生成接口的UML類圖:
相對于只讀的
ApplicationContext
而言吼蚁,ConfigurableApplicationContext
提供了配置上下文的接口,如設(shè)置Environment问欠、監(jiān)聽器肝匆、切面類、關(guān)閉上下文的鉤子等溅潜,還有刷新上下文的接口术唬。默認(rèn)是只讀的接口,接口名前面加Configurable
對應(yīng)是一個(gè)提供可配置接口的新接口——在Spring很多配置相關(guān)的接口中都有這樣的繼承形式滚澜,例如ConfigurableEnvironment和Environment粗仓、ConfigurablePropertyResolver和PropertyResolver、ConfigurableBeanFactory和BeanFactory等等。繼承的三個(gè)父類接口里借浊,
Closeable
提供了關(guān)閉時(shí)資源釋放的接口塘淑,Lifecycle
是提供對生命周期控制的接口(start\stop)以及查詢當(dāng)前運(yùn)行狀態(tài)的接口,ApplicationContext
則是配置上下文的中心配置接口蚂斤,繼承了其他很多配置接口存捺,其本身提供查詢諸如id、應(yīng)用程序名等上下文檔案信息的只讀接口曙蒸,以及構(gòu)建自動裝配bean的工廠(注釋上官方說該接口提供的工廠是用于注冊上下文外部的bean的捌治,但調(diào)試發(fā)現(xiàn)和在程序內(nèi)@Autowired
獲取到的工廠是同一個(gè)對象...)。簡單寫下ApplicationContext
繼承的父類接口纽窟。
- EnvironmentCapable
提供Environment接口肖油。 - MessageSource
國際化資源接口。 - ApplicationEventPublisher
事件發(fā)布器臂港。 - ResourcePatternResolver
資源加載器森枪。 - HierarchicalBeanFactory、ListableBeanFactory
這兩個(gè)都繼承了bean容器的根接口BeanFactory
审孽,具體在另一篇博客Spring的bean工廠分析分析县袱。
ConfigurableEnvironment
一般在寫業(yè)務(wù)代碼時(shí)使用的都是只讀類型的接口Environment
,該接口是對運(yùn)行程序環(huán)境的抽象佑力,是保存系統(tǒng)配置的中心式散,而在啟動過程中使用的則是可編輯的ConfigurableEnvironment
。接口的UML類圖如下搓萧,提供了合并父環(huán)境杂数、添加active profile以及一些設(shè)置解析配置文件方式的接口宛畦。
其中一個(gè)比較重要的方法MutablePropertySources getPropertySources();
瘸洛,該方法返回一個(gè)可編輯的PropertySources
,如果有在啟動階段自定義環(huán)境的PropertySources的需求次和,就可以通過該方法設(shè)置反肋。
EventPublishingRunListener
該監(jiān)聽器實(shí)際上是一個(gè)用于廣播Spring事件的廣播器,實(shí)現(xiàn)SpringApplicationRunListener
接口的方法都是包裝一個(gè)Spring事件并進(jìn)行廣播踏施,例如:
@Override
public void contextPrepared(ConfigurableApplicationContext context) {
this.initialMulticaster.multicastEvent(new ApplicationContextInitializedEvent(this.application, this.args, context));
}
@Override
public void running(ConfigurableApplicationContext context) {
context.publishEvent(new ApplicationReadyEvent(this.application, this.args, context));
}
可以看到有兩種廣播方式石蔗,一種是當(dāng)Spring還在啟動的時(shí)候,通過監(jiān)聽器內(nèi)部的SimpleApplicationEventMulticaster
廣播器進(jìn)行廣播畅形;一種是當(dāng)Spring啟動完成內(nèi)部的廣播器可用時(shí)养距,直接調(diào)用上下文提供的接口進(jìn)行廣播。
繼續(xù)分析Run
了解了一些核心的接口后日熬,就可以啟動Debug模式運(yùn)行Run方法了棍厌,由于涉及的方法調(diào)用很多,以下代碼將拆分源碼,并將方法簽名記在前面耘纱。
首先開啟了一個(gè)秒表用來統(tǒng)計(jì)啟動時(shí)間并在日志打泳炊恰(如果開啟控制字),聲明了一些在后面需要用到的變量束析,然后開始初始化SpringApplicationRunListener
類型的監(jiān)聽器艳馒,SpringApplicationRunListeners
對監(jiān)聽器List進(jìn)行了封裝,例如調(diào)用.starting()
時(shí)會遍歷內(nèi)部所有監(jiān)聽器調(diào)用其.starting()
方法员寇。
public ConfigurableApplicationContext run(String... args){
StopWatch stopWatch = new StopWatch();
stopWatch.start();
ConfigurableApplicationContext context = null;
Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
configureHeadlessProperty();//開啟設(shè)置弄慰,讓系統(tǒng)模擬不存在io設(shè)備,略蝶锋。曹动。
SpringApplicationRunListeners listeners = getRunListeners(args);//初始化監(jiān)聽器
listeners.starting();
...
private SpringApplicationRunListeners getRunListeners(String[] args) {
Class<?>[] types = new Class<?>[] { SpringApplication.class, String[].class };//SpringApplicationRunListener的構(gòu)造函數(shù)參數(shù)類型
return new SpringApplicationRunListeners(logger, getSpringFactoriesInstances(SpringApplicationRunListener.class, types, this, args));
}
private <T> Collection<T> getSpringFactoriesInstances(Class<T> type, Class<?>[] parameterTypes, Object... args) {
ClassLoader classLoader = getClassLoader();//從當(dāng)前線程獲取類加載器
//Spring的類加載工具會從注冊文件META-INF/spring.factories用指定的類加載器加載類,這里返回相應(yīng)類型的實(shí)現(xiàn)類全限定名
Set<String> names = new LinkedHashSet<>(SpringFactoriesLoader.loadFactoryNames(type, classLoader));
List<T> instances = createSpringFactoriesInstances(type, parameterTypes, classLoader, args, names);//實(shí)例化
//Spring的排序工具牲览,對繼承了Ordered接口或者@Priority標(biāo)記的類進(jìn)行排序
AnnotationAwareOrderComparator.sort(instances);
return instances;
}
調(diào)試發(fā)現(xiàn)墓陈,注冊為SpringApplicationRunListener
的實(shí)現(xiàn)類只有EventPublishingRunListener
,之前說過該注冊器是一個(gè)用于廣播Spring事件的廣播器第献,進(jìn)到構(gòu)造函數(shù)中可以看到都有哪些監(jiān)聽器被綁定到了這個(gè)廣播器中贡必,這里每個(gè)監(jiān)聽器的作用就不再深入了,需要說的是庸毫,如果在項(xiàng)目中有什么需要集成到Spring的框架仔拟,可以注冊SpringApplicationRunListener\ApplicationListener
的實(shí)現(xiàn)類,監(jiān)聽Spring的不同啟動事件并執(zhí)行集成的邏輯飒赃。當(dāng)然也有別的方法利花,例如:Creating a Custom Starter with Spring Boot。
繼續(xù)往下看run方法载佳,這里重點(diǎn)是準(zhǔn)備Environment
的邏輯炒事。首先Spring會根據(jù)web容器的類型新建一個(gè)ConfigurableEnvironment
,不同的web容器類型的Environment
會重載customizePropertySources
方法蔫慧,該方法會注入不同的propertySources挠乳,例如如果開啟內(nèi)嵌的Servlet容器,就會注入servlet context init params
等相關(guān)的參數(shù)姑躲。接下來會對新建的Environment
執(zhí)行配置寫入的邏輯睡扬,主要是把main方法中設(shè)置到SpringApplication
的參數(shù)寫入到Environment
中,然后發(fā)布ApplicationEnvironmentPreparedEvent
事件黍析,做一些綁定后返回Environment
卖怜。吐槽下Spring對Environment的處理這塊的代碼寫得很深?yuàn)W,看不懂~
try {
ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);//封裝main方法的參數(shù)
//初始化填充Environment的參數(shù)
ConfigurableEnvironment environment = prepareEnvironment(listeners,applicationArguments);
configureIgnoreBeanInfo(environment);//設(shè)置獲取BeanInfo的一個(gè)參數(shù)阐枣,有興趣的可以去了解下Introspector.getBeanInfo(Class<?> beanClass, int flags)這個(gè)方法
...
private ConfigurableEnvironment prepareEnvironment(SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments) {
//新建\獲取當(dāng)前Environment實(shí)例
ConfigurableEnvironment environment = getOrCreateEnvironment();
configureEnvironment(environment, applicationArguments.getSourceArgs());//配置參數(shù)
listeners.environmentPrepared(environment);//發(fā)布事件
bindToSpringApplication(environment);//綁定"spring.main"為當(dāng)前的application马靠,做SpEL用
if (!this.isCustomEnvironment) {//轉(zhuǎn)換environment的類型牍戚,但這里應(yīng)該類型和deduce的相同不用轉(zhuǎn)換
environment = new EnvironmentConverter(getClassLoader()).convertEnvironmentIfNecessary(environment, deduceEnvironmentClass());
}
//將現(xiàn)有的配置封裝成ConfigurationPropertySourcesPropertySource,看起來是為了做SpEL的虑粥,看不懂~
ConfigurationPropertySources.attach(environment);
return environment;
}
protected void configureEnvironment(ConfigurableEnvironment environment, String[] args) {
if (this.addConversionService) {//默認(rèn)開啟如孝,會注入一組轉(zhuǎn)換工具,例如StringToDurationConverter
ConversionService conversionService = ApplicationConversionService.getSharedInstance();
environment.setConversionService(ConfigurableConversionService) conversionService);
}
configurePropertySources(environment, args);//如果main啟動時(shí)設(shè)置了默認(rèn)參數(shù)或者有命令行參數(shù)娩贷,則寫入到environment中
configureProfiles(environment, args);//如果main啟動時(shí)設(shè)置了profile第晰,則寫入到environment的ActiveProfiles中
}
繼續(xù)往下看run方法,這里會創(chuàng)建Spring的上下文實(shí)例彬祖,詳情請看另一篇博客Spring Boot Context分析茁瘦,簡而言之就是根據(jù)Web容器類型的不同來創(chuàng)建不用的上下文實(shí)例。
Banner printedBanner = printBanner(environment);//打應(yīng)標(biāo)語
context = createApplicationContext();//創(chuàng)建上下文實(shí)例
//異常播報(bào)器储笑,默認(rèn)有org.springframework.boot.diagnostics.FailureAnalyzers
exceptionReporters = getSpringFactoriesInstances(SpringBootExceptionReporter.class, new Class[] { ConfigurableApplicationContext.class }, context);
...
繼續(xù)往下看run方法甜熔,接下來是對剛創(chuàng)建的上下文完成加載。加載過程先填充Environment
以及設(shè)置的參數(shù)突倍,然后執(zhí)行注冊到spring.factories
的ApplicationContextInitializer
切面腔稀,如果自己實(shí)現(xiàn)切面的話要注意這時(shí)context已經(jīng)有的信息是什么。接著發(fā)布ApplicationContextInitializedEvent
事件羽历,然后加載bean焊虏,最后發(fā)布ApplicationPreparedEvent
事件。
prepareContext(context, environment, listeners, applicationArguments,printedBanner);
...
private void prepareContext(ConfigurableApplicationContext context, ConfigurableEnvironment environment, SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments, Banner printedBanner) {
context.setEnvironment(environment);
//如果application有設(shè)置beanNameGenerator秕磷、resourceLoader就將其注入到上下文中诵闭,并將轉(zhuǎn)換工具也注入到上下文中
postProcessApplicationContext(context);
applyInitializers(context);//調(diào)用初始化的切面
listeners.contextPrepared(context);//發(fā)布ApplicationContextInitializedEvent事件
if (this.logStartupInfo) {//日志
logStartupInfo(context.getParent() == null);
logStartupProfileInfo(context);
}
// Add boot specific singleton beans
ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
beanFactory.registerSingleton("springApplicationArguments", applicationArguments);//注入main方法的參數(shù)
if (printedBanner != null) {
beanFactory.registerSingleton("springBootBanner", printedBanner);
}
if (beanFactory instanceof DefaultListableBeanFactory) {
//如果bean名相同的話是否允許覆蓋,默認(rèn)為false澎嚣,相同會拋出異常
((DefaultListableBeanFactory) beanFactory).setAllowBeanDefinitionOverriding(this.allowBeanDefinitionOverriding);
}
// 這里獲取到的是BootstrapImportSelectorConfiguration這個(gè)class疏尿,而不是自己寫的啟動來,這個(gè)class是在之前注冊的BootstrapApplicationListener的監(jiān)聽方法中注入的
Set<Object> sources = getAllSources();
Assert.notEmpty(sources, "Sources must not be empty");
load(context, sources.toArray(new Object[0]));//加載sources 到上下文中
listeners.contextLoaded(context);//發(fā)布ApplicationPreparedEvent事件
}
回到run方法易桃,在實(shí)例化上下文并完成相關(guān)配置后褥琐,會刷新上下文。
refreshContext(context);
...
AbstractApplicationContext
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
//記錄啟動時(shí)間颈抚、狀態(tài)踩衩,web容器初始化其property,復(fù)制listener
prepareRefresh();
//這里返回的是context的BeanFactory
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
//beanFactory注入一些標(biāo)準(zhǔn)組件贩汉,例如ApplicationContextAwareProcessor,ClassLoader等
prepareBeanFactory(beanFactory);
try {
//給實(shí)現(xiàn)類留的一個(gè)鉤子锚赤,例如注入BeanPostProcessors匹舞,這里是個(gè)空方法
postProcessBeanFactory(beanFactory);
// 調(diào)用切面方法
invokeBeanFactoryPostProcessors(beanFactory);
// 注冊切面bean
registerBeanPostProcessors(beanFactory);
// Initialize message source for this context.
initMessageSource();
// bean工廠注冊一個(gè)key為applicationEventMulticaster的廣播器
initApplicationEventMulticaster();
// 給實(shí)現(xiàn)類留的一鉤子,可以執(zhí)行其他refresh的工作线脚,這里是個(gè)空方法
onRefresh();
// 將listener注冊到廣播器中
registerListeners();
// 實(shí)例化未實(shí)例化的bean
finishBeanFactoryInitialization(beanFactory);
// 清理緩存赐稽,注入DefaultLifecycleProcessor叫榕,發(fā)布ContextRefreshedEvent
finishRefresh();
}
catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// Destroy already created singletons to avoid dangling resources.
destroyBeans();
// Reset 'active' flag.
cancelRefresh(ex);
// Propagate exception to caller.
throw ex;
}
finally {
// Reset common introspection caches in Spring's core, since we
// might not ever need metadata for singleton beans anymore...
resetCommonCaches();
}
}
}
回到run方法,最后的邏輯就是發(fā)布啟動完成的事件姊舵,并調(diào)用監(jiān)聽者的方法晰绎。
...
afterRefresh(context, applicationArguments);//給實(shí)現(xiàn)類留的鉤子,這里是一個(gè)空方法括丁。
stopWatch.stop();
if (this.logStartupInfo) {
new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), stopWatch);
}
listeners.started(context);//發(fā)布ApplicationStartedEvent事件
callRunners(context, applicationArguments);
}
catch (Throwable ex) {
handleRunFailure(context, ex, exceptionReporters, listeners);
throw new IllegalStateException(ex);
}
try {
listeners.running(context);//發(fā)布ApplicationReadyEvent事件
}
catch (Throwable ex) {
handleRunFailure(context, ex, exceptionReporters, null);
throw new IllegalStateException(ex);
}
return context;