springboot之啓動原理解析及源碼閱讀

時間 2019-11-17

原文原文鏈接

前言

SpringBoot爲咱們作的自動配置，確實方便快捷，可是對於新手來講，若是不大懂SpringBoot內部啓動原理，之後不免會吃虧。因此此次博主就跟大家一塊兒一步步揭開SpringBoot的神祕面紗，讓它不在神祕。java

正文

咱們開發任何一個Spring Boot項目，都會用到以下的啓動類web

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

從上面代碼能夠看出，Annotation定義（@SpringBootApplication）和類定義（SpringApplication.run）最爲耀眼，因此要揭開SpringBoot的神祕面紗，咱們要從這兩位開始就能夠了。spring

SpringBootApplication背後的祕密

@Target(ElementType.TYPE)            // 註解的適用範圍，其中TYPE用於描述類、接口（包括包註解類型）或enum聲明
@Retention(RetentionPolicy.RUNTIME)  // 註解的生命週期，保留到class文件中（三個生命週期）
@Documented                          // 代表這個註解應該被javadoc記錄
@Inherited                           // 子類能夠繼承該註解
@SpringBootConfiguration // 繼承了Configuration，表示當前是註解類
@EnableAutoConfiguration // 開啓springboot的註解功能，springboot的四大神器之一，其藉助@import的幫助
@ComponentScan(excludeFilters = {    // 掃描路徑設置（具體使用待確認）
        @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
...
}

雖然定義使用了多個Annotation進行了原信息標註，但實際上重要的只有三個Annotation：sql

@Configuration（@SpringBootConfiguration點開查看發現裏面仍是應用了@Configuration）
@EnableAutoConfiguration
@ComponentScan

因此，若是咱們使用以下的SpringBoot啓動類，整個SpringBoot應用依然能夠與以前的啓動類功能對等：springboot

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

每次寫這3個比較累，因此寫一個@SpringBootApplication方便點。接下來分別介紹這3個Annotation。app

@Configuration

這裏的@Configuration對咱們來講不陌生，它就是JavaConfig形式的Spring Ioc容器的配置類使用的那個@Configuration，SpringBoot社區推薦使用基於JavaConfig的配置形式，因此，這裏的啓動類標註了@Configuration以後，自己其實也是一個IoC容器的配置類。
舉幾個簡單例子回顧下，XML跟config配置方式的區別：框架

表達形式層面
基於XML配置的方式是這樣：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"
       default-lazy-init="true">
    <!--bean定義-->
</beans>

而基於JavaConfig的配置方式是這樣：less

@Configuration
public class MockConfiguration{
    //bean定義
}

任何一個標註了@Configuration的Java類定義都是一個JavaConfig配置類。ide

註冊bean定義層面
基於XML的配置形式是這樣：

<bean id="mockService" class="..MockServiceImpl">
    ...
</bean>

而基於JavaConfig的配置形式是這樣的：工具

@Configuration
public class MockConfiguration{
    @Bean
    public MockService mockService(){
        return new MockServiceImpl();
    }
}

任何一個標註了@Bean的方法，其返回值將做爲一個bean定義註冊到Spring的IoC容器，方法名將默認成該bean定義的id。

表達依賴注入關係層面
爲了表達bean與bean之間的依賴關係，在XML形式中通常是這樣：

<bean id="mockService" class="..MockServiceImpl">
    <propery name ="dependencyService" ref="dependencyService" />
</bean>

<bean id="dependencyService" class="DependencyServiceImpl"></bean>

而基於JavaConfig的配置形式是這樣的：

@Configuration
public class MockConfiguration{
    @Bean
    public MockService mockService(){
        return new MockServiceImpl(dependencyService());
    }
    
    @Bean
    public DependencyService dependencyService(){
        return new DependencyServiceImpl();
    }
}

若是一個bean的定義依賴其餘bean,則直接調用對應的JavaConfig類中依賴bean的建立方法就能夠了。

@ComponentScan

@ComponentScan這個註解在Spring中很重要，它對應XML配置中的元素，@ComponentScan的功能其實就是自動掃描並加載符合條件的組件（好比@Component和@Repository等）或者bean定義，最終將這些bean定義加載到IoC容器中。

咱們能夠經過basePackages等屬性來細粒度的定製@ComponentScan自動掃描的範圍，若是不指定，則默認Spring框架實現會從聲明@ComponentScan所在類的package進行掃描。

注：因此SpringBoot的啓動類最好是放在root package下，由於默認不指定basePackages。

@EnableAutoConfiguration

我的感受@EnableAutoConfiguration這個Annotation最爲重要，因此放在最後來解讀，你們是否還記得Spring框架提供的各類名字爲@Enable開頭的Annotation定義？好比@EnableScheduling、@EnableCaching、@EnableMBeanExport等，@EnableAutoConfiguration的理念和作事方式其實一脈相承，簡單歸納一下就是，藉助@Import的支持，收集和註冊特定場景相關的bean定義。

@EnableScheduling是經過@Import將Spring調度框架相關的bean定義都加載到IoC容器。
@EnableMBeanExport是經過@Import將JMX相關的bean定義加載到IoC容器。

而@EnableAutoConfiguration也是藉助@Import的幫助，將全部符合自動配置條件的bean定義加載到IoC容器，僅此而已！

@EnableAutoConfiguration做爲一個複合Annotation,其自身定義關鍵信息以下：

@SuppressWarnings("deprecation")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    ...
}

兩個比較重要的註解：

@AutoConfigurationPackage：自動配置包
@Import: 導入自動配置的組件

AutoConfigurationPackage註解：

1     static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
2 
3         @Override
4         public void registerBeanDefinitions(AnnotationMetadata metadata,
5                 BeanDefinitionRegistry registry) {
6             register(registry, new PackageImport(metadata).getPackageName());
7         }

它實際上是註冊了一個Bean的定義。

new PackageImport(metadata).getPackageName()，它其實返回了當前主程序類的 同級以及子級 的包組件。

以上圖爲例，DemoApplication是和demo包同級，可是demo2這個類是DemoApplication的父級，和example包同級

也就是說，DemoApplication啓動加載的Bean中，並不會加載demo2，這也就是爲何，咱們要把DemoApplication放在項目的最高級中。

Import(AutoConfigurationImportSelector.class)註解：

能夠從圖中看出 AutoConfigurationImportSelector 繼承了 DeferredImportSelector 繼承了 ImportSelector

ImportSelector有一個方法爲：selectImports。

@Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        if (!isEnabled(annotationMetadata)) {
            return NO_IMPORTS;
        }
        AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
                .loadMetadata(this.beanClassLoader);
        AnnotationAttributes attributes = getAttributes(annotationMetadata);
        List<String> configurations = getCandidateConfigurations(annotationMetadata,
                attributes);
        configurations = removeDuplicates(configurations);
        Set<String> exclusions = getExclusions(annotationMetadata, attributes);
        checkExcludedClasses(configurations, exclusions);
        configurations.removeAll(exclusions);
        configurations = filter(configurations, autoConfigurationMetadata);
        fireAutoConfigurationImportEvents(configurations, exclusions);
        return StringUtils.toStringArray(configurations);
    }

能夠看到第九行，它實際上是去加載 public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";外部文件。這個外部文件，有不少自動配置的類。以下：

其中，最關鍵的要屬@Import(EnableAutoConfigurationImportSelector.class)，藉助EnableAutoConfigurationImportSelector，@EnableAutoConfiguration能夠幫助SpringBoot應用將全部符合條件的@Configuration配置都加載到當前SpringBoot建立並使用的IoC容器。就像一隻「八爪魚」同樣。

自動配置幕後英雄：SpringFactoriesLoader詳解

藉助於Spring框架原有的一個工具類：SpringFactoriesLoader的支持，@EnableAutoConfiguration能夠智能的自動配置功效才得以大功告成！

SpringFactoriesLoader屬於Spring框架私有的一種擴展方案，其主要功能就是從指定的配置文件META-INF/spring.factories加載配置。

public abstract class SpringFactoriesLoader {
    //...
    public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader) {
        ...
    }


    public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
        ....
    }
}

配合@EnableAutoConfiguration使用的話，它更可能是提供一種配置查找的功能支持，即根據@EnableAutoConfiguration的完整類名org.springframework.boot.autoconfigure.EnableAutoConfiguration做爲查找的Key,獲取對應的一組@Configuration類

上圖就是從SpringBoot的autoconfigure依賴包中的META-INF/spring.factories配置文件中摘錄的一段內容，能夠很好地說明問題。

因此，@EnableAutoConfiguration自動配置的魔法騎士就變成了：從classpath中搜尋全部的META-INF/spring.factories配置文件，並將其中org.springframework.boot.autoconfigure.EnableutoConfiguration對應的配置項經過反射（Java Refletion）實例化爲對應的標註了@Configuration的JavaConfig形式的IoC容器配置類，而後彙總爲一個並加載到IoC容器。

SpringBoot的啓動原理基本算是講完了，爲了方便記憶，我根據上面的分析畫了張圖

深刻探索SpringApplication執行流程

SpringApplication的run方法的實現是咱們本次旅程的主要線路，該方法的主要流程大致能夠概括以下：

1）若是咱們使用的是SpringApplication的靜態run方法，那麼，這個方法裏面首先要建立一個SpringApplication對象實例，而後調用這個建立好的SpringApplication的實例方法。在SpringApplication實例初始化的時候，它會提早作幾件事情：

public static ConfigurableApplicationContext run(Object[] sources, String[] args) {
        return new SpringApplication(sources).run(args);
    }

根據classpath裏面是否存在某個特徵類（org.springframework.web.context.ConfigurableWebApplicationContext）來決定是否應該建立一個爲Web應用使用的ApplicationContext類型。
使用SpringFactoriesLoader在應用的classpath中查找並加載全部可用的ApplicationContextInitializer。
使用SpringFactoriesLoader在應用的classpath中查找並加載全部可用的ApplicationListener。
推斷並設置main方法的定義類。

@SuppressWarnings({ "unchecked", "rawtypes" })
    private void initialize(Object[] sources) {
        if (sources != null && sources.length > 0) {
            this.sources.addAll(Arrays.asList(sources));
        }
        this.webEnvironment = deduceWebEnvironment();
        setInitializers((Collection) getSpringFactoriesInstances(
                ApplicationContextInitializer.class));
        setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
        this.mainApplicationClass = deduceMainApplicationClass();
    }

2） SpringApplication實例初始化完成而且完成設置後，就開始執行run方法的邏輯了，方法執行伊始，首先遍歷執行全部經過SpringFactoriesLoader能夠查找到並加載的SpringApplicationRunListener。調用它們的started()方法，告訴這些SpringApplicationRunListener，「嘿，SpringBoot應用要開始執行咯！」。

public ConfigurableApplicationContext run(String... args) {
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        ConfigurableApplicationContext context = null;
        FailureAnalyzers analyzers = null;
        configureHeadlessProperty();
        SpringApplicationRunListeners listeners = getRunListeners(args);
        listeners.starting();
        try {
            ApplicationArguments applicationArguments = new DefaultApplicationArguments(
                    args);
            ConfigurableEnvironment environment = prepareEnvironment(listeners,
                    applicationArguments);
            Banner printedBanner = printBanner(environment);
            context = createApplicationContext();
            analyzers = new FailureAnalyzers(context);
            prepareContext(context, environment, listeners, applicationArguments,
                    printedBanner);
　　　　　　　// 核心點：會打印springboot的啓動標誌，直到server.port端口啓動
            refreshContext(context);
            afterRefresh(context, applicationArguments);
            listeners.finished(context, null);
            stopWatch.stop();
            if (this.logStartupInfo) {
                new StartupInfoLogger(this.mainApplicationClass)
                        .logStarted(getApplicationLog(), stopWatch);
            }
            return context;
        }
        catch (Throwable ex) {
            handleRunFailure(context, listeners, analyzers, ex);
            throw new IllegalStateException(ex);
        }
    }

3）建立並配置當前Spring Boot應用將要使用的Environment（包括配置要使用的PropertySource以及Profile）。

private ConfigurableEnvironment prepareEnvironment(
            SpringApplicationRunListeners listeners,
            ApplicationArguments applicationArguments) {
        // Create and configure the environment
        ConfigurableEnvironment environment = getOrCreateEnvironment();
        configureEnvironment(environment, applicationArguments.getSourceArgs());
        listeners.environmentPrepared(environment);
        if (!this.webEnvironment) {
            environment = new EnvironmentConverter(getClassLoader())
                    .convertToStandardEnvironmentIfNecessary(environment);
        }
        return environment;
    }

4）遍歷調用全部SpringApplicationRunListener的environmentPrepared()的方法，告訴他們：「當前SpringBoot應用使用的Environment準備好了咯！」。

public void environmentPrepared(ConfigurableEnvironment environment) {
        for (SpringApplicationRunListener listener : this.listeners) {
            listener.environmentPrepared(environment);
        }
    }

5）若是SpringApplication的showBanner屬性被設置爲true，則打印banner。

private Banner printBanner(ConfigurableEnvironment environment) {
        if (this.bannerMode == Banner.Mode.OFF) {
            return null;
        }
        ResourceLoader resourceLoader = this.resourceLoader != null ? this.resourceLoader
                : new DefaultResourceLoader(getClassLoader());
        SpringApplicationBannerPrinter bannerPrinter = new SpringApplicationBannerPrinter(
                resourceLoader, this.banner);
        if (this.bannerMode == Mode.LOG) {
            return bannerPrinter.print(environment, this.mainApplicationClass, logger);
        }
        return bannerPrinter.print(environment, this.mainApplicationClass, System.out);
    }

6）根據用戶是否明確設置了applicationContextClass類型以及初始化階段的推斷結果，決定該爲當前SpringBoot應用建立什麼類型的ApplicationContext並建立完成，而後根據條件決定是否添加ShutdownHook，決定是否使用自定義的BeanNameGenerator，決定是否使用自定義的ResourceLoader，固然，最重要的，將以前準備好的Environment設置給建立好的ApplicationContext使用。

7） ApplicationContext建立好以後，SpringApplication會再次藉助Spring-FactoriesLoader，查找並加載classpath中全部可用的ApplicationContext-Initializer，而後遍歷調用這些ApplicationContextInitializer的initialize（applicationContext）方法來對已經建立好的ApplicationContext進行進一步的處理。

@SuppressWarnings({ "rawtypes", "unchecked" })
    protected void applyInitializers(ConfigurableApplicationContext context) {
        for (ApplicationContextInitializer initializer : getInitializers()) {
            Class<?> requiredType = GenericTypeResolver.resolveTypeArgument(
                    initializer.getClass(), ApplicationContextInitializer.class);
            Assert.isInstanceOf(requiredType, context, "Unable to call initializer.");
            initializer.initialize(context);
        }
    }

8）遍歷調用全部SpringApplicationRunListener的contextPrepared()方法。

private void prepareContext(ConfigurableApplicationContext context,
            ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
            ApplicationArguments applicationArguments, Banner printedBanner) {
        context.setEnvironment(environment);
        postProcessApplicationContext(context);
        applyInitializers(context);
        listeners.contextPrepared(context);
        if (this.logStartupInfo) {
            logStartupInfo(context.getParent() == null);
            logStartupProfileInfo(context);
        }

        // Add boot specific singleton beans
        context.getBeanFactory().registerSingleton("springApplicationArguments",
                applicationArguments);
        if (printedBanner != null) {
            context.getBeanFactory().registerSingleton("springBootBanner", printedBanner);
        }

        // Load the sources
        Set<Object> sources = getSources();
        Assert.notEmpty(sources, "Sources must not be empty");
        load(context, sources.toArray(new Object[sources.size()]));
        listeners.contextLoaded(context);
    }

9）最核心的一步，將以前經過@EnableAutoConfiguration獲取的全部配置以及其餘形式的IoC容器配置加載到已經準備完畢的ApplicationContext。

private void prepareAnalyzer(ConfigurableApplicationContext context,
            FailureAnalyzer analyzer) {
        if (analyzer instanceof BeanFactoryAware) {
            ((BeanFactoryAware) analyzer).setBeanFactory(context.getBeanFactory());
        }
    }

10）遍歷調用全部SpringApplicationRunListener的contextLoaded()方法。

public void contextLoaded(ConfigurableApplicationContext context) {
        for (SpringApplicationRunListener listener : this.listeners) {
            listener.contextLoaded(context);
        }
    }

11）調用ApplicationContext的refresh()方法，完成IoC容器可用的最後一道工序。

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

12）查找當前ApplicationContext中是否註冊有CommandLineRunner，若是有，則遍歷執行它們。

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

13）正常狀況下，遍歷執行SpringApplicationRunListener的finished()方法、（若是整個過程出現異常，則依然調用全部SpringApplicationRunListener的finished()方法，只不過這種狀況下會將異常信息一併傳入處理）
去除事件通知點後，整個流程以下：

public void finished(ConfigurableApplicationContext context, Throwable exception) {
        for (SpringApplicationRunListener listener : this.listeners) {
            callFinishedListener(listener, context, exception);
        }
    }