SpringBoot原始碼解析-啟動流程(一)

吾乃上將軍邢道榮發表於2019-03-14

前言: 讀過spring原始碼的讀者應該知道,spring原始碼有一個特點就是從頂層看,邏輯並不複雜。但是深入了看,spring為了實現一個邏輯會做大量的工作。想要一下子找到spring一個邏輯的源頭並不容易。

所以我建議在分析原始碼的時候會使用層層突進,重點突破的策略。千萬別 看到一個方法就鑽進去,這樣很容易迷失在程式碼中。


搭建專案應該不用多說了吧,使用idea 的spring initalizer功能,選擇web模組,一鍵就可以搭建好。自己寫一個簡單的controller,測試一下:

@RestController
public class Controller {

    @RequestMapping("/hello")
    public String hello(){
        return "hello";
    }

}
複製程式碼

開啟瀏覽器,輸入正確的地址。如果瀏覽器顯示hello那專案就搭建成功了。

開始分析程式碼

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

    public static ConfigurableApplicationContext run(Class<?> primarySource,
			String... args) {
		return run(new Class<?>[] { primarySource }, args);
	}
	
	public static ConfigurableApplicationContext run(Class<?>[] primarySources,
			String[] args) {
		return new SpringApplication(primarySources).run(args);
	}
複製程式碼

從springboot入口的run方法點進來,到了這兒。可以看到新建了一個SpringApplication物件,然後呼叫了該物件得到run方法。 所以我們一步一步來,這一節先分析新建的過程。

SpringApplication新建過程

	public SpringApplication(Class<?>... primarySources) {
		this(null, primarySources);
	}
	
        public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {
                //前三行程式碼校驗,設定引數,沒啥好說的
		this.resourceLoader = resourceLoader;
		Assert.notNull(primarySources, "PrimarySources must not be null");
		this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
		
		//判斷web容器的型別
		this.webApplicationType = WebApplicationType.deduceFromClasspath();
		
		//初始化ApplicationContextInitializer例項
		setInitializers((Collection) getSpringFactoriesInstances(
				ApplicationContextInitializer.class));
				
		//初始化ApplicationListener例項
		setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
		
		//判斷那個是入口類
		this.mainApplicationClass = deduceMainApplicationClass();
	}
複製程式碼

新建程式碼如上,primarySources引數就是我們一開始傳入的Application.class,resourceLoader為null。 前三行主要是校驗以及設定引數。第四行,判斷了web容器的型別,程式碼如下:

	static WebApplicationType deduceFromClasspath() {
		if (ClassUtils.isPresent(WEBFLUX_INDICATOR_CLASS, null)
				&& !ClassUtils.isPresent(WEBMVC_INDICATOR_CLASS, null)
				&& !ClassUtils.isPresent(JERSEY_INDICATOR_CLASS, null)) {
			return WebApplicationType.REACTIVE;
		}
		for (String className : SERVLET_INDICATOR_CLASSES) {
			if (!ClassUtils.isPresent(className, null)) {
				return WebApplicationType.NONE;
			}
		}
		return WebApplicationType.SERVLET;
	}
複製程式碼

主要看載入的包中,是否存在相應的類。我們主要用的是web模組,這個地方返回的是WebApplicationType.SERVLET。

下面開始了初始化applicationContextInitializer例項,程式碼如下:

	private <T> Collection<T> getSpringFactoriesInstances(Class<T> type) {
		return getSpringFactoriesInstances(type, new Class<?>[] {});
	}
	
	private <T> Collection<T> getSpringFactoriesInstances(Class<T> type,
			Class<?>[] parameterTypes, Object... args) {
		ClassLoader classLoader = getClassLoader();
		
		//關鍵地方,類名就是從這兒載入的
		Set<String> names = new LinkedHashSet<>(
				SpringFactoriesLoader.loadFactoryNames(type, classLoader));
				
		//例項化剛剛獲取的類
		List<T> instances = createSpringFactoriesInstances(type, parameterTypes,
				classLoader, args, names);
		//排序
		AnnotationAwareOrderComparator.sort(instances);
		return instances;
	}
	
	//點開loadFactoryNames方法,繼續開啟loadSpringFactories方法
	private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
        。。。

		try {
			Enumeration<URL> urls = (classLoader != null ?
					classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
					ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
			result = new LinkedMultiValueMap<>();
			while (urls.hasMoreElements()) {
				URL url = urls.nextElement();
				UrlResource resource = new UrlResource(url);
				Properties properties = PropertiesLoaderUtils.loadProperties(resource);
				for (Map.Entry<?, ?> entry : properties.entrySet()) {
					String factoryClassName = ((String) entry.getKey()).trim();
					for (String factoryName : StringUtils.commaDelimitedListToStringArray((String) entry.getValue())) {
						result.add(factoryClassName, factoryName.trim());
					}
				}
			}
			cache.put(classLoader, result);
			return result;
		}
        。。。
	}
複製程式碼

可以看到在loadSpringFactories方法中載入了"META-INF/spring.factories"檔案的資訊,並將其存入了map裡。然後在loadFactoryNames中依據類名獲取了相應的集合。那麼根據剛剛傳進來的類名ApplicationContextInitializer,我們去瞧一瞧配置檔案裡配了啥。開啟springboot的jar包,找到spring.factories檔案,發現裡面配置如下。

# Application Context Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.context.ConfigurationWarningsApplicationContextInitializer,\
org.springframework.boot.context.ContextIdApplicationContextInitializer,\
org.springframework.boot.context.config.DelegatingApplicationContextInitializer,\
org.springframework.boot.web.context.ServerPortInfoApplicationContextInitializer

# Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener
複製程式碼

到這兒我們就發現了,原來setInitializers方法,就是找的這幾個類。

繼續往下看初始化ApplicationListener例項的方法,這個方法的邏輯和上面初始化ApplicationContextInitializer一模一樣,所以就不詳解了。只需要知道springboot到那個地方,找到了那幾個類就可以。幾個ApplicationListener類名如下:

# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.ClearCachesApplicationListener,\
org.springframework.boot.builder.ParentContextCloserApplicationListener,\
org.springframework.boot.context.FileEncodingApplicationListener,\
org.springframework.boot.context.config.AnsiOutputApplicationListener,\
org.springframework.boot.context.config.ConfigFileApplicationListener,\
org.springframework.boot.context.config.DelegatingApplicationListener,\
org.springframework.boot.context.logging.ClasspathLoggingApplicationListener,\
org.springframework.boot.context.logging.LoggingApplicationListener,\
org.springframework.boot.liquibase.LiquibaseServiceLocatorApplicationListener
複製程式碼

最後還有一行程式碼

this.mainApplicationClass = deduceMainApplicationClass();
複製程式碼

這行程式碼邏輯就是獲取方法的呼叫棧,然後找到main方法的那個類。顯然,這邊的mainApplicationClass就算我們入口的那個Application類。

到這兒,SpringApplication新建過程就結束了。總結一下,在SpringApplication新建過程中,程式主要還是以設定屬性為主。這些屬性現在我們只需要知道他們是啥就行,後面再針對功能進行分析。


返回目錄

相關文章