spring源码案例分析之bean初始化优先级顺序

前言

本来这篇文章去年就应该发了，但是有些事情被耽搁了，最近整理了下发了出来，关于spring源码相关有想沟通的小伙伴可以随时联系我。
本篇文章内容有点臃肿，可以选择性跳跃去看。干货还是有点的，尤其总结部分。
本篇承接上篇末尾之讨论spring源码案例分析之健康检查，有兴趣的读者可以去看看，说不定有对你帮助的惊喜。
本篇开始之前，我们先看下我项目总体的结构，如下图

    4.0.0

    com.xxq
    spring-source-analysis
    1.0-SNAPSHOT

    
        org.springframework.boot
        spring-boot-starter-parent
        1.5.13.RELEASE
    

    
        
            org.springframework.boot
            spring-boot-starter-web
        
    

pom文件很简单，引入父工程spring-boot-starter-parent，因为这次我们分析借助于web切入点，因此我们只简单引入一个starter-web就够了，其他没什么可说的，再看下代码结构：

项目工程图

很简单，一个springboot启动类，我们看下面一段代码：

@Configuration
@AutoConfigureAfter(HttpMessageConvertersAutoConfiguration.class)
public class WebClientAutoConfiguration {

    @Configuration
    @ConditionalOnClass(RestTemplate.class)
    public static class RestTemplateConfiguration {

        private final ObjectProvider messageConverters;

        private final ObjectProvider> restTemplateCustomizers;

        public RestTemplateConfiguration(
                ObjectProvider messageConverters,
                ObjectProvider> restTemplateCustomizers) {
            this.messageConverters = messageConverters;
            this.restTemplateCustomizers = restTemplateCustomizers;
        }

        @Bean
        @ConditionalOnMissingBean
        public RestTemplateBuilder restTemplateBuilder() {
            RestTemplateBuilder builder = new RestTemplateBuilder();
            HttpMessageConverters converters = this.messageConverters.getIfUnique();
            if (converters != null) {
                builder = builder.messageConverters(converters.getConverters());
            }
            List customizers = this.restTemplateCustomizers
                    .getIfAvailable();
            if (!CollectionUtils.isEmpty(customizers)) {
                customizers = new ArrayList(customizers);
                AnnotationAwareOrderComparator.sort(customizers);
                builder = builder.customizers(customizers);
            }
            return builder;
        }

    }

}

org.springframework.boot.autoconfigure.web.WebClientAutoConfiguration.RestTemplateConfiguration#restTemplateBuilder

这段代码spring自动装配了一个RestTemplateBuilder,我们注意到一个注解，@ConditionalOnMissingBean，这里我大致说下作用，不做深入研究，以后有机会我会单独写篇文章去分析这个注解，这个注解的大致作用就是如果容器中没有这个RestTemplateBuilder，那么这个@Bean的配置就生效，简单来说，就是没有这个bean，spring就会默认生成一个，有的话就不生成，这个注解是spring自动装配的一个核心点。

我们看下面这段代码：

@Configuration
public class Appconfig {
    @Bean
    public RestTemplateBuilder restTemplateBuilder() {
        return new RestTemplateBuilder();
    }

}

这段代码，注入了一个RestTemplateBuilder,那么问题来了，如果我也写了这样一个注入方法，那么spring用的RestTemplateBuilder到底是我们的还是spring自己的，有的人说是我们自己的，有的人说是spring默认的，那么，原因呢？下面我们来看下到底使用的是哪个。

自定义的RestTemplateBuilder

获取容器中的bean

获取容器中的bean

可以看到容器中的bean的内存地址和自定义的内存地址是一致的，所以可以确定的是，spring确实初始化的是我们定义的的，我们稍后我具体分析这个流程。

在正式开始分析之前，我们先区分下俩个注解，这对我们下面的分析有点铺垫，@Order和@Primary。

1. @Order一般用于拦截器和过滤器，是控制同类型bean的执行顺序，一个容器可以有多个filter和interceptor，每个承担不同的角色，但是可能有的先执行，有的要后执行，这时候@Order就排上用场了，在ssm架构体系下，如果想要控制过滤器的执行顺序，是通过在web.xml中配置过滤器的顺序来实现的，如今使用springboot方式，已经没有了web.xml，所以spring就创造了这种方式，不过现在已经不仅仅局限于过滤器和拦截器，包括spring command以及其他使用场景。
2. @Primary，是在bean注入的时候起作用的。如果一个容器中，有多个类型一样bean，不使用相关注解去处理，那么容器初始化的时候并不会报错，但是在注入的时候就会报错，这是由于spring并不知道你想要使用的是哪个。我们看下面的代码。

@Configuration
public class Appconfig {
    @Bean
    public RestTemplateBuilder restTemplateBuilder() {
        RestTemplateBuilder restTemplateBuilder = new RestTemplateBuilder();
        System.out.println(restTemplateBuilder.hashCode());
        return restTemplateBuilder;
    }

    @Bean
    public RestTemplateBuilder restTemplateBuilder1() {
        RestTemplateBuilder restTemplateBuilder = new RestTemplateBuilder();
        System.out.println(restTemplateBuilder.hashCode());
        return restTemplateBuilder;
    }

}

上面这段代码，在容器中配置了俩个RestTemplateBuilder类型的bean，不过他们的beanName一个是restTemplateBuilder，一个是restTemplateBuilder1。这样直接去启动工程是不会报错的。

image.png

image.png

我们可以看到容器中有俩个restTemplateBuilder，这时候正常启动，当我加入下面这段代码：

    @Autowired
    RestTemplateBuilder templateBuilder;

spring就会报出如下错误：

***************************
APPLICATION FAILED TO START
***************************

Description:

Field templateBuilder in com.xxq.web.MyApplicationContextAwaer required a single bean, but 2 were found:
    - restTemplateBuilder: defined by method 'restTemplateBuilder' in class path resource [com/xxq/appconfig/Appconfig.class]
    - restTemplateBuilder1: defined by method 'restTemplateBuilder1' in class path resource [com/xxq/appconfig/Appconfig.class]


Action:

Consider marking one of the beans as @Primary, updating the consumer to accept multiple beans, or using @Qualifier to identify the bean that should be consumed

异常大致翻译：找到了俩个bean，无法确定使用哪个，建议我们可以使用@Primary或者@Qualifier。于是我试着加入@Primary

    @Bean
    @Primary
    public RestTemplateBuilder restTemplateBuilder() {
        RestTemplateBuilder restTemplateBuilder = new RestTemplateBuilder();
        System.out.println(restTemplateBuilder.hashCode());
        return restTemplateBuilder;
    }

image.png

image.png

可以看到，spring注入的就是我们加上@Primary注解的bean。
举这么个例子是想告诉大家，@Primary不会改变spring容器中的bean的初始化优先级，只会改变注入时候的优先级，这里牵扯到spring容器的概念，springbean容器虽然是一个map，但是不是普通意义上的map，只要你的beanName不一样，那么都会放入到这个map中，在同一个config中的@Bean模式下，如果你定义了俩个beanName一样的bean，无论类型，只会初始化一个到容器中，至于是哪个，spring会以在appconfig类中最先读到的那个为准进行覆盖。如果是在不同的config中配置，name一致就算类型不一致，会使用最后读取到的。这一块内容也还是比较复杂，场景略微有点多，且处理的方式也都不一样，后续有时间再解析。

这时候就有小伙伴问了(其实是我自己)，既然上面你说spring先读到那个就初始化哪个这种情况，为什么就不可能先读到spring框架默认的bean，然后初始化呢，？接下来，我们开始分析。

1. 首先第一步，我们分析springboot启动类的加载

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

public static ConfigurableApplicationContext run(Object source, String... args) {
    // 重点部分，这里把启动类作为class类型传递给source变量，后续会用到这个。
    return run(new Object[] { source }, args);
}

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);
        //重点代码，后续会分析到
        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);
    }
}

上面代码是spring启动类的核心代码部份，我们这次只关心关于我们研究的部分：

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