SpringBoot의 EnvironmentPostProcessor를 사용하는 방법

1. 배경

이전 프로젝트에서는 Apollo 구성 센터를 사용했는데, Apollo 구성 센터를 도킹한 후 프로그램에서 구성 센터의 속성을 사용할 수 있습니다. 이거 모직물로 구현됐나요? 구성 센터의 속성은 언제 프로그램에 로드되었습니까? 그렇다면 이것이 어떻게 구현되는지 알아낸다면 어디서나 구성 속성을 로드하고 구성 속성의 기능을 암호화 및 해독할 수 있을까요? Apollo配置中心，对接Apollo配置中心后，配置中心的属性就可以在程序中使用了，那么这个是怎么实现的呢？配置中心的属性又是何时加载到程序中的呢？那么我们如果找到了这个是怎么实现的是否就可以 从任何地方加载配置属性、配置属性的加解密功能呢？

二、需求

从上图中得知，我们的需求很简单，即我们自己定义的属性需要比配置文件中的优先级更高。

三、分析

1、什么时候向SpringBoot中加入我们自己的配置属性

当我们想在Bean中使用配置属性时，那么我们的配置属性必须在Bean实例化之前就放入到Spring到Environment中。即我们的接口需要在 application context refreshed 之前进行调用，而 EnvironmentPostProcessor 正好可以实现这个功能。

2、获取配置属性的优先级

我们知道在 Spring中获取属性是有优先级的。
比如我们存在如下配置属性 username

├─application.properties
│   >> username=huan
├─application-dev.properties
│   >> username=huan.fu

那么此时 username 的值是什么呢？此处借用 Apollo的一张图来说解释一下这个问题。

参考链接：https://www.apolloconfig.com/#/zh/design/apollo-design

Spring从3.1版本开始增加了ConfigurableEnvironment和PropertySource：

ConfigurableEnvironment

• Spring的ApplicationContext会包含一个Environment（实现ConfigurableEnvironment接口）

• ConfigurableEnvironment自身包含了很多个PropertySource

PropertySource

• 属性源

• 可以理解为很多个Key - Value的属性配置

由上方的原理图可知,key在最开始出现的PropertySource中的优先级更高，上面的例子在SpringBoot中username的值为huan.fu。

3、何时加入我们自己的配置

由第二步 获取配置属性的优先级 可知，PropertySource 越靠前越先执行，那么要我们配置生效，就必须放在越前面越好。

由上图可知，SpringBoot加载各种配置是通过EnvironmentPostProcessor来实现的，而具体的实现是ConfigDataEnvironmentPostProcessor来实现的。那么我们自己编写一个EnvironmentPostProcessor的实现类，然后在ConfigDataEnvironmentPostProcessor后执行，并加入到 Environment中的第一位即可。

四、实现

1、引入SpringBoot依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.huan.springcloud</groupId>
    <artifactId>springboot-extension-point</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-extension-point</name>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
</project>

2、在application.properties中配置属性

vim application.properties

username=huan

3、编写自定义属性并加入Spring Environment中

注意：
1、如果发现程序中日志没有输出，检查是否使用了slf4j输出日志，此时因为日志系统未初始化无法输出日志。解决方法如下：

SpringBoot版本
		>= 2.4 可以参考上图中的使用 DeferredLogFactory 来输出日志
		< 2.4
			1、参考如下链接 https://stackoverflow.com/questions/42839798/how-to-log-errors-in-a-environmentpostprocessor-execution
			2、核心代码：
				@Component
				public class MyEnvironmentPostProcessor implements
				        EnvironmentPostProcessor, ApplicationListener<ApplicationEvent> {
				    private static final DeferredLog log = new DeferredLog();
				    @Override
				    public void postProcessEnvironment(
				            ConfigurableEnvironment env, SpringApplication app) {
				        log.error("This should be printed");
				    }
				    @Override
				    public void onApplicationEvent(ApplicationEvent event) {
				        log.replayTo(MyEnvironmentPostProcessor.class);
				    }
				}

4、通过SPI使自定义的配置生效

1、在 src/main/resources下新建META-INF/spring.factories文件

2、配置

org.springframework.boot.env.EnvironmentPostProcessor=\
  com.huan.springcloud.extensionpoint.environmentpostprocessor.CustomEnvironmentPostProcessor

5、编写测试类，输出定义的 username 属性的值

@Component
public class PrintCustomizeEnvironmentProperty implements ApplicationRunner {

    private static final Logger log = LoggerFactory.getLogger(PrintCustomizeEnvironmentProperty.class);
    @Value("${username}")
    private String userName;
    @Override
    public void run(ApplicationArguments args) {
        log.info("获取到的 username 的属性值为: {}", userName);
    }
}

6、运行结果

五、注意事项

1、日志无法输出

参考上方的 3、编写自定义属性并加入Spring Environment中

2. 요구사항

• 위 그림을 통해 우리의 요구 사항이 매우 간단하다는 것을 알 수 있습니다. 즉, 우리가 정의하는 속성은 구성 파일의 속성보다 더 높은 우선 순위를 가져야 한다는 것입니다.
  3. 분석🎜

  1. SpringBoot에 자체 구성 속성을 추가하는 경우

  🎜Bean에서 구성 속성을 사용하려면 구성 속성이 Bean Put에 있어야 합니다. 인스턴스화하기 전에 Spring과 Environment에 추가합니다. 즉, 애플리케이션 컨텍스트가 새로 고쳐지기 전에 인터페이스를 호출해야 하며 EnvironmentPostProcessor가 이 기능을 정확하게 구현할 수 있습니다. 🎜

  2. 구성 속성 획득 우선순위

  🎜Spring에는 속성 획득 우선순위가 있다는 것을 알고 있습니다.
  예를 들어, username🎜

  org.springframework.boot.context.logging.LoggingApplicationListener

  🎜 구성 속성이 있습니다. 그러면 현재 username의 값은 무엇입니까? 이 문제를 설명하기 위해 Apollo의 사진을 빌려왔습니다. 🎜🎜참조 링크: https://www.apolloconfig.com/#/zh/design/apollo-design🎜🎜🎜🎜Spring에는 버전 3.1부터 ConfigurableEnvironment 및 PropertySource가 추가되었습니다. 🎜rrreee🎜🎜🎜Spring ApplicationContext는 환경 포함(ConfigurableEnvironment 인터페이스 구현)🎜
🎜🎜ConfigurableEnvironment 자체에는 많은 PropertySource가 포함되어 있습니다🎜🎜🎜PropertySource🎜🎜🎜🎜Property Sources🎜 🎜🎜can 많은 Key-Value 속성 구성으로 이해됩니다🎜🎜🎜위의 도식에서 볼 수 있듯이 key는 첫 번째 PropertySource에 나타납니다. 우선 순위가 더 높습니다. 위의 예에서 SpringBoot의 username 값은 huan.fu입니다. 🎜

3. 자체 구성을 추가하는 경우

🎜두 번째 단계 구성 속성의 우선순위 가져오기에서 PropertySource가 더 높은 것을 확인할 수 있습니다. 실행이 높을수록 구성이 적용되려면 가능한 한 빨리 배치되어야 합니다. 🎜🎜🎜🎜에서 볼 수 있듯이 위 그림에서 SpringBoot의 다양한 구성 로딩은 EnvironmentPostProcessor를 통해 이루어지며, 구체적인 구현은 ConfigDataEnvironmentPostProcessor를 통해 이루어집니다. 그런 다음 EnvironmentPostProcessor의 구현 클래스를 직접 작성한 다음 ConfigDataEnvironmentPostProcessor 다음에 이를 실행하고 Environment의 첫 번째 위치에 추가합니다. 🎜🎜🎜🎜4. 구현🎜

1. SpringBoot 종속성을 소개합니다.

rrreee

2. application.properties에서 속성을 구성합니다.

rrreeerrreee

3. 사용자 정의 속성을 작성하고 이를 Spring 환경에 추가합니다.

🎜🎜🎜참고:
1. 발견 로그에 출력이 없습니다. 로그 출력에 slf4j가 사용되었는지 확인하십시오. 이때 로그 시스템이 초기화되지 않았기 때문에 로그를 출력할 수 없습니다. 해결책은 다음과 같습니다:🎜rrreee

4. SPI를 통해 사용자 정의된 구성을 적용합니다

🎜1. src/main/resources >META-INF/spring.factories파일🎜🎜🎜🎜2. Configuration🎜rrreee

5. 테스트 클래스를 작성하고 정의된 사용자 이름 속성의 값을 출력

rrreee

6. 실행 결과

🎜 🎜🎜Notes🎜

1. .로그를 출력할 수 없습니다.

🎜위의 3. 사용자 정의 속성을 작성하고 이를 Spring 환경에 추가에서 제공하는 솔루션을 참조하세요. 🎜🎜2. 구성이 적용되지 않습니다. EnvironmentPostProcessor의 우선순위를 확인하여 @Order 또는 Ordered에서 반환된 우선순위 값이 잘못된지 확인하세요. 🎜

• 看看别的地方是否实现了 EnvironmentPostProcessor或ApplicationContextInitializer或BeanFactoryPostProcessor或BeanDefinitionRegistryPostProcessor等这些接口，在这个里面修改了 PropertySource的顺序。

• 理解 Spring 获取获取属性的顺序 参考 2、获取配置属性的优先级

3、日志系统如何初始化

如下代码初始化日志系统

org.springframework.boot.context.logging.LoggingApplicationListener

위 내용은 SpringBoot의 EnvironmentPostProcessor를 사용하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!