在 Spring 的启动过程中，一系列的操作步骤中，提供了很多的扩展点，供我们来增强；
简单来说就是提供了很多的钩子，这样当我们在某个节点执行前后，想干点其他的事情时，可以很简单的支持；
本文介绍的 ApplicationContextInitializer，spring 容器在刷新之前会回调这个接口，从而实现在 spring 容器未初始化前，干一些用户希望做的事情
一、项目准备
本文创建的实例工程采用 SpringBoot 2.2.1.RELEASE + maven 3.5.3 + idea 进行开发具体的 SpringBoot 项目工程创建就不赘述了，核心的 pom 文件，无需额外的依赖配置文件 application.yml， 也没有什么特殊的配置。
二、容器刷新前扩展点实例
1、自定义 ApplicationContextInitializer
当我们希望实现一个自定义的上下文初始化时，非常简单，实现上面这个接口就行了，就比如：
public class ApplicationContextInitializer01 implements ApplicationContextInitializer { @Override public void initialize(ConfigurableApplicationContext configurableApplicationContext) { System.out.println("ApplicationContextInitializer01"); }}
复制代码
2、扩展点注册
上面自定义一个扩展点，如何使它生效呢？
官方提供了三种方式，如在启动时，直接进行注册: springApplication.addInitializers(new ApplicationContextInitializer01());
@SpringBootApplicationpublic class Application {
public static void main(String[] args) { SpringApplication springApplication = new SpringApplication(Application.class); springApplication.addInitializers(new ApplicationContextInitializer01()); try (ConfigurableApplicationContext context = springApplication.run(args)) { } }}
复制代码
当我们的扩展点是放在一个 jar 包中对外提供时，使用上面的启动注册方式显然是不可行的，此时更推荐的做法就是通过 Spring 的 SPI 机制进行注册。
在资源目录下的 META-INF/spring.factories 文件中进行注册
org.springframework.context.ApplicationContextInitializer=com.git.hui.extention.context.ApplicationContextInitializer02
复制代码
说明
上面 SPI 的机制非常推荐大家使用，在之前的文章中，AutoConfiguration 的注册通常也是使用这种方式
除了上面的两种注册方式之外，另外还有一个配置文件的方式，在配置文件 application.properties 或 application.yml 中，如下配置
context: initializer: classes: com.git.hui.extention.context.ApplicationContextInitializer03
复制代码
启动测试
上面三种注册方式，我们实现三个自定义的扩展点，然后启动之后，看一下实际输出
上面的输出，可以简单的得出一个结论，不同注册方式的优先级（为了更合理的验证下面的观点，推荐大家修改下上面三个自定义扩展点名，排除掉是因为扩展名导致的排序问题）
配置文件注册 > SPI 注册 > 启动时注册
3、执行顺序指定
对于自定义的扩展点实现，当存在顺序关系时，我们可以通过 @Order 注解来实现， 如当上面的三个扩展点都是通过启动方式注册时
@Order(5)public class ApplicationContextInitializer01 implements ApplicationContextInitializer { @Override public void initialize(ConfigurableApplicationContext configurableApplicationContext) { System.out.println("ApplicationContextInitializer01"); }}
@Order(2)public class ApplicationContextInitializer02 implements ApplicationContextInitializer { @Override public void initialize(ConfigurableApplicationContext configurableApplicationContext) { System.out.println("ApplicationContextInitializer02"); }}
@Order(10)public class ApplicationContextInitializer03 implements ApplicationContextInitializer { @Override public void initialize(ConfigurableApplicationContext configurableApplicationContext) { System.out.println("ApplicationContextInitializer03"); }}
@SpringBootApplicationpublic class Application { public static void main(String[] args) { SpringApplication springApplication = new SpringApplication(Application.class); springApplication.addInitializers(new ApplicationContextInitializer01(), new ApplicationContextInitializer02(), new ApplicationContextInitializer03()); try (ConfigurableApplicationContext context = springApplication.run(args)) { } }}
复制代码
输出实例如下：
接着重点来了
若上面的三个自定义实现，不是相同的注册方式，如将 03 采用配置文件方式进行注册，那么 01, 02 依然是启动注册
则顺序是 03 > 02 > 01
即 @Order 注解修饰的顺序，并不能打破 配置文件 > SPI > 启动方式注册的顺序
关于自定义实现类的执行顺序，规则如下：
4、使用场景示例
最后我们再来看一下，这个扩展点到底有什么用，我们再什么场景下会用到这个呢？
一个经常可以看到的应用场景如通过它来指定需要激活的配置文件
public class ApplicationContextInitializer03 implements ApplicationContextInitializer { @Override public void initialize(ConfigurableApplicationContext configurableApplicationContext) { // 指定激活prod对应的配置文件 configurableApplicationContext.getEnvironment().setActiveProfiles("prod"); }}
复制代码
但是一般也很少见到有人这么干，因为直接使用配置参数就行了，那么有场景需要这么做么？
答案当然是有的，比如现在广为流行的 docker 容器部署，当我们希望每次都是打同一个镜像，然后在实际运行的时候，根据不同的环境来决定当前镜像到底启用哪些配置文件，这时就有用了
比如我们通过容器的环境参数 app.env 来获取当前运行的环境，如果是 prod，则激活 application-prod.yml; 如果是 test，则激活 application-test.yml
那么此时可以这么干：
public class EenvActiveApplicationContextInitializer implements ApplicationContextInitializer { @Override public void initialize(ConfigurableApplicationContext configurableApplicationContext) { String env = System.getenv("app.env"); if ("prod".equalsIgnoreCase(env)) { configurableApplicationContext.getEnvironment().setActiveProfiles("prod"); } else if ("test".equalsIgnoreCase(env)) { configurableApplicationContext.getEnvironment().setActiveProfiles("test"); } else { throw new RuntimeException("非法的环境参数：" + env); } }}
复制代码
5. 小结
本文作为扩展点的第一篇，通过实现 ApplicationContextInitializer 接口，从而达到在 spring 容器刷新之前做某些事情的目的
通常自定义的 ApplicationContextInitializer 有三种注册方式，按照优先级如下：
最后还给出了一个可以应用的实例场景，即如何实现一个镜像在不同的环境中启动运行
下一个扩展点我们将介绍如何通过 BeanDefinitionRegistryPostProcessor 来实现非 Spring 生态的 Bean 加载使用
作者：一灰灰
链接：https://juejin.cn/post/7179219018862035004
来源：稀土掘金
评论