이 기사에서 만든 예제 프로젝트는 SpringBoot 2.2.1.RELEASE
+ maven 3.5.3
+ idea
를 사용하여 개발되었습니다. >SpringBoot 2.2.1.RELEASE
+ maven 3.5.3
+ idea
进行开发
具体的SpringBoot项目工程创建就不赘述了,核心的pom文件,无需额外的依赖
配置文件 application.yml
, 也没有什么特殊的配置
当我们希望实现一个自定义的上下文初始化时,非常简单,实现上面这个接口就行了,如
public class ApplicationContextInitializer01 implements ApplicationContextInitializer { @Override public void initialize(ConfigurableApplicationContext configurableApplicationContext) { System.out.println("ApplicationContextInitializer01"); } }
上面自定义一个扩展点,如何使它生效呢?
官方提供了三种方式,如在启动时,直接进行注册: springApplication.addInitializers(new ApplicationContextInitializer01());
@SpringBootApplication public 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注册 > 启动时注册
对于自定义的扩展点实现,当存在顺序关系时,我们可以通过@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"); } } @SpringBootApplication public 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 > 启动方式注册的顺序
关于自定义实现类的执行顺序,规则如下
配置文件 > SPI > 启动方式
相同的注册方式,可以通过 @Order
注解进行修饰,值越小则优先级越高
最后我们再来看一下,这个扩展点到底有什么用,我们再什么场景下会用到这个呢?
一个经常可以看到的应用场景如通过它来指定需要激活的配置文件
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
application.yml
이 있으며 특별한 구성도 없습니다🎜🎜II. 컨테이너 새로 고침 전 확장 예시 🎜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); } } }
springApplication.addInitializers(new ApplicationContextInitializer01());
🎜rrreee🎜 확장 포인트가 jar 패키지에 배치될 때 외부 서비스를 제공할 때 위의 시작 등록 방법을 사용하는 것은 분명히 불가능합니다. 이때 더 권장되는 방법은 Spring의 SPI 메커니즘🎜🎜META-INF/spring.factories
를 통해 리소스 디렉터리에 등록하는 것입니다. file🎜rrreee🎜지침🎜AutoConfiguration을 사용하는 것이 좋습니다.
는 일반적으로 이런 방식으로 등록됩니다🎜application.properties
에 구성 파일 방법도 있습니다. > 또는 application.yml
, 다음을 구성합니다. 🎜rrreee🎜테스트 시작🎜🎜위의 세 가지 등록 방법에 대해 세 가지 맞춤형 확장 포인트를 구현하고 시작한 후 실제 출력 살펴보기🎜🎜🎜🎜위 출력은 다양한 등록 방법의 우선순위라는 결론을 쉽게 도출할 수 있습니다(다음 관점을 보다 합리적으로 확인하려면 위의 세 가지 사용자 정의 확장을 수정하고 제외하는 것이 좋습니다. 이름으로 인한 확장자 정렬 문제)🎜@Order
주석을 통해 구현할 수 있습니다. 예를 들어 위의 세 확장 포인트가 모두 다음을 통해 시작되는 경우입니다. 🎜rrreee🎜등록시 출력 예시는 다음과 같습니다🎜🎜🎜🎜그러면 핵심이 나옵니다🎜@Order
주석 수정 순서는 구성 파일> 시작 모드 등록🎜@Order code> 주석을 전달합니다. 값이 작을수록 우선순위가 높아집니다🎜
app.env
컨테이너의 환경 매개변수를 사용합니다. prod.yml ; 테스트라면 application-test.yml
을 활성화하세요🎜🎜그럼 지금 하시면 됩니다🎜rrreee위 내용은 SpringBoot 컨테이너가 새로 고쳐지기 전에 ApplicationContextInitializer를 다시 호출하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!