Spring Boot 2.x 啟動(dòng)全過(guò)程源碼分析（上）入口類剖析

MobService 發(fā)布于2019-08-19 10:53 / 581人閱讀

摘要：設(shè)置應(yīng)用上線文初始化器的作用是什么源碼如下。來(lái)看下方法源碼，其實(shí)就是初始化一個(gè)應(yīng)用上下文初始化器實(shí)例的集合。設(shè)置監(jiān)聽(tīng)器和設(shè)置初始化器調(diào)用的方法是一樣的，只是傳入的類型不一樣，設(shè)置監(jiān)聽(tīng)器的接口類型為，對(duì)應(yīng)的文件配置內(nèi)容請(qǐng)見(jiàn)下方。

Spring Boot 的應(yīng)用教程我們已經(jīng)分享過(guò)很多了，今天來(lái)通過(guò)源碼來(lái)分析下它的啟動(dòng)過(guò)程，探究下 Spring Boot 為什么這么簡(jiǎn)便的奧秘。

本篇基于 Spring Boot 2.0.3 版本進(jìn)行分析，閱讀本文需要有一些 Java 和 Spring 框架基礎(chǔ)，如果還不知道 Spring Boot 是什么，建議先看下我們的 Spring Boot 教程。

Spring Boot 的入口類

@SpringBootApplication
public class SpringBootBestPracticeApplication {

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

做過(guò) Spring Boot 項(xiàng)目的都知道，上面是 Spring Boot 最簡(jiǎn)單通用的入口類。入口類的要求是最頂層包下面第一個(gè)含有 main 方法的類，使用注解 @SpringBootApplication 來(lái)啟用 Spring Boot 特性，使用 SpringApplication.run 方法來(lái)啟動(dòng) Spring Boot 項(xiàng)目。

來(lái)看一下這個(gè)類的 run 方法調(diào)用關(guān)系源碼：

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);
}

第一個(gè)參數(shù) primarySource：加載的主要資源類

第二個(gè)參數(shù) args：傳遞給應(yīng)用的應(yīng)用參數(shù)

先用主要資源類來(lái)實(shí)例化一個(gè) SpringApplication 對(duì)象，再調(diào)用這個(gè)對(duì)象的 run 方法，所以我們分兩步來(lái)分析這個(gè)啟動(dòng)源碼。

SpringApplication 的實(shí)例化過(guò)程

接著上面的 SpringApplication 構(gòu)造方法進(jìn)入以下源碼：

public SpringApplication(Class... primarySources) {
    this(null, primarySources);
}

public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) {
    // 1、資源初始化資源加載器為 null
    this.resourceLoader = resourceLoader;
    
    // 2、斷言主要加載資源類不能為 null，否則報(bào)錯(cuò)
    Assert.notNull(primarySources, "PrimarySources must not be null");
    
    // 3、初始化主要加載資源類集合并去重
    this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
    
    // 4、推斷當(dāng)前 WEB 應(yīng)用類型
    this.webApplicationType = deduceWebApplicationType();
    
    // 5、設(shè)置應(yīng)用上線文初始化器
    setInitializers((Collection) getSpringFactoriesInstances(
            ApplicationContextInitializer.class));        
            
    // 6、設(shè)置監(jiān)聽(tīng)器            
    setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
    
    // 7、推斷主入口應(yīng)用類
    this.mainApplicationClass = deduceMainApplicationClass();
}

可知這個(gè)構(gòu)造器類的初始化包括以下 7 個(gè)過(guò)程。

1、資源初始化資源加載器為 null

this.resourceLoader = resourceLoader;

2、斷言主要加載資源類不能為 null，否則報(bào)錯(cuò)

Assert.notNull(primarySources, "PrimarySources must not be null");

3、初始化主要加載資源類集合并去重

this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));

4、推斷當(dāng)前 WEB 應(yīng)用類型

this.webApplicationType = deduceWebApplicationType();

來(lái)看下 deduceWebApplicationType 方法和相關(guān)的源碼：

private WebApplicationType deduceWebApplicationType() {
    if (ClassUtils.isPresent(REACTIVE_WEB_ENVIRONMENT_CLASS, null)
            && !ClassUtils.isPresent(MVC_WEB_ENVIRONMENT_CLASS, null)) {
        return WebApplicationType.REACTIVE;
    }
    for (String className : WEB_ENVIRONMENT_CLASSES) {
        if (!ClassUtils.isPresent(className, null)) {
            return WebApplicationType.NONE;
        }
    }
    return WebApplicationType.SERVLET;
}

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[] WEB_ENVIRONMENT_CLASSES = { "javax.servlet.Servlet",
            "org.springframework.web.context.ConfigurableWebApplicationContext" };        

public enum WebApplicationType {

    /**
     * 非 WEB 項(xiàng)目
     */
    NONE,

    /**
     * SERVLET WEB 項(xiàng)目
     */
    SERVLET,

    /**
     * 響應(yīng)式 WEB 項(xiàng)目
     */
    REACTIVE

}

這個(gè)就是根據(jù)類路徑下是否有對(duì)應(yīng)項(xiàng)目類型的類推斷出不同的應(yīng)用類型。

5、設(shè)置應(yīng)用上線文初始化器

setInitializers((Collection) getSpringFactoriesInstances(
            ApplicationContextInitializer.class));

ApplicationContextInitializer 的作用是什么？源碼如下。

public interface ApplicationContextInitializer {

    /**
     * Initialize the given application context.
     * @param applicationContext the application to configure
     */
    void initialize(C applicationContext);

}

用來(lái)初始化指定的 Spring 應(yīng)用上下文，如注冊(cè)屬性資源、激活 Profiles 等。

來(lái)看下 setInitializers 方法源碼，其實(shí)就是初始化一個(gè) ApplicationContextInitializer 應(yīng)用上下文初始化器實(shí)例的集合。

public void setInitializers(
        Collection> initializers) {
    this.initializers = new ArrayList<>();
    this.initializers.addAll(initializers);
}

再來(lái)看下這個(gè)初始化 getSpringFactoriesInstances 方法和相關(guān)的源碼：

private  Collection getSpringFactoriesInstances(Class type) {
    return getSpringFactoriesInstances(type, new Class[] {});
}

private  Collection getSpringFactoriesInstances(Class type,
        Class[] parameterTypes, Object... args) {
    ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
    // Use names and ensure unique to protect against duplicates
    Set names = new LinkedHashSet<>(
            SpringFactoriesLoader.loadFactoryNames(type, classLoader));
    List instances = createSpringFactoriesInstances(type, parameterTypes,
            classLoader, args, names);
    AnnotationAwareOrderComparator.sort(instances);
    return instances;
}

設(shè)置應(yīng)用上下文初始化器可分為以下 5 個(gè)步驟。

5.1）獲取當(dāng)前線程上下文類加載器

ClassLoader classLoader = Thread.currentThread().getContextClassLoader();

5.2）獲取 ApplicationContextInitializer 的實(shí)例名稱集合并去重

Set names = new LinkedHashSet<>(
                SpringFactoriesLoader.loadFactoryNames(type, classLoader));

loadFactoryNames 方法相關(guān)的源碼如下：

public static List loadFactoryNames(Class factoryClass, @Nullable ClassLoader classLoader) {
    String factoryClassName = factoryClass.getName();
    return loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
}

public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";

private static Map> loadSpringFactories(@Nullable ClassLoader classLoader) {
    MultiValueMap result = cache.get(classLoader);
    if (result != null) {
        return result;
    }

    try {
        Enumeration 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()) {
                List factoryClassNames = Arrays.asList(
                        StringUtils.commaDelimitedListToStringArray((String) entry.getValue()));
                result.addAll((String) entry.getKey(), factoryClassNames);
            }
        }
        cache.put(classLoader, result);
        return result;
    }
    catch (IOException ex) {
        throw new IllegalArgumentException("Unable to load factories from location [" +
                FACTORIES_RESOURCE_LOCATION + "]", ex);
    }
}

根據(jù)類路徑下的 META-INF/spring.factories 文件解析并獲取 ApplicationContextInitializer 接口的所有配置的類路徑名稱。

spring-boot-autoconfigure-2.0.3.RELEASE.jar!/META-INF/spring.factories 的初始化器相關(guān)配置內(nèi)容如下：

# Initializers
org.springframework.context.ApplicationContextInitializer=
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener

5.3）根據(jù)以上類路徑創(chuàng)建初始化器實(shí)例列表

List instances = createSpringFactoriesInstances(type, parameterTypes,
                classLoader, args, names);

private  List createSpringFactoriesInstances(Class type,
        Class[] parameterTypes, ClassLoader classLoader, Object[] args,
        Set names) {
    List instances = new ArrayList<>(names.size());
    for (String name : names) {
        try {
            Class instanceClass = ClassUtils.forName(name, classLoader);
            Assert.isAssignable(type, instanceClass);
            Constructor constructor = instanceClass
                    .getDeclaredConstructor(parameterTypes);
            T instance = (T) BeanUtils.instantiateClass(constructor, args);
            instances.add(instance);
        }
        catch (Throwable ex) {
            throw new IllegalArgumentException(
                    "Cannot instantiate " + type + " : " + name, ex);
        }
    }
    return instances;
}

5.4）初始化器實(shí)例列表排序

AnnotationAwareOrderComparator.sort(instances);

5.5）返回初始化器實(shí)例列表

return instances;

6、設(shè)置監(jiān)聽(tīng)器

setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));

ApplicationListener 的作用是什么？源碼如下。

@FunctionalInterface
public interface ApplicationListener extends EventListener {

    /**
     * Handle an application event.
     * @param event the event to respond to
     */
    void onApplicationEvent(E event);

}

看源碼，這個(gè)接口繼承了 JDK 的 java.util.EventListener 接口，實(shí)現(xiàn)了觀察者模式，它一般用來(lái)定義感興趣的事件類型，事件類型限定于 ApplicationEvent 的子類，這同樣繼承了 JDK 的 java.util.EventObject 接口。

設(shè)置監(jiān)聽(tīng)器和設(shè)置初始化器調(diào)用的方法是一樣的，只是傳入的類型不一樣，設(shè)置監(jiān)聽(tīng)器的接口類型為：getSpringFactoriesInstances，對(duì)應(yīng)的 spring-boot-autoconfigure-2.0.3.RELEASE.jar!/META-INF/spring.factories 文件配置內(nèi)容請(qǐng)見(jiàn)下方。

# Application Listeners
org.springframework.context.ApplicationListener=
org.springframework.boot.autoconfigure.BackgroundPreinitializer

可以看出目前只有一個(gè) BackgroundPreinitializer 監(jiān)聽(tīng)器。

7、推斷主入口應(yīng)用類

this.mainApplicationClass = deduceMainApplicationClass();

private Class deduceMainApplicationClass() {
    try {
        StackTraceElement[] stackTrace = new RuntimeException().getStackTrace();
        for (StackTraceElement stackTraceElement : stackTrace) {
            if ("main".equals(stackTraceElement.getMethodName())) {
                return Class.forName(stackTraceElement.getClassName());
            }
        }
    }
    catch (ClassNotFoundException ex) {
        // Swallow and continue
    }
    return null;
}

這個(gè)推斷入口應(yīng)用類的方式有點(diǎn)特別，通過(guò)構(gòu)造一個(gè)運(yùn)行時(shí)異常，再遍歷異常棧中的方法名，獲取方法名為 main 的棧幀，從來(lái)得到入口類的名字再返回該類。

總結(jié)

源碼分析內(nèi)容有點(diǎn)多，也很麻煩，本章暫時(shí)分析到 SpringApplication 構(gòu)造方法的初始化流程，下章再繼續(xù)分析其 run 方法，作者很快寫完過(guò)兩天就發(fā)布，掃碼關(guān)注下面的公眾號(hào) "Java技術(shù)棧" 即可獲取推送更新。