Spring源码之ApplicationContextInitializer(二)

落日映苍穹つ 2023-02-17 02:36 39阅读 0赞

## 作用 ##

ApplicationContextInitializer是Spring的一个扩展接口，在spring框架刷新上下文(refresh方法)之前调用ApplicationContextInitializer的实现类完成一些ApplicationContext子类的初始化工作，例如加入一个数据源或者激活profile的环境，ApplicationContextInitializer实现类通常会实现一个Ordered接口或者使用@Order接口进行排序。

## 配置方式 ##

### spring.factories ###

通过在META-INF目录下的spring.factories配置org.springframework.context.ApplicationContextInitializer的实现类，将ApplicationContextInitializer的实现类加载到内存中，如下图所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70]

### springApplication ###

通过调用springApplication的addInitializers方法将自定义的实现类加载到内存，如下图所示  
![在这里插入图片描述][20200611080607867.png]

### application.properties ###

通过在application.properties文件中配置context.initializer.classes属性加载  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 1]

## 自定义实现类 ##

自定义一个ApplicationContextInitializer实现类，加入一个数据源，通过META-INF/spring.factories加载到内存，代码如下所示：

@Order(1)
    public class FirstInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> { 
    
        @Override
        public void initialize(ConfigurableApplicationContext configurableApplicationContext) { 
            ConfigurableEnvironment environment = configurableApplicationContext.getEnvironment();
            Map<String, Object> map = new HashMap<>();
            map.put("feidao", "zjl");
            MapPropertySource source = new MapPropertySource("firstInitializer", map);
            environment.getPropertySources().addLast(source);
            System.out.println("run firstInitializer");
        }
    }

org.springframework.context.ApplicationContextInitializer=com.zjl.spring.initializer.FirstInitializer

实现一个SpringService，注入applicationContext，通过getProperties方法获取feidao属性。

@Component
    public class SpringService implements ApplicationContextAware { 
    
        private ApplicationContext applicationContext;
    
        @Override
        public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { 
            this.applicationContext = applicationContext;
        }
    
        public String getProperties() { 
            return applicationContext.getEnvironment().getProperty("feidao");
        }
    }

在Application类实现ApplicationContextAware，通过applicationContext获取SpringService类，实现如下：

package com.zjl.spring;
    
    import com.zjl.spring.service.SpringService;
    import org.springframework.beans.BeansException;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.ApplicationContextAware;
    
    @SpringBootApplication
    public class Application implements ApplicationContextAware { 
    
        private static ApplicationContext applicationContext;
    
        public static void main(String[] args) { 
            SpringApplication springApplication = new SpringApplication(Application.class);
            springApplication.run(args);
            SpringService springService = getBean(SpringService.class);
            System.out.println(springService.getProperties());
        }
    
        @Override
        public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { 
            this.applicationContext = applicationContext;
        }
    
        public static <T> T getBean(Class<T> targetClz) { 
            return applicationContext.getBean(targetClz);
        }
    
    }

启动spring，结果：打印出了run firstInitializer和feidao属性的值zjl。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 2]

## 源码 ##

### 注入 ###

#### spring.factories ####

在[Spring源码之SpringFactoriesLoader(一)][Spring_SpringFactoriesLoader]中我们已经知道配置在META-INF/spring.factories中的属性会通过SpringFactoriesLoader加载到内存，在这里我们就不详细说明了。

#### springApplication ####

通过调用springApplication的addInitializers方法将实现类加入initializer的lis中，源码如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 3]

#### application.properties ####

通过在application.properties文件中配置context.initializer.classes属性加载，我们可以在工程中搜索该配置，看看哪里用到了，如下图  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 4]  
可以看到DelegatingApplicationContextInitializer类中用到了这个配置，而且这个类也实现了ApplicationContextInitializer接口，我们可以一起看看该类的initialize方法。  
首先通过getInitializerClasses方法加载到所有的context.initializer.classes配置的类，  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 5]  
通过applyInitializerClasses实例化加载进来的类，并且循环调用  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 6]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 7]  
所以通过context.initializer.classes配置的ApplicationContextInitializer实现类会通过DelegatingApplicationContextInitializer加载并且循环调用。

### 调用 ###

通过在自定义实现的FirstInitializer的initialize方法中打上断点，查看调用链，如下图所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 8]  
根据调用链进行分析，入口在springApplication.run方法中的prepareContext方法进入。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 9]  
在prepareContext方法中调用了applyInitializers方法  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 10]  
进入applyInitializers中，可以看到拿到了所有的initializer，进行循环调用initialize方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 11]

## 应用 ##

ApplicationContextInitializer一般是给web应用做初始化使用，还有就是加载一些数据源，为应用拉取外部的一些配置，例如Apollo(动态配置中心)的配置如果也想通过@Value注解加载，就可以实现一个ApplicationContextInitializer，在应用启动时把配置从apollo拉取下来加载到spring中，如下是ApolloApplicationContextInitializer的实现  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 12]

## 总结 ##

通过分析ApplicationContextInitializer，我们可以知道通过ApplicationContextInitializer我们可以给容器做一些初始化工作或者加载一些外部的配置属性。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200611080407798.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[20200611080607867.png]: https://img-blog.csdnimg.cn/20200611080607867.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200611080932117.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200611082858989.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[Spring_SpringFactoriesLoader]: https://blog.csdn.net/qq_27347991/article/details/106528319
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200611084618418.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200611085656398.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20200611090345337.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/2020061109074285.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/20200611091432469.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20200611083322855.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 9]: https://img-blog.csdnimg.cn/20200611083619952.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 10]: https://img-blog.csdnimg.cn/20200611083702157.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 11]: https://img-blog.csdnimg.cn/20200611083956640.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx_size_16_color_FFFFFF_t_70 12]: https://img-blog.csdnimg.cn/20200611093028192.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzI3MzQ3OTkx,size_16,color_FFFFFF,t_70