漲姿式：Spring Boot 2.x 啓動全過程源碼分析

時間  2019-11-08
標籤 spring boot 2.x 啓動 全過程 源碼 分析 欄目 Spring 简体版
原文   原文鏈接

上篇《Spring Boot 2.x 啓動全過程源碼分析（一）入口類剖析》咱們分析了 Spring Boot 入口類 SpringApplication 的源碼，並知道了其構造原理，這篇咱們繼續往下面分析其核心 run 方法。html

[toc]java

SpringApplication 實例 run 方法運行過程

上面分析了 SpringApplication 實例對象構造方法初始化過程，下面繼續來看下這個 SpringApplication 對象的 run 方法的源碼和運行流程。web

public ConfigurableApplicationContext run(String... args) {
    // 一、建立並啓動計時監控類
	StopWatch stopWatch = new StopWatch();
	stopWatch.start();
	
	// 二、初始化應用上下文和異常報告集合
	ConfigurableApplicationContext context = null;
	Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
	
	// 三、設置系統屬性 `java.awt.headless` 的值，默認值爲：true
	configureHeadlessProperty();
	
	// 四、建立全部 Spring 運行監聽器併發布應用啓動事件
	SpringApplicationRunListeners listeners = getRunListeners(args);
	listeners.starting();
	
	try {
	    // 五、初始化默認應用參數類
		ApplicationArguments applicationArguments = new DefaultApplicationArguments(
				args);
				
		// 六、根據運行監聽器和應用參數來準備 Spring 環境
		ConfigurableEnvironment environment = prepareEnvironment(listeners,
				applicationArguments);
		configureIgnoreBeanInfo(environment);
		
		// 七、建立 Banner 打印類
		Banner printedBanner = printBanner(environment);
		
		// 八、建立應用上下文
		context = createApplicationContext();
		
		// 九、準備異常報告器
		exceptionReporters = getSpringFactoriesInstances(
				SpringBootExceptionReporter.class,
				new Class[] { ConfigurableApplicationContext.class }, context);
				
		// 十、準備應用上下文
		prepareContext(context, environment, listeners, applicationArguments,
				printedBanner);
				
		// 十一、刷新應用上下文
		refreshContext(context);
		
		// 十二、應用上下文刷新後置處理
		afterRefresh(context, applicationArguments);
		
		// 1三、中止計時監控類
		stopWatch.stop();
		
		// 1四、輸出日誌記錄執行主類名、時間信息
		if (this.logStartupInfo) {
			new StartupInfoLogger(this.mainApplicationClass)
					.logStarted(getApplicationLog(), stopWatch);
		}
		
		// 1五、發佈應用上下文啓動完成事件
		listeners.started(context);
		
		// 1六、執行全部 Runner 運行器
		callRunners(context, applicationArguments);
	}
	catch (Throwable ex) {
		handleRunFailure(context, ex, exceptionReporters, listeners);
		throw new IllegalStateException(ex);
	}

	try {
	    // 1七、發佈應用上下文就緒事件
		listeners.running(context);
	}
	catch (Throwable ex) {
		handleRunFailure(context, ex, exceptionReporters, null);
		throw new IllegalStateException(ex);
	}
	
	// 1八、返回應用上下文
	return context;
}

因此，咱們能夠按如下幾步來分解 run 方法的啓動過程。spring

一、建立並啓動計時監控類

StopWatch stopWatch = new StopWatch();
stopWatch.start();

來看下這個計時監控類 StopWatch 的相關源碼：服務器

public void start() throws IllegalStateException {
	start("");
}

public void start(String taskName) throws IllegalStateException {
	if (this.currentTaskName != null) {
		throw new IllegalStateException("Can't start StopWatch: it's already running");
	}
	this.currentTaskName = taskName;
	this.startTimeMillis = System.currentTimeMillis();
}

首先記錄了當前任務的名稱，默認爲空字符串，而後記錄當前 Spring Boot 應用啓動的開始時間。併發

二、初始化應用上下文和異常報告集合

ConfigurableApplicationContext context = null;
Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();

三、設置系統屬性 java.awt.headless 的值

configureHeadlessProperty();

設置該默認值爲：true，Java.awt.headless = true 有什麼做用？app

對於一個 Java 服務器來講常常要處理一些圖形元素，例如地圖的建立或者圖形和圖表等。這些API基本上老是須要運行一個X-server以便能使用AWT（Abstract Window Toolkit，抽象窗口工具集）。然而運行一個沒必要要的 X-server 並非一種好的管理方式。有時你甚至不能運行 X-server,所以最好的方案是運行 headless 服務器，來進行簡單的圖像處理。less

參考：www.cnblogs.com/princessd8251/p/4000016.htmlspring-boot

四、建立全部 Spring 運行監聽器併發布應用啓動事件

SpringApplicationRunListeners listeners = getRunListeners(args);
listeners.starting();

來看下建立 Spring 運行監聽器相關的源碼：工具

private SpringApplicationRunListeners getRunListeners(String[] args) {
	Class<?>[] types = new Class<?>[] { SpringApplication.class, String[].class };
	return new SpringApplicationRunListeners(logger, getSpringFactoriesInstances(
			SpringApplicationRunListener.class, types, this, args));
}

SpringApplicationRunListeners(Log log,
		Collection<? extends SpringApplicationRunListener> listeners) {
	this.log = log;
	this.listeners = new ArrayList<>(listeners);
}

建立邏輯和以前實例化初始化器和監聽器的同樣，同樣調用的是 getSpringFactoriesInstances 方法來獲取配置的監聽器名稱並實例化全部的類。

SpringApplicationRunListener 全部監聽器配置在 spring-boot-2.0.3.RELEASE.jar!/META-INF/spring.factories 這個配置文件裏面。

# Run Listeners
org.springframework.boot.SpringApplicationRunListener=\
org.springframework.boot.context.event.EventPublishingRunListener

五、初始化默認應用參數類

ApplicationArguments applicationArguments = new DefaultApplicationArguments(
		args);

六、根據運行監聽器和應用參數來準備 Spring 環境

ConfigurableEnvironment environment = prepareEnvironment(listeners,
		applicationArguments);
configureIgnoreBeanInfo(environment);

下面咱們主要來看下準備環境的 prepareEnvironment 源碼：

private ConfigurableEnvironment prepareEnvironment(
		SpringApplicationRunListeners listeners,
		ApplicationArguments applicationArguments) {
	// 6.1) 獲取（或者建立）應用環境
	ConfigurableEnvironment environment = getOrCreateEnvironment();
	
	// 6.2) 配置應用環境
	configureEnvironment(environment, applicationArguments.getSourceArgs());
	listeners.environmentPrepared(environment);
	bindToSpringApplication(environment);
	if (this.webApplicationType == WebApplicationType.NONE) {
		environment = new EnvironmentConverter(getClassLoader())
				.convertToStandardEnvironmentIfNecessary(environment);
	}
	ConfigurationPropertySources.attach(environment);
	return environment;
}

6.1) 獲取（或者建立）應用環境

private ConfigurableEnvironment getOrCreateEnvironment() {
	if (this.environment != null) {
		return this.environment;
	}
	if (this.webApplicationType == WebApplicationType.SERVLET) {
		return new StandardServletEnvironment();
	}
	return new StandardEnvironment();
}

這裏分爲標準 Servlet 環境和標準環境。

6.2) 配置應用環境

protected void configureEnvironment(ConfigurableEnvironment environment,
		String[] args) {
	configurePropertySources(environment, args);
	configureProfiles(environment, args);
}

這裏分爲如下兩步來配置應用環境。

  • 配置 property sources
  • 配置 Profiles

這裏主要處理全部 property sources 配置和 profiles 配置。

七、建立 Banner 打印類

Banner printedBanner = printBanner(environment);

這是用來打印 Banner 的處理類，這個沒什麼好說的。

八、建立應用上下文

context = createApplicationContext();

來看下 createApplicationContext() 方法的源碼：

protected ConfigurableApplicationContext createApplicationContext() {
	Class<?> contextClass = this.applicationContextClass;
	if (contextClass == null) {
		try {
			switch (this.webApplicationType) {
			case SERVLET:
				contextClass = Class.forName(DEFAULT_WEB_CONTEXT_CLASS);
				break;
			case REACTIVE:
				contextClass = Class.forName(DEFAULT_REACTIVE_WEB_CONTEXT_CLASS);
				break;
			default:
				contextClass = Class.forName(DEFAULT_CONTEXT_CLASS);
			}
		}
		catch (ClassNotFoundException ex) {
			throw new IllegalStateException(
					"Unable create a default ApplicationContext, "
							+ "please specify an ApplicationContextClass",
					ex);
		}
	}
	return (ConfigurableApplicationContext) BeanUtils.instantiateClass(contextClass);
}

其實就是根據不一樣的應用類型初始化不一樣的上下文應用類。

九、準備異常報告器

exceptionReporters = getSpringFactoriesInstances(
		SpringBootExceptionReporter.class,
		new Class[] { ConfigurableApplicationContext.class }, context);

邏輯和以前實例化初始化器和監聽器的同樣，同樣調用的是 getSpringFactoriesInstances 方法來獲取配置的異常類名稱並實例化全部的異常處理類。

該異常報告處理類配置在 spring-boot-2.0.3.RELEASE.jar!/META-INF/spring.factories 這個配置文件裏面。

# Error Reporters
org.springframework.boot.SpringBootExceptionReporter=\
org.springframework.boot.diagnostics.FailureAnalyzers

十、準備應用上下文

prepareContext(context, environment, listeners, applicationArguments,
		printedBanner);

來看下 prepareContext() 方法的源碼：

private void prepareContext(ConfigurableApplicationContext context,
		ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
		ApplicationArguments applicationArguments, Banner printedBanner) {
	// 10.1）綁定環境到上下文
	context.setEnvironment(environment);
	
	// 10.2）配置上下文的 bean 生成器及資源加載器
	postProcessApplicationContext(context);
	
	// 10.3）爲上下文應用全部初始化器
	applyInitializers(context);
	
	// 10.4）觸發全部 SpringApplicationRunListener 監聽器的 contextPrepared 事件方法
	listeners.contextPrepared(context);
	
	// 10.5）記錄啓動日誌
	if (this.logStartupInfo) {
		logStartupInfo(context.getParent() == null);
		logStartupProfileInfo(context);
	}

	// 10.6）註冊兩個特殊的單例bean
	context.getBeanFactory().registerSingleton("springApplicationArguments",
			applicationArguments);
	if (printedBanner != null) {
		context.getBeanFactory().registerSingleton("springBootBanner", printedBanner);
	}

	// 10.7）加載全部資源
	Set<Object> sources = getAllSources();
	Assert.notEmpty(sources, "Sources must not be empty");
	load(context, sources.toArray(new Object[0]));
	
	// 10.8）觸發全部 SpringApplicationRunListener 監聽器的 contextLoaded 事件方法
	listeners.contextLoaded(context);
}

十一、刷新應用上下文

refreshContext(context);

這個主要是刷新 Spring 的應用上下文，源碼以下，不詳細說明。

private void refreshContext(ConfigurableApplicationContext context) {
	refresh(context);
	if (this.registerShutdownHook) {
		try {
			context.registerShutdownHook();
		}
		catch (AccessControlException ex) {
			// Not allowed in some environments.
		}
	}
}

十二、應用上下文刷新後置處理

afterRefresh(context, applicationArguments);

看了下這個方法的源碼是空的，目前能夠作一些自定義的後置處理操做。

/**
 * Called after the context has been refreshed.
 * @param context the application context
 * @param args the application arguments
 */
protected void afterRefresh(ConfigurableApplicationContext context,
		ApplicationArguments args) {
}

1三、中止計時監控類

stopWatch.stop();
public void stop() throws IllegalStateException {
	if (this.currentTaskName == null) {
		throw new IllegalStateException("Can't stop StopWatch: it's not running");
	}
	long lastTime = System.currentTimeMillis() - this.startTimeMillis;
	this.totalTimeMillis += lastTime;
	this.lastTaskInfo = new TaskInfo(this.currentTaskName, lastTime);
	if (this.keepTaskList) {
		this.taskList.add(this.lastTaskInfo);
	}
	++this.taskCount;
	this.currentTaskName = null;
}

計時監聽器中止，並統計一些任務執行信息。

1四、輸出日誌記錄執行主類名、時間信息

if (this.logStartupInfo) {
	new StartupInfoLogger(this.mainApplicationClass)
			.logStarted(getApplicationLog(), stopWatch);
}

1五、發佈應用上下文啓動完成事件

listeners.started(context);

觸發全部 SpringApplicationRunListener 監聽器的 started 事件方法。

1六、執行全部 Runner 運行器

callRunners(context, applicationArguments);
private void callRunners(ApplicationContext context, ApplicationArguments args) {
	List<Object> runners = new ArrayList<>();
	runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());
	runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());
	AnnotationAwareOrderComparator.sort(runners);
	for (Object runner : new LinkedHashSet<>(runners)) {
		if (runner instanceof ApplicationRunner) {
			callRunner((ApplicationRunner) runner, args);
		}
		if (runner instanceof CommandLineRunner) {
			callRunner((CommandLineRunner) runner, args);
		}
	}
}

執行全部 ApplicationRunner 和 CommandLineRunner 這兩種運行器，不詳細展開了。

1七、發佈應用上下文就緒事件

listeners.running(context);

觸發全部 SpringApplicationRunListener 監聽器的 running 事件方法。

1八、返回應用上下文

return context;

總結

Spring Boot 的啓動全過程源碼分析至此，分析 Spring 源碼真是一個痛苦的過程，但願能給你們提供一點參考和思路，也但願能給正在 Spring Boot 學習路上的朋友一點收穫。

源碼分析不易，點贊 + 轉發支持一下吧！

推薦：Spring Boot & Cloud 最強技術教程

掃描關注咱們的公衆號，乾貨天天更新。

image

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程