SpringBoot学习笔记5-SpringBoot的外化配置

前言

以spring官方文档为基础，官方地址：Spring Boot
目前官方正式版本最新为：2.5.6（这个学习笔记系列基本是以翻译为主，不用浪费时间期望获取更多。更多是给自己看官方文档做的的一个笔记）
当前篇的内容：介绍官方文档2.5.6的第七章之SpringApplication特性_外化配置

SpringBoot允许配置外部化，即允许使用各种外部配置源，包括Java 属性文件、YAML 文件、环境变量和命令行参数等。
官方建议整个项目最好使用同一种配置格式，且当同一位置同时具有.properties和.yml格式，.properties则优先。

1. 配置项/文件的优先级

但是当多种配置源同时存在时，存在优先级。以下优先级由低到高，低的会被高的覆盖：

1. 默认属性(通过 SpringApplication.setDefaultProperties 指定)
2. @Configuration类上的@PropertySource注解。需要注意，在ApplicationContext刷新之前，是不会将这个类中的属性加到环境中的，像 logging.,spring.main. 之类的属性，在这里配置为时已晚。
3. 打包在应用程序内的application.properties或者appliaction.yml文件
4. 应用程序以外的application.properties或者appliaction.yml文件
5. 打包在应用程序内的application-{profile}.properties或者application-{profile}.yml文件
6. 应用程序以外的application-{profile}.properties或者application-{profile}.yml文件
7. 仅具有 random.* 属性的 RandomValuePropertySource
8. 操作系统环境变量
9. JVM系统属性 System.getProperties()
10. java:comp/env 里的JNDI属性
11. ServletContext 初始化参数
12. ServletConfig 初始化参数
13. SPRING_APPLICATION_JSON 中的属性(环境变量或系统属性中的内联JSON嵌入)
14. 命令行参数
15. 测试中的@SpringBootTest#properties注解特性
16. 测试中的@TestPropertySource注解
17. devtool处于active状态时， $HOME/.config/spring-boot 目录中的Devtool全局配置

配置文件按照以下顺序（由低到高）：

1. 打包在 jar 中的应用程序属性（application.properties和 YAML 变体）
2. 打包在 jar 中的特定于配置文件的应用程序属性（application-{profile}.properties和 YAML 变体）
3. 打包 jar 之外的应用程序属性（application.properties和 YAML 变体）
4. 打包在 jar之外的特定于配置文件的应用程序属性（application-{profile}.properties和 YAML 变体）

比如，当前指定了profile属性（–spring.profiles.active={profile}），那么相同位置的 application-{profile}.properties优先级大于application.properties的（yaml同样）。

举例来说，假设我们当前执行 java -jar demo.jar –spring.profiles.active=dev，此时application.properties和application-dev.properties文件如下：
application.properties

app.name=MyApp
server.port=8080

application-dev.properties

server.port=8081

那么最终 的server.port 的值为8081，而app.name不会变，被覆盖只有server.port。

​2. 属性文件的加载

Spring查找/加载属性文件的顺序如下：

• classpath:/
• classpath:/config
• 当前目录
• 当前目录的“/config”子目录

优先级越来越高，即classpath和当前目录同时存在，那么classpath会被当前目录覆盖。

如果不喜欢application作为配置文件名，你可以通过指定一个spring.config.name环境属性来切换到另一个文件名。

3. 在属性文件中配置随机值

SpringBoot支持在配置文件中配置随机值，主要是靠RandomValuePropertySource的支持。它可以支持生成int,long,uuid或者字符串。
使用格式为：

my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long}
my.uuid=${random.uuid}
my.number-less-than-ten=${random.int(10)}
my.number-in-range=${random.int[1024,65536]}

RandomValuePropertySource截图如下：

4. 使用Profile区分配置环境

通常情况下，我们开发的应用程序需要部署到不同的环境下，属性的配置自然也需要不同。如果每次在发布的时候替换配置文件，过于麻烦。SpringBoot的多环境配置为此提供了便利。具体做法如下：

我们之前在介绍各种配置的优先级的时候说过， application-{profile}.properties或者application-{profile}.yml文件 的优先级高于 application.properties或application.yml 配置，这里的profile就是我们定义的环境标识：

我们在resource目录下创建三个文件：
application.properties：默认的配置，default。
application-dev.properties：开发环境，dev。
application-prod.properties：生产环境，prod。
我们可以通过指定 spring.profiles.active 属性来激活对应的配置环境：

spring.profiles.active=dev

或使用命令行参数的配置形式：

$ java -jar hyh.jar --spring.profiles.active=dev

如果没有profile指定的文件于profile指定的文件的配置属性同时定义，那么指定profile的配置优先。

除了区分配置环境，还可以区分日志打印/Java代码的执行环境。

Java类中@Profile注解。下面2个不同的类实现了同一个接口，@Profile注解指定了具体环境。

// 接口定义
public interface SendMessage {

    // 发送短信方法定义
    public void send();

}

// Dev 环境实现类
@Component
@Profile("dev")
public class DevSendMessage implements SendMessage {

    @Override
    public void send() {
        System.out.println(">>>>>>>>Dev Send()<<<<<<<<");
    }

}

// Stg环境实现类
@Component
@Profile("stg")
public class StgSendMessage implements SendMessage {

    @Override
    public void send() {
        System.out.println(">>>>>>>>Stg Send()<<<<<<<<");
    }

}

// 启动类
@SpringBootApplication
public class ProfiledemoApplication {

    @Value("${app.name}")
    private String name;

    @Autowired
    private SendMessage sendMessage;

    @PostConstruct
    public void init(){
        sendMessage.send();// 会根据profile指定的环境实例化对应的类
    }

}

logback-spring.xml也支持有节点来支持区分

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml" />
    <logger name="org.springframework.web" level="INFO"/>

    <springProfile name="default">
        <logger name="org.springboot.sample" level="TRACE" />
    </springProfile>

    <springProfile name="dev">
        <logger name="org.springboot.sample" level="DEBUG" />
    </springProfile>

    <springProfile name="staging">
        <logger name="org.springboot.sample" level="INFO" />
    </springProfile>

</configuration>

参考文章：

1. Spring Boot 配置优先级顺序
2. LOOK ! SpringBoot的外部化配置最全解析
3. SpringBoot_2.5.6官方文档