SpringBoot核心源码-run方法

一、AutoConfigurationImportSelector

1.问题分析

我们之前在分析SpringBoot自动装配源码的时候讲过在 @EnableAutoConfiguration注解上通过 @Import注解导入了一个 ImportSelector接口的实现类 AutoConfigurationImportSelector。按照之前对 @Import 注解的理解，应该会执行重写的 selectImports 方法，但调试的时候，执行的流程好像和我们期待的不一样哦，没有走 selectImports方法。

通过Debug模式，端点定位我们能够发现进入到了getAutoConfigurationEntry方法中。

imagepng

但是没有进入selectImports方法。

imagepng

这是什么原因呢？他不是实现了ImportSelector接口吗？怎么和我们之前理解的不一样呢？这就需要我们再来细说下@Import注解了。

2.@Import

我们前面介绍过@Import注解可以根据添加的不同类型做出不同的操作

导入类型	注入方式
实现了ImportSelector接口	不注入该类型的对象，调用selectImports方法，将返回的数据注入到容器中
实现了ImportBeanDefinitionRegistrar接口	不注入该类型的对象，调用registerBeanDefinitions方法，通过注册器注入
普通类型	直接注入该类型的对象

而在自动装配中导入的AutoConfigurationImportSelector这个类型有点特殊。具体看下类图结构

imagepng

那这个DeferredImportSelector这个接口的作用是什么呢？字面含义是延迟导入的意思。具体怎么实现的后面再说，我们先来说下他的作用。

3.DeferredImportSelector接口

DeferredImportSelector接口本身也有ImportSelector接口的功能，如果我们仅仅是实现了DeferredImportSelector接口，重写了selectImports方法，那么selectImports方法还是会被执行的，来看代码。

public class MyDeferredImportSelector implements DeferredImportSelector {

    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        System.out.println("selectImports方法执行了---->");
        return new String[0];
    }


}
对应的配置启动类

@Configuration
@Import(MyDeferredImportSelector.class)
public class JavaConfig {

    public static void main(String[] args) {
        ApplicationContext ac = new AnnotationConfigApplicationContext(JavaConfig.class);
    }
}

启动效果：

imagepng

但是如果我们重写了DeferredImportSelector中的Group接口，并重写了getImportGroup，那么容器在启动的时候就不会执行selectImports方法了，而是执行getImportGroup方法。进而执行Group中重写的方法。

public class MyDeferredImportSelector implements DeferredImportSelector {

    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        System.out.println("selectImports方法执行了---->");
        return new String[0];
    }

    @Override
    public Class<? extends Group> getImportGroup() {
        System.out.println("getImportGroup");
        return MyDeferredImportSelectorGroup.class;
    }

    public static class MyDeferredImportSelectorGroup implements Group{
        private final List<Entry> imports = new ArrayList<>();
        @Override
        public void process(AnnotationMetadata metadata, DeferredImportSelector selector) {
            System.out.println("MyDeferredImportSelectorGroup.Group");
        }

        @Override
        public Iterable<Entry> selectImports() {
            System.out.println("Group中的：selectImports方法");
            return imports;
        }
    }
}

执行效果：

imagepng

通过上面的效果解释了为什么在SpringBoot自动装配的时候没有走selectImports方法。那么DeferredImportSelector接口的作用是什么呢？为什么要这么设计呢？我们接下来继续分析

4.DeferredImportSelector的作用

通过前面的类图结构我们知道DeferredImportSelector是ImportSelector接口的一个扩展。

imagepng

ImportSelector实例的selectImports方法的执行时机，是在@Configguration注解中的其他逻辑被处理之前，所谓的其他逻辑，包括对@ImportResource、@Bean这些注解的处理（注意，这里只是对@Bean修饰的方法的处理，并不是立即调用@Bean修饰的方法，这个区别很重要！)

DeferredImportSelector实例的selectImports方法的执行时机，是在@Configguration注解中的其他逻辑被处理完毕之后，所谓的其他逻辑，包括对@ImportResource、@Bean这些注解的处理.

上面的结论我们可以直接在源码中看到对应的答案。首先定位到ConfigurationClassParser中的parse方法。

imagepng

上面代码有两个非常重要的分支，我们在下面逐一的介绍

4.1 parse方法

我们先看parse方法，也就是解析注解类的方法。进入

imagepng

看到调用的是processConfigurationClass，翻译过来就比较好理解了，处理配置类

imagepng

再进入到循环的方法中。

imagepng

继续往下看

imagepng

逻辑处理还是非常清楚的。然后我们需要回到上面的处理@Import注解的方法中。在这个方法中我们可以看到@Import注解的实现逻辑

imagepng

也就是前面给大家回顾的@Import注解的作用

imagepng

然后来看下导入的类型是ImportSelector接口的逻辑。

imagepng

上面的代码重点解决了ImportSelector接口的不同类型的实现。

imagepng

对应的实例存储了起来

imagepng

4.2 process方法

好了上面的代码分析清楚了，然后我们再回到process方法中来看下DeferredImportSelectorHandler是如何处理的。

imagepng

进入process方法

imagepng

先看register方法

imagepng

然后再看processGroupImports方法。

imagepng

进去后我们需要进入getImports方法中。

imagepng

然后我们进入到process方法中，可以看到自动装配的方法被执行了！

imagepng

到这儿是不是帮助大家解决了自动装配为什么没有走 AutoConfigurationImportSelector中的 selectImports 方法了!!!

同时也介绍清楚了ImportSelector与DeferredImportSelector的区别，就是selectImports方法执行时机有差别，这个差别期间，spring容器对此Configguration类做了些其他的逻辑：包括对@ImportResource、@Bean这些注解的处理

二、SpringBoot源码环境

对于想要研究SpringBoot源码的小伙伴来说，在本地编译源码环境，然后在研究源码的时候可以添加对应的注释是必须的，本文就给大家来介绍下如何来搭建我们的源码环境。

1.官方源码下载

首先大家要注意SpringBoot项目在2.3.0之前是使用Maven构建项目的，在2.3.0之后是使用Gradle构建项目的。后面分析的源码以SpringBoot2.2.5为案例，所以本文就介绍下SpringBoot2.2.5的编译过程。

官网地址：https://github.com/spring-projects/spring-boot

imagepng

直接下载对于的压缩文件即可

imagepng

下载后直接解压缩即可

2.本地源码编译

把解压缩的源码直接导入到IDEA中，修改pom文件中的版本号。

imagepng

pom文件中提示 disable.checks属性找不到，我们添加一个即可。

  <properties>
        <revision>2.2.5.snapshot</revision>
        <main.basedir>${basedir}</main.basedir>
        <!-- 添加属性 -->
        <disable.checks>true</disable.checks>
    </properties>

然后执行编译命令

mvn clean install -DskipTests

imagepng

然后控制台出现如下错误

imagepng

按照提示，执行下面的命令就好了：

imagepng

在执行编译命令就可以了

mvn clean install -DskipTests

imagepng

3.源码环境使用

既然源码已经编译好之后我们就可以在这个项目中来创建我们自己的SpringBoot项目了，我们在 spring-boot-project项目下创建 module,

imagepng

然后在我们的module中添加对应的start依赖

imagepng

然后添加我们的启动类

imagepng

项目能够正常启动

imagepng

同时点击run方法进去，我们可以添加注释了：

imagepng

在其他项目使用我们编译的源码，这个可能是大家比较感兴趣的一个点了，我们也来介绍下，依赖我们还是可以使用官方的依赖即可，不过最好还是和我们编译的版本保持一致。

主要是关联上我们编译的源码。

imagepng

修改代码

imagepng

好了到此我们就可以开启SpringBoot的源码探索之旅了哦。

三、SpringBoot源码主线分析

我们要分析一个框架的源码不可能通过一篇文章就搞定的，本文我们就来分析下SpringBoot源码中的主线流程。先掌握SpringBoot项目启动的核心操作，然后我们再深入每一个具体的实现细节，注：本系列源码都以SpringBoot2.2.5.RELEASE版本来讲解

1.SpringBoot启动的入口

当我们启动一个SpringBoot项目的时候，入口程序就是main方法，而在main方法中就执行了一个run方法。

@SpringBootApplication
public class StartApp {

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

2.run方法

然后我们进入run()方法中看。代码比较简单

  public static ConfigurableApplicationContext run(Class<?> primarySource, String... args) {
        // 调用重载的run方法，将传递的Class对象封装为了一个数组
        return run(new Class<?>[] { primarySource }, args);
    }
  调用了重载的一个run()方法，将我们传递进来的类对象封装为了一个数组，仅此而已。我们再进入run()方法。

    public static ConfigurableApplicationContext run(Class<?>[] primarySources, String[] args) {
        // 创建了一个SpringApplication对象，并调用其run方法
        // 1.先看下构造方法中的逻辑
        // 2.然后再看run方法的逻辑
        return new SpringApplication(primarySources).run(args);
    }

imagepng

在该方法中创建了一个SpringApplication对象。同时调用了SpringApplication对象的run方法。这里的逻辑有分支，先看下SpringApplication的构造方法中的逻辑

3.SpringApplication构造器

我们进入SpringApplication的构造方法，看的核心代码为

 public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {
        // 传递的resourceLoader为null
        this.resourceLoader = resourceLoader;
        Assert.notNull(primarySources, "PrimarySources must not be null");
        // 记录主方法的配置类名称
        this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
        // 记录当前项目的类型
        this.webApplicationType = WebApplicationType.deduceFromClasspath();
        // 加载配置在spring.factories文件中的ApplicationContextInitializer对应的类型并实例化
        // 并将加载的数据存储在了 initializers 成员变量中。
        setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
        // 初始化监听器 并将加载的监听器实例对象存储在了listeners成员变量中
        setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
        // 反推main方法所在的Class对象 并记录在了mainApplicationClass对象中
        this.mainApplicationClass = deduceMainApplicationClass();
    }

在本方法中完成了几个核心操作

推断当前项目的类型
加载配置在spring.factories文件中的ApplicationContextInitializer中的类型并实例化后存储在了initializers中。
和2的步骤差不多，完成监听器的初始化操作，并将实例化的监听器对象存储在了listeners成员变量中
通过StackTrace反推main方法所在的Class对象

上面的核心操作具体的实现细节我们在后面的详细文章会给大家剖析

4.run方法

接下来我们在回到SpringApplication.run()方法中。

public ConfigurableApplicationContext run(String... args) {
        // 创建一个任务执行观察器
        StopWatch stopWatch = new StopWatch();
        // 开始执行记录执行时间
        stopWatch.start();
        // 声明 ConfigurableApplicationContext 对象
        ConfigurableApplicationContext context = null;
        // 声明集合容器用来存储 SpringBootExceptionReporter 启动错误的回调接口
        Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
        // 设置了一个名为java.awt.headless的系统属性
        // 其实是想设置该应用程序,即使没有检测到显示器,也允许其启动.
        //对于服务器来说,是不需要显示器的,所以要这样设置.
        configureHeadlessProperty();
        // 获取 SpringApplicationRunListener 加载的是 EventPublishingRunListener
        // 获取启动时到监听器
        SpringApplicationRunListeners listeners = getRunListeners(args);
        // 触发启动事件
        listeners.starting();
        try {
            // 构造一个应用程序的参数持有类
            ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
            // 创建并配置环境
            ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments);
            // 配置需要忽略的BeanInfo信息
            configureIgnoreBeanInfo(environment);
            // 输出的Banner信息
            Banner printedBanner = printBanner(environment);
            // 创建应用上下文对象
            context = createApplicationContext();
            // 加载配置的启动异常处理器
            exceptionReporters = getSpringFactoriesInstances(SpringBootExceptionReporter.class,
                    new Class[] { ConfigurableApplicationContext.class }, context);
            // 刷新前操作
            prepareContext(context, environment, listeners, applicationArguments, printedBanner);
            // 刷新应用上下文 完成Spring容器的初始化
            refreshContext(context);
            // 刷新后操作
            afterRefresh(context, applicationArguments);
            // 结束记录启动时间
            stopWatch.stop();
            if (this.logStartupInfo) {
                new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), stopWatch);
            }
            // 事件广播 启动完成了
            listeners.started(context);
            callRunners(context, applicationArguments);
        }
        catch (Throwable ex) {
            // 事件广播启动出错了
            handleRunFailure(context, ex, exceptionReporters, listeners);
            throw new IllegalStateException(ex);
        }
        try {
            // 监听器运行中
            listeners.running(context);
        }
        catch (Throwable ex) {
            handleRunFailure(context, ex, exceptionReporters, null);
            throw new IllegalStateException(ex);
        }
        // 返回上下文对象--> Spring容器对象
        return context;
    }

在这个方法中完成了SpringBoot项目启动的很多核心的操作，我们来总结下上面的步骤

创建了一个任务执行的观察器，统计启动的时间
声明ConfigurableApplicationContext对象
声明集合容器来存储SpringBootExceptionReporter即启动错误的回调接口
设置java.awt.headless的系统属性
获取我们之间初始化的监听器(EventPublishingRunListener),并触发starting事件
创建ApplicationArguments这是一个应用程序的参数持有类
创建ConfigurableEnvironment这时一个配置环境的对象
配置需要忽略的BeanInfo信息
配置Banner信息对象
创建对象的上下文对象
加载配置的启动异常的回调异常处理器
刷新应用上下文，本质就是完成Spring容器的初始化操作
启动结束记录启动耗时
完成对应的事件广播
返回应用上下文对象。

到此SpringBoot项目的启动初始化的代码的主要流程就介绍完成了。细节部分后面详细讲解。

四、SpringApplication构造器

前面给大家介绍了SpringBoot启动的核心流程，本文开始给大家详细的来介绍SpringBoot启动中的具体实现的相关细节。 https://www.processon.com/view/link/61eab8f47d9c085d604e614d

SpringBoot2png

首先我们来看下在SpringApplication的构造方法中是如何帮我们完成这4个核心操作的。

imagepng

  @SuppressWarnings({ "unchecked", "rawtypes" })
    public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {
        // 传递的resourceLoader为null
        this.resourceLoader = resourceLoader;
        Assert.notNull(primarySources, "PrimarySources must not be null");
        // 记录主方法的配置类名称
        this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
        // 记录当前项目的类型
        this.webApplicationType = WebApplicationType.deduceFromClasspath();
        // 加载配置在spring.factories文件中的ApplicationContextInitializer对应的类型并实例化
        // 并将加载的数据存储在了 initializers 成员变量中。
        setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
        // 初始化监听器 并将加载的监听器实例对象存储在了listeners成员变量中
        setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
        // 反推main方法所在的Class对象 并记录在了mainApplicationClass对象中
        this.mainApplicationClass = deduceMainApplicationClass();
    }

1.webApplicationType

首先来看下webApplicationType是如何来推导出当前启动的项目的类型。通过代码可以看到是通过deduceFromClassPath()方法根据ClassPath来推导出来的。

this.webApplicationType = WebApplicationType.deduceFromClasspath();
  跟踪进去看代码

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

在看整体的实现逻辑之前，我们先分别看两个内容，第一就是在上面的代码中使用到了相关的静态变量。

imagepng

这些静态变量其实就是一些绑定的Java类的全类路径。第二个就是 ClassUtils.isPresent()方法，该方法的逻辑也非常简单，就是通过反射的方式获取对应的类型的Class对象，如果存在返回true，否则返回false

imagepng

所以到此推导的逻辑就非常清楚了

imagepng

2.setInitializers

然后我们再来看下如何实现加载初始化器的。

// 加载配置在spring.factories文件中的ApplicationContextInitializer对应的类型并实例化
        // 并将加载的数据存储在了 initializers 成员变量中。
        setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));

首先所有的初始化器都实现了 ApplicationContextInitializer接口,也就是根据这个类型来加载相关的实现类。

public interface ApplicationContextInitializer<C extends ConfigurableApplicationContext> {
    void initialize(C var1);
}

然后加载的关键方法是 getSpringFactoriesInstances()方法。该方法会加载 spring.factories文件中的key为 org.springframework.context.ApplicationContextInitializer 的值。

spring-boot项目下

# 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.rsocket.context.RSocketPortInfoApplicationContextInitializer,\
org.springframework.boot.web.context.ServerPortInfoApplicationContextInitializer

spring-boot-autoconfigure项目下

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

imagepng

具体的加载方法为 getSpringFacotiesInstance()方法，我们进入查看

 private <T> Collection<T> getSpringFactoriesInstances(Class<T> type, Class<?>[] parameterTypes, Object... args) {
        // 获取当前上下文类加载器
        ClassLoader classLoader = getClassLoader();
        // 获取到的扩展类名存入set集合中防止重复
        Set<String> names = new LinkedHashSet<>(SpringFactoriesLoader.loadFactoryNames(type, classLoader));
        // 创建扩展点实例
        List<T> instances = createSpringFactoriesInstances(type, parameterTypes, classLoader, args, names);
        AnnotationAwareOrderComparator.sort(instances);
        return instances;
    }

先进入 SpringFactoriesLoader.loadFactoryNames(type, classLoader)中具体查看加载文件的过程.

imagepng

然后我们来看下 loadSpringFactories方法

imagepng

通过Debug的方式查看会更清楚哦

imagepng

通过 loadSpringFactories 方法我们看到把 spring.factories文件中的所有信息都加载到了内存中了，但是我们现在只需要加载 ApplicationContextInitializer类型的数据。这时我们再通过 getOrDefault()方法来查看。

imagepng

进入方法中查看

imagepng

然后会根据反射获取对应的实例对象。

imagepng

好了到这其实我们就清楚了 getSpringFactoriesInstances方法的作用就是帮我们获取定义在 META-INF/spring.factories文件中的可以为 ApplicationContextInitializer 的值。并通过反射的方式获取实例对象。然后把实例的对象信息存储在了SpringApplication的 initializers属性中。

imagepng

3.setListeners

清楚了 setInitializers()方法的作用后，再看 setListeners()方法就非常简单了，都是调用了 getSpringFactoriesInstances方法，只是传入的类型不同。也就是要获取的 META-INF/spring.factories文件中定义的不同信息罢了。

imagepng

即加载定义在 META-INF/spring.factories文件中声明的所有的监听器，并将获取后的监听器存储在了 SpringApplication的 listeners属性中。

imagepng

默认加载的监听器为：

imagepng

4.mainApplicationClass

最后我们来看下 duduceMainApplicaitonClass()方法是如何反推导出main方法所在的Class对象的。通过源码我们可以看到是通过 StackTrace来实现的。

StackTrace:
我们在学习函数调用时，都知道每个函数都拥有自己的栈空间。
一个函数被调用时，就创建一个新的栈空间。那么通过函数的嵌套调用最后就形成了一个函数调用堆栈

StackTrace其实就是记录了程序方法执行的链路。通过Debug方式可以更直观的来呈现。

imagepng

那么相关的调用链路我们都可以获取到，剩下的就只需要获取每链路判断执行的方法名称是否是 main就可以了。

posted @ 2022-09-10 16:12 c++c鸟阅读(112) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

c++,c随笔

SpringBoot核心源码-run方法

一、AutoConfigurationImportSelector

1.问题分析

2.@Import

3.DeferredImportSelector接口

4.DeferredImportSelector的作用

4.1 parse方法

4.2 process方法

二、SpringBoot源码环境

1.官方源码下载

2.本地源码编译

3.源码环境使用

三、SpringBoot源码主线分析

1.SpringBoot启动的入口

2.run方法

3.SpringApplication构造器

4.run方法

四、SpringApplication构造器

1.webApplicationType

2.setInitializers

3.setListeners

4.mainApplicationClass

公告