返回介绍

SpringApplication 源码分析

发布于 2023-12-26 21:19:41 字数 55424 浏览 0 评论 0 收藏 0

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication // <1>
public class MVCApplication {

    public static void main(String[] args) {
        SpringApplication.run(MVCApplication.class, args); // <2>
    }

}
  • <1> 处,使用 @SpringBootApplication 注解,标明是 Spring Boot 应用。通过它,可以开启自动配置的功能。
  • <2> 处,调用 SpringApplication#run(Class<?>... primarySources) 方法,启动 Spring Boot 应用。

上述的代码,是我们使用 Spring Boot 时,最最最常用的代码。而本文,我们先来分析 Spring Boot 应用的启动过程

二. SpringApplication

org.springframework.boot.SpringApplication ,Spring 应用启动器。正如其代码上所添加的注释,它来提供启动 Spring 应用的功能。

Class that can be used to bootstrap and launch a Spring application from a Java main method.

大多数情况下,我们都是使用它提供的静态方法:

// SpringApplication.java

public static void main(String[] args) throws Exception {
    SpringApplication.run(new Class<?>[0], args);
}

public static ConfigurableApplicationContext run(Class<?> primarySource, String... args) {
    return run(new Class<?>[] { primarySource }, args);
}

public static ConfigurableApplicationContext run(Class<?>[] primarySources, String[] args) {
    // 创建 SpringApplication 对象,并执行运行。
    return new SpringApplication(primarySources).run(args);
}
  • 前两个静态方法,最终调用的是第 3 个静态方法。而第 3 个静态方法,实现的逻辑就是:
    • 首先,创建一个 SpringApplication 对象。详细的解析,见 「2.1 构造方法」
    • 然后,调用 SpringApplication#run(Class<?> primarySource, String... args) 方法,运行 Spring 应用。详细解析,见 「2.2 run」

2.1 构造方法

// SpringApplication.java

/**
 * 资源加载器
 */
private ResourceLoader resourceLoader;
/**
 * 主要的 Java Config 类的数组
 */
private Set<Class<?>> primarySources;
/**
 * Web 应用类型
 */
private WebApplicationType webApplicationType;

/**
 * ApplicationContextInitializer 数组
 */
private List<ApplicationContextInitializer<?>> initializers;
/**
 * ApplicationListener 数组
 */
private List<ApplicationListener<?>> listeners;

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));
    this.webApplicationType = WebApplicationType.deduceFromClasspath();
    // 加载classpath环境中配置的ApplicationContextInitializer实现类
    setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
    // 通过SPI机制,加载classpath环境中配置的ApplicationListener实现类,并实例化
    setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
    this.mainApplicationClass = deduceMainApplicationClass();
}
  • SpringApplication 的变量比较多,我们先只看构造方法提到的几个。
  • resourceLoader 属性,资源加载器。可以暂时不理解,感兴趣的胖友,可以看看 《【死磕 Spring】—— IoC 之 Spring 统一资源加载策略》 文章。
  • primarySources 属性,主要的 Java Config 类的数组。在文初提供的示例,就是 MVCApplication 类。

  • webApplicationType 属性,调用 WebApplicationType#deduceFromClasspath() 方法,通过 classpath ,判断 Web 应用类型。

    • 具体的原理是,是否存在指定的类,艿艿已经在 WebApplicationType 上的方法添加了注释,直接瞅一眼就明白了。
    • 这个属性,在下面的 #createApplicationContext() 方法,将根据它的值(类型),创建不同类型的 ApplicationContext 对象,即 Spring 容器的类型不同。
  • initializers 属性,ApplicationContextInitializer 数组。

    • 通过 #getSpringFactoriesInstances(Class<T> type) 方法,进行获得 ApplicationContextInitializer 类型的对象数组,详细的解析,见 「2.1.1 getSpringFactoriesInstances」 方法。
    • 假设只在 Spring MVC 的环境下,initializers 属性的结果如下图:

  • listeners 属性,ApplicationListener 数组。

    • 也是通过 #getSpringFactoriesInstances(Class<T> type) 方法,进行获得 ApplicationListener 类型的对象数组。
    • 假设只在 Spring MVC 的环境下,listeners 属性的结果如下图:

  • mainApplicationClass 属性,调用 #deduceMainApplicationClass() 方法,获得是调用了哪个 #main(String[] args) 方法,代码如下:

    // SpringApplication.java
    
    private Class<?> deduceMainApplicationClass() {
        try {
            // 获得当前 StackTraceElement 数组
            StackTraceElement[] stackTrace = new RuntimeException().getStackTrace();
            // 判断哪个执行了 main 方法
            for (StackTraceElement stackTraceElement : stackTrace) {
                if ("main".equals(stackTraceElement.getMethodName())) {
                    return Class.forName(stackTraceElement.getClassName());
                }
            }
        } catch (ClassNotFoundException ex) {
            // Swallow and continue
        }
        return null;
    }
    
  • 在文初的例子中,就是 MVCApplication 类。

  • 这个 mainApplicationClass 属性,没有什么逻辑上的用途,主要就是用来打印下日志,说明是通过这个类启动 Spring 应用的。

2.1.1 getSpringFactoriesInstances

#getSpringFactoriesInstances(Class<T> type) 方法,获得指定类类对应的对象们。代码如下:

// SpringApplication.java

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();
    // Use names and ensure unique to protect against duplicates
    // <1> 加载指定类型对应的,在 `META-INF/spring.factories` 里的类名的数组
    Set<String> names = new LinkedHashSet<>(
            SpringFactoriesLoader.loadFactoryNames(type, classLoader));
    // <2> 创建对象们
    List<T> instances = createSpringFactoriesInstances(type, parameterTypes,
            classLoader, args, names);
    // <3> 排序对象们
    AnnotationAwareOrderComparator.sort(instances);
    return instances;
}
  • <1> 处,调用 SpringFactoriesLoader#loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) 方法,加载指定类型对应的,在 META-INF/spring.factories 里的类名的数组。
    • META-INF/spring.factories 文件中,会以 KEY-VALUE 的格式,配置每个类对应的实现类们。
    • 关于 SpringFactoriesLoader 的该方法,我们就不去细看了。😈 很多时候,我们看源码的时候,不需要陷入到每个方法的细节中。非关键的方法,猜测到具体的用途后,跳过也是没问题的。
  • <2> 处,调用 #createSpringFactoriesInstances(Class<T> type, Class<?>[] parameterTypes, ClassLoader classLoader, Object[] args, Set<String> names) 方法,创建对象们。代码如下:
// SpringApplication.java

/**
 * 创建对象的数组
 *
 * @param type 父类
 * @param parameterTypes 构造方法的参数类型
 * @param classLoader 类加载器
 * @param args 参数
 * @param names 类名的数组
 * @param <T> 泛型
 * @return 对象的数组
 */
private <T> List<T> createSpringFactoriesInstances(Class<T> type,
        Class<?>[] parameterTypes, ClassLoader classLoader, Object[] args,
        Set<String> names) {
    List<T> instances = new ArrayList<>(names.size()); // 数组大小,细节~
    // 遍历 names 数组
    for (String name : names) {
        try {
            // 获得 name 对应的类
            Class<?> instanceClass = ClassUtils.forName(name, classLoader);
            // 判断类是否实现自 type 类
            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;
}
  • <3> 处,调用 AnnotationAwareOrderComparator#sort(List<?> list) 方法,排序对象们。例如说,类上有 @Order 注解。

2.2 run

#run(String... args) 方法,运行 Spring 应用。代码如下:

public ConfigurableApplicationContext run(String... args) {
    // 启动的时间,应用于简单统计启动时长
    long startTime = System.nanoTime();
    DefaultBootstrapContext bootstrapContext = createBootstrapContext();
    ConfigurableApplicationContext context = null;
    // <2> 配置 headless 属性
    configureHeadlessProperty();
    // 获得 SpringApplicationRunListener 的数组,并启动监听
    SpringApplicationRunListeners listeners = getRunListeners(args);
    listeners.starting(bootstrapContext, this.mainApplicationClass);
    try {
        // <3> 创建  ApplicationArguments 对象
        ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
        // <4> 加载属性配置。执行完成后,所有的 environment 的属性都会加载进来,包括 application.properties 和外部的属性配置。
        ConfigurableEnvironment environment = prepareEnvironment(listeners, bootstrapContext, applicationArguments);
        configureIgnoreBeanInfo(environment);
        // <5> 打印 Spring Banner
        Banner printedBanner = printBanner(environment);
        // <6> 创建 Spring 容器。
        context = createApplicationContext();
        context.setApplicationStartup(this.applicationStartup);
        // <8> 主要是调用所有初始化类的 initialize 方法
        prepareContext(bootstrapContext, context, environment, listeners, applicationArguments, printedBanner);
        // <9> 初始化 Spring 容器。
        refreshContext(context);
        // <10> 执行 Spring 容器的初始化的后置逻辑。默认实现为空。
        afterRefresh(context, applicationArguments);
        // <12> 打印 Spring Boot 启动的时长日志。
        Duration timeTakenToStartup = Duration.ofNanos(System.nanoTime() - startTime);
        if (this.logStartupInfo) {
            new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), timeTakenToStartup);
        }
        // <13> 通知 SpringApplicationRunListener 的数组,Spring 容器启动完成。
        listeners.started(context, timeTakenToStartup);
        // <14> 调用 ApplicationRunner 或者 CommandLineRunner 的运行方法。
        callRunners(context, applicationArguments);
    }
    catch (Throwable ex) {
        // <14.1> 如果发生异常,则进行处理,并抛出 IllegalStateException 异常
        handleRunFailure(context, ex, listeners);
        throw new IllegalStateException(ex);
    }
    try {
        // <15> 通知 SpringApplicationRunListener 的数组,Spring 容器运行中。
        Duration timeTakenToReady = Duration.ofNanos(System.nanoTime() - startTime);
        listeners.ready(context, timeTakenToReady);
    }
    catch (Throwable ex) {
        // <15.1> 如果发生异常,则进行处理,并抛出 IllegalStateException 异常
        handleRunFailure(context, ex, null);
        throw new IllegalStateException(ex);
    }
    return context;
}
  • <2> 处,配置 headless 属性。这个逻辑,可以无视,和 AWT 相关。
  • <3> 处,调用 #getRunListeners(String[] args) 方法,获得 SpringApplicationRunListener 数组,并启动监听。代码如下:
// SpringApplication.java

private SpringApplicationRunListeners getRunListeners(String[] args) {
    Class<?>[] types = new Class<?>[] { SpringApplication.class, String[].class };
    return new SpringApplicationRunListeners(logger, getSpringFactoriesInstances(
            SpringApplicationRunListener.class, types, this, args));
}
  • 此处的 listeners 变量,如下图所示:

  • 注意噢,此时是 SpringApplicationRunListener ,而不是我们看到 listeners 的 ApplicationListener 类型。详细的,我们在 「3. SpringApplicationRunListeners」 中,在详细解析。

  • <4> 处,调用 #prepareEnvironment(SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments) 方法,加载属性配置。执行完成后,所有的 environment 的属性都会加载进来,包括 application.properties 和外部的属性配置。详细的,胖友先一起跳到 「2.2.1 prepareEnvironment」 中。

  • <5> 处,调用 #printBanner(ConfigurableEnvironment environment) 方法,打印 Spring Banner 。效果如下:

      .   ____          _            __ _ _
     /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
    ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
     \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
      '  |____| .__|_| |_|_| |_\__, | / / / /
     =========|_|==============|___/=/_/_/_/
     :: Spring Boot ::
    
  • <6> 处,调用 #createApplicationContext() 方法,创建 Spring 容器。详细解析,见 「2.2.2 createApplicationContext」

  • <7> 处,通过 #getSpringFactoriesInstances(Class<T> type) 方法,进行获得 SpringBootExceptionReporter 类型的对象数组。SpringBootExceptionReporter ,记录启动过程中的异常信息。

    • 此处,exceptionReporters 属性的结果如下图:

  • <8> 处,调用 #prepareContext(...) 方法,主要是调用所有初始化类的 #initialize(...) 方法。详细解析,见 「2.2.3 prepareContext」

  • <9> 处,调用 `#refreshContext(ConfigurableApplicationContext context) 方法,启动(刷新) Spring 容器。详细解析,见 「2.2.4 refreshContext」

  • <10> 处,调用 #afterRefresh(ConfigurableApplicationContext context, ApplicationArguments args) 方法,执行 Spring 容器的初始化的后置逻辑。默认实现为空

  • <12> 处,打印 Spring Boot 启动的时长日志。效果如下:

    2019-01-28 20:42:03.338  INFO 53001 --- [           main] c.iocoder.springboot.mvc.MVCApplication  : Started MVCApplication in 20.893 seconds (JVM running for 23.536)
    
  • <13> 处,调用 SpringApplicationRunListeners#started(ConfigurableApplicationContext context) 方法,通知 SpringApplicationRunListener 的数组,Spring 容器启动完成。

  • <14> 处,调用 #callRunners(ApplicationContext context, ApplicationArguments args) 方法,调用 ApplicationRunner 或者 CommandLineRunner 的运行方法。详细解析,见 「2.2.5 callRunners」

    • <14.1> 处,如果发生异常,则调用 #handleRunFailure(...) 方法,交给 SpringBootExceptionReporter 进行处理,并抛出 IllegalStateException 异常。
  • <15> 处,调用 SpringApplicationRunListeners#running(ConfigurableApplicationContext context) 方法,通知 SpringApplicationRunListener 的数组,Spring 容器运行中。

    • <15.1> 处,如果发生异常,则调用 #handleRunFailure(...) 方法,交给 SpringBootExceptionReporter 进行处理,并抛出 IllegalStateException 异常。

2.2.1 prepareEnvironment

#prepareEnvironment(SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments) 方法,加载属性配置。代码如下:

// SpringApplication.java

private ConfigurableEnvironment prepareEnvironment(SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments) {
    // Create and configure the environment
    // <1> 创建 ConfigurableEnvironment 对象,并进行配置
    ConfigurableEnvironment environment = getOrCreateEnvironment();
    configureEnvironment(environment, applicationArguments.getSourceArgs());
    // <2> 通知 SpringApplicationRunListener 的数组,环境变量已经准备完成。
    listeners.environmentPrepared(environment);
    // <3> 绑定 environment 到 SpringApplication 上
    bindToSpringApplication(environment);
    // <4> 如果非自定义 environment ,则根据条件转换
    if (!this.isCustomEnvironment) {
        environment = new EnvironmentConverter(getClassLoader()).convertEnvironmentIfNecessary(environment, deduceEnvironmentClass());
    }
    // <5> 如果有 attach 到 environment 上的 MutablePropertySources ,则添加到 environment 的 PropertySource 中。
    ConfigurationPropertySources.attach(environment);
    return environment;
}
  • <1> 处,调用 #getOrCreateEnvironment() 方法,创建 ConfigurableEnvironment 对象。代码如下:

  • // SpringApplication.java
    
    private ConfigurableEnvironment getOrCreateEnvironment() {
        // 已经存在,则进行返回
        if (this.environment != null) {
            return this.environment;
        }
        // 不存在,则根据 webApplicationType 类型,进行创建。
        switch (this.webApplicationType) {
            case SERVLET:
                return new StandardServletEnvironment();
            case REACTIVE:
                return new StandardReactiveWebEnvironment();
            default:
                return new StandardEnvironment();
        }
    }
    
    • 根据 webApplicationType 类型,会创建不同类型的 ConfigurableEnvironment 对象。
    • 例如说,Servlet 需要考虑 <servletContextInitParams /><servletConfigInitParams /> 等配置参数。
  • <1> 处,调用 #configureEnvironment(ConfigurableEnvironment environment, String[] args) 方法,配置 environment 变量。代码如下:

  •   // SpringApplication.java
    
       /**
        * 是否添加共享的 ConversionService
        */
    private boolean addConversionService = true;
    
       protected void configureEnvironment(ConfigurableEnvironment environment, String[] args) {
           // <1.1> 设置 environment 的 conversionService 属性
           if (this.addConversionService) {
               ConversionService conversionService = ApplicationConversionService.getSharedInstance();
               environment.setConversionService((ConfigurableConversionService) conversionService);
           }
           // <1.2> 增加 environment 的 PropertySource 属性源
           configurePropertySources(environment, args);
           // <1.3> 配置 environment 的 activeProfiles 属性
           configureProfiles(environment, args);
       }
    
    • <1.1> 处,设置 environmentconversionService 属性。可以暂时无视。感兴趣的胖友,可以看看 《【死磕 Spring】—— 环境 & 属性:PropertySource、Environment、Profile》

    • <1.2> 处,增加 environment 的 PropertySource 属性源。代码如下:

    •  // SpringApplication.java
      
         /**
          * 是否添加 JVM 启动参数
          */
         private boolean addCommandLineProperties = true;
         /**
          * 默认的属性集合
          */
      private Map<String, Object> defaultProperties;
      
         protected void configurePropertySources(ConfigurableEnvironment environment,
                 String[] args) {
             MutablePropertySources sources = environment.getPropertySources();
             // 配置的 defaultProperties
             if (this.defaultProperties != null && !this.defaultProperties.isEmpty()) {
                 sources.addLast(new MapPropertySource("defaultProperties", this.defaultProperties));
             }
             // 来自启动参数的
             if (this.addCommandLineProperties && args.length > 0) {
                 String name = CommandLinePropertySource.COMMAND_LINE_PROPERTY_SOURCE_NAME;
                 if (sources.contains(name)) { // 已存在,就进行替换
                     PropertySource<?> source = sources.get(name);
                     CompositePropertySource composite = new CompositePropertySource(name);
                     composite.addPropertySource(new SimpleCommandLinePropertySource(
                             "springApplicationCommandLineArgs", args));
                     composite.addPropertySource(source);
                     sources.replace(name, composite);
                 } else { // 不存在,就进行添加
                     sources.addFirst(new SimpleCommandLinePropertySource(args));
                 }
             }
         }
      
      • 代码上可以看出,可以根据配置的 defaultProperties、或者 JVM 启动参数,作为附加的 PropertySource 属性源。
    • <1.3> 处,配置 environmentactiveProfiles 属性。代码如下:

    • // SpringApplication.java
      
      /**
       * 附加的 profiles 的数组
       */
      private Set<String> additionalProfiles = new HashSet<>();
      
      protected void configureProfiles(ConfigurableEnvironment environment, String[] args) {
          environment.getActiveProfiles(); // ensure they are initialized 保证已经被初始化
          // But these ones should go first (last wins in a property key clash)
          Set<String> profiles = new LinkedHashSet<>(this.additionalProfiles);
          profiles.addAll(Arrays.asList(environment.getActiveProfiles()));
          // 设置 activeProfiles
          environment.setActiveProfiles(StringUtils.toStringArray(profiles));
      }
      
  • <2> 处,调用 SpringApplicationRunListeners#environmentPrepared(ConfigurableEnvironment environment) 方法,通知 SpringApplicationRunListener 的数组,环境变量已经准备完成。

  • <3> 处,调用 #bindToSpringApplication(ConfigurableEnvironment environment) 方法,绑定 environment 到 SpringApplication 上。暂时不太知道用途。

  • <4> 处,如果非自定义 environment ,则根据条件转换。默认情况下,isCustomEnvironmentfalse ,所以会执行这块逻辑。但是,一般情况下,返回的还是 environment 自身,所以可以无视这块逻辑先。

  • <5> 处,调用 ConfigurationPropertySources#attach(Environment environment) 静态方法,如果有 attach 到 environment上的 MutablePropertySources ,则添加到 environment 的 PropertySource 中。这块逻辑,也可以先无视。

2.2.2 createApplicationContext

#createApplicationContext() 方法,创建 Spring 容器。代码如下:

// SpringApplication.java

/**
 * The class name of application context that will be used by default for non-web
 * environments.
 */
public static final String DEFAULT_CONTEXT_CLASS = "org.springframework.context."
        + "annotation.AnnotationConfigApplicationContext";

/**
 * The class name of application context that will be used by default for web
 * environments.
 */
public static final String DEFAULT_SERVLET_WEB_CONTEXT_CLASS = "org.springframework.boot."
        + "web.servlet.context.AnnotationConfigServletWebServerApplicationContext";

/**
 * The class name of application context that will be used by default for reactive web
 * environments.
 */
public static final String DEFAULT_REACTIVE_WEB_CONTEXT_CLASS = "org.springframework."
        + "boot.web.reactive.context.AnnotationConfigReactiveWebServerApplicationContext";

protected ConfigurableApplicationContext createApplicationContext() {
    // 根据 webApplicationType 类型,获得 ApplicationContext 类型
    Class<?> contextClass = this.applicationContextClass;
    if (contextClass == null) {
        try {
            switch (this.webApplicationType) {
            case SERVLET:
                contextClass = Class.forName(DEFAULT_SERVLET_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);
        }
    }
    // 创建 ApplicationContext 对象
    return (ConfigurableApplicationContext) BeanUtils.instantiateClass(contextClass);
}
  • 根据 webApplicationType 类型,获得对应的 ApplicationContext 对象。

2.2.3 prepareContext

#prepareContext(ConfigurableApplicationContext context, ConfigurableEnvironment environment, SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments, Banner printedBanner) 方法,准备 ApplicationContext 对象,主要是初始化它的一些属性。代码如下:

// SpringApplication.java

private void prepareContext(ConfigurableApplicationContext context,
        ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
        ApplicationArguments applicationArguments, Banner printedBanner) {
    // <1> 设置 context 的 environment 属性
    context.setEnvironment(environment);
    // <2> 设置 context 的一些属性
    postProcessApplicationContext(context);
    // <3> 初始化 ApplicationContextInitializer
    applyInitializers(context);
    // <4> 通知 SpringApplicationRunListener 的数组,Spring 容器准备完成。
    listeners.contextPrepared(context);
    // <5> 打印日志
    if (this.logStartupInfo) {
        logStartupInfo(context.getParent() == null);
        logStartupProfileInfo(context);
    }
    // Add boot specific singleton beans
    // <6> 设置 beanFactory 的属性
    ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
    beanFactory.registerSingleton("springApplicationArguments", applicationArguments);
    if (printedBanner != null) {
        beanFactory.registerSingleton("springBootBanner", printedBanner);
    }
    if (beanFactory instanceof DefaultListableBeanFactory) {
        ((DefaultListableBeanFactory) beanFactory).setAllowBeanDefinitionOverriding(this.allowBeanDefinitionOverriding);
    }
    // Load the sources
    // <7> 加载 BeanDefinition 们
    Set<Object> sources = getAllSources();
    Assert.notEmpty(sources, "Sources must not be empty");
    load(context, sources.toArray(new Object[0]));
    // <8> 通知 SpringApplicationRunListener 的数组,Spring 容器加载完成。
    listeners.contextLoaded(context);
}
  • 这个方法,还是蛮长的,主要是给 context 的属性做赋值,以及 ApplicationContextInitializer 的初始化。

  • <1> 处,设置 contextenvironment 属性。

  • <2> 处,调用 #postProcessApplicationContext(ConfigurableApplicationContext context) 方法,设置 context 的一些属性。代码如下:

  • // SpringApplication.java
    
    protected void postProcessApplicationContext(ConfigurableApplicationContext context) {
        if (this.beanNameGenerator != null) {
            context.getBeanFactory().registerSingleton(AnnotationConfigUtils.CONFIGURATION_BEAN_NAME_GENERATOR, this.beanNameGenerator);
        }
        if (this.resourceLoader != null) {
            if (context instanceof GenericApplicationContext) {
                ((GenericApplicationContext) context).setResourceLoader(this.resourceLoader);
            }
            if (context instanceof DefaultResourceLoader) {
                ((DefaultResourceLoader) context).setClassLoader(this.resourceLoader.getClassLoader());
            }
        }
        if (this.addConversionService) {
            context.getBeanFactory().setConversionService(ApplicationConversionService.getSharedInstance());
        }
    }
    
  • <3> 处,调用 #applyInitializers(ConfigurableApplicationContext context) 方法,初始化 ApplicationContextInitializer 。代码如下:

  • // SpringApplication.java
    
    protected void applyInitializers(ConfigurableApplicationContext context) {
        // 遍历 ApplicationContextInitializer 数组
        for (ApplicationContextInitializer initializer : getInitializers()) {
            // 校验 ApplicationContextInitializer 的泛型非空
            Class<?> requiredType = GenericTypeResolver.resolveTypeArgument(
                    initializer.getClass(), ApplicationContextInitializer.class);
            Assert.isInstanceOf(requiredType, context, "Unable to call initializer.");
            // 初始化 ApplicationContextInitializer
            initializer.initialize(context);
        }
    }
    
    • 遍历 ApplicationContextInitializer 数组,逐个调用 ApplicationContextInitializer#initialize(context) 方法,进行初始化。
  • <4> 处,调用 SpringApplicationRunListeners#contextPrepared(ConfigurableApplicationContext context) 方法,通知 SpringApplicationRunListener 的数组,Spring 容器准备完成。\

  • <5> 处,打印日志。效果如下:

  • 2019-01-28 17:53:31.600  INFO 21846 --- [           main] c.iocoder.springboot.mvc.MVCApplication  : Starting MVCApplication on MacBook-Pro-5.local with PID 21846 (/Users/yunai/Java/spring-boot/spring-boot-tests/spring-boot-yunai-tests/spring-boot-yunai-mvc-tests/target/classes started by yunai in /Users/yunai/Java/spring-boot)
    2019-01-28 17:53:40.028  INFO 21846 --- [           main] c.iocoder.springboot.mvc.MVCApplication  : The following profiles are active: prod
    
  • <6> 处,设置 beanFactory 的属性。

  • <7> 处,调用 #load(ApplicationContext context, Object[] sources) 方法,加载 BeanDefinition 们。代码如下:

  • // SpringApplication.java
    
    protected void load(ApplicationContext context, Object[] sources) {
        if (logger.isDebugEnabled()) {
            logger.debug("Loading source " + StringUtils.arrayToCommaDelimitedString(sources));
        }
        // <1> 创建 BeanDefinitionLoader 对象
        BeanDefinitionLoader loader = createBeanDefinitionLoader(getBeanDefinitionRegistry(context), sources);
        // <2> 设置 loader 的属性
        if (this.beanNameGenerator != null) {
            loader.setBeanNameGenerator(this.beanNameGenerator);
        }
        if (this.resourceLoader != null) {
            loader.setResourceLoader(this.resourceLoader);
        }
        if (this.environment != null) {
            loader.setEnvironment(this.environment);
        }
        // <3> 执行 BeanDefinition 加载
        loader.load();
    }
    
    • <1> 处,调用 #getBeanDefinitionRegistry(ApplicationContext context) 方法,创建 BeanDefinitionRegistry 对象。代码如下:

    • // SpringApplication.java
      
      private BeanDefinitionRegistry getBeanDefinitionRegistry(ApplicationContext context) {
          if (context instanceof BeanDefinitionRegistry) {
              return (BeanDefinitionRegistry) context;
          }
          if (context instanceof AbstractApplicationContext) {
              return (BeanDefinitionRegistry) ((AbstractApplicationContext) context)
                      .getBeanFactory();
          }
          throw new IllegalStateException("Could not locate BeanDefinitionRegistry");
      }
      
    • <1> 处,调用 #createBeanDefinitionLoader(BeanDefinitionRegistry registry, Object[] sources) 方法,创建 org.springframework.boot.BeanDefinitionLoader 对象。关于它,后续的文章,详细解析。

    • <2> 处,设置 loader 的属性。

    • <3> 处,调用 BeanDefinitionLoader#load() 方法,执行 BeanDefinition 加载。关于这一块,胖友感兴趣,先简单看看 《【死磕 Spring】—— IoC 之加载 BeanDefinition》 文章。

  • <8> 处,调用 SpringApplicationRunListeners#contextLoaded(ConfigurableApplicationContext context) 方法,通知 SpringApplicationRunListener 的数组,Spring 容器加载完成。

2.2.4 refreshContext

#refreshContext(ConfigurableApplicationContext context) 方法,启动(刷新) Spring 容器。代码如下:

// SpringApplication.java

/**
 * 是否注册 ShutdownHook 钩子
 */
private boolean registerShutdownHook = true;

private void refreshContext(ConfigurableApplicationContext context) {
    // <1> 开启(刷新)Spring 容器
    refresh(context);
    // <2> 注册 ShutdownHook 钩子
    if (this.registerShutdownHook) {
        try {
            context.registerShutdownHook();
        } catch (AccessControlException ex) {
            // Not allowed in some environments.
        }
    }
}
  • <1> 处,调用 #refresh(ApplicationContext applicationContext) 方法,开启(刷新)Spring 容器。代码如下:

  • // SpringApplication.java
    
    protected void refresh(ApplicationContext applicationContext) {
        // 断言,判断 applicationContext 是 AbstractApplicationContext 的子类
        Assert.isInstanceOf(AbstractApplicationContext.class, applicationContext);
        // 启动(刷新) AbstractApplicationContext
        ((AbstractApplicationContext) applicationContext).refresh();
    }
    
  • <2> 处,调用 ConfigurableApplicationContext#registerShutdownHook() 方法,注册 ShutdownHook 钩子。这个钩子,主要用于 Spring 应用的关闭时,销毁相应的 Bean 们。

2.2.5 callRunners

#callRunners(ApplicationContext context, ApplicationArguments args) 方法,调用 ApplicationRunner 或者 CommandLineRunner 的运行方法。代码如下:

// SpringApplication.java

private void callRunners(ApplicationContext context, ApplicationArguments args) {
    // <1> 获得所有 Runner 们
    List<Object> runners = new ArrayList<>();
    // <1.1> 获得所有 ApplicationRunner Bean 们
    runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());
    // <1.2> 获得所有 CommandLineRunner Bean 们
    runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());
    // <1.3> 排序 runners
    AnnotationAwareOrderComparator.sort(runners);
    // <2> 遍历 Runner 数组,执行逻辑
    for (Object runner : new LinkedHashSet<>(runners)) {
        if (runner instanceof ApplicationRunner) {
            callRunner((ApplicationRunner) runner, args);
        }
        if (runner instanceof CommandLineRunner) {
            callRunner((CommandLineRunner) runner, args);
        }
    }
}

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文