Spring Boot 属性配置解析

r囧r小猫 2024-03-16 17:16 93阅读 0赞

> 基于Spring Boot 3.1.0 系列文章
> 
> 1.  [Spring Boot 源码阅读初始化环境搭建][Spring Boot]
> 2.  [Spring Boot 框架整体启动流程详解][Spring Boot 1]
> 3.  [Spring Boot 系统初始化器详解][Spring Boot 2]
> 4.  [Spring Boot 监听器详解][Spring Boot 3]
> 5.  [Spring Boot banner详解][Spring Boot banner]

## 属性配置介绍 ##

Spring Boot 3.1.0 支持的属性配置方式与2.x版本没有什么变动，按照以下的顺序处理，后面的配置将覆盖前面的配置：  
1、SpringApplication.setDefaultProperties 指定的默认属性  
2、@PropertySource注解配置  
3、Jar包内部的application.properties 和 YAML 变量  
4、Jar包内部的application-\{profile\}.properties 和 YAML 变量  
5、Jar包外部的application.properties 和 YAML 变量  
6、Jar包外部的application-\{profile\}.properties 和 YAML 变量  
7、RandomValuePropertySource的随机值属性  
8、操作系统环境变量  
9、Java System属性 (System.getProperties())  
10、JNDI属性  
11、ServletContext 初始化参数  
12、ServletConfig 初始化参数  
13、嵌入在环境变量或系统属性中的SPRING\_APPLICATION\_JSON 的属性  
14、命令行参数  
15、测试环境properties 属性  
16、测试环境的@TestPropertySource 注解  
17、Devtools 全局配置

## 属性配置实验 ##

使用前面的`MyApplicationRunListener`来读取Spring Boot 启动完成后的自定义配置，如下：

public void started(ConfigurableApplicationContext context, Duration timeTaken) {
        
            System.out.println("上下文已刷新，应用程序已启动，但尚未调用CommandLineRunners和ApplicationRunners");
            System.out.println(context.getEnvironment().getProperty("me"));
        }

### 默认属性 ###

Properties properties = new Properties();
    properties.setProperty("me", "123456");
    springApplication.setDefaultProperties(properties);
    springApplication.run(args);

![在这里插入图片描述][bf5a394aca0f46d09e2364b98933cf5a.png]

### @PropertySource注解配置 ###

创建一个`app.yml`文件，放置于resource目录下：

me: 333333

在SpringBootDemoApplication中标注，`@PropertySource("classpath:app.yml")`  
![在这里插入图片描述][83ea80906fb34e0ea4a8f7004324f3f4.png]  
运行后，此配置覆盖了“SpringApplication.setDefaultProperties 指定的默认属性”。  
基于`@PropertySource`注解的配置，需要刷新上下文后才能读取，因此需要在刷新之前就加载的配置`如 logging.* and spring.main.*` ，不适用。

### Jar包内部的application.properties 和 YAML 变量 ###

在resources内部的`application.yml`中定义

me: 4444

运行后覆盖之前的配置值  
![在这里插入图片描述][cd1253f9ca68410295c6f72a9e69cb86.png]

### Jar包内部的application-\{profile\}.properties 和 YAML 变量 ###

在resources内部的`application-test.yml`中定义

me: 55555

并在`application.yml`中定义

spring:
      profiles:
        active:
          - test

运行后覆盖之前的配置值  
![在这里插入图片描述][74b387adbb114248834eb41df2c63f3a.png]

### Jar包外部的application.properties 和 YAML 变量 ###

在jar包所在目录，创建一个`application.yml`文件：

me: 666666

运行后覆盖之前的配置值  
![在这里插入图片描述][c84a13306789413d8eed8167f757ae99.png]

### Jar包外部的application-\{profile\}.properties 和 YAML 变量 ###

在jar 所在目录，创建一个`application-test.yml`文件：

me: 777777

运行后覆盖之前的配置值  
![在这里插入图片描述][d0b127e8f9b047a4bd20ad308662ad89.png]

### RandomValuePropertySource的随机值属性 ###

RandomValuePropertySource 会解析`random.*`开头的属性，返回一个随机值，如`${random.int}`返回一个随机整数  
同样在前面的`application-test.yml`文件中配置：

me: ${
        random.int}

启动后，打印一个随机整数  
![在这里插入图片描述][e8d304ed5fc7455f9539adc5497a5539.png]

### 操作系统环境变量 ###

在操作系统中配置一个`me`变量，值为888888,启动后，即可读取到me的环境变量：  
![在这里插入图片描述][7d76a1a7374c4f24a3b72df83cbd167e.png]

> 注意：操作系统环境变量要全局生效，否则会读取不到

### Java System属性 (System.getProperties()) ###

在这里，我们不再往JVM中设置新的属性，而是读取其原有的属性，如`java.version`  
在`MyApplicationRunListener`中，输出`java.version`

@Override
    public void started(ConfigurableApplicationContext context, Duration timeTaken) {
        
        System.out.println("上下文已刷新，应用程序已启动，但尚未调用CommandLineRunners和ApplicationRunners");
        System.out.println(context.getEnvironment().getProperty("me"));
        System.out.println(context.getEnvironment().getProperty("java.version"));
    }

为了能够体现后面的配置覆盖前面的配置，在`application-test.yml`中手动配置java.version

java:
      version: 1.8

运行后，打印的结果：  
![在这里插入图片描述][629cdd6733f84db09d79d1fbea31eb54.png]

### JNDI属性 ###

这块用的很少，就忽略了，如果是同样的配置，该配置会覆盖前面的配置。

### ServletContext 初始化参数 ###

### ServletConfig 初始化参数 ###

如上两个都是servlet的配置，如`server.port`

### 嵌入在环境变量或系统属性中的SPRING\_APPLICATION\_JSON 的属性 ###

在IDEA中配置启动时候的环境变量，`SPRING_APPLICATION_JSON`是一个JSON格式，如：  
![在这里插入图片描述][1e30403fb7234079aa6d9ffd1371bf27.png]  
启动后，将打印：  
![在这里插入图片描述][0e0b7663dd634ce39cfe1172ecb498f1.png]

### 命令行参数 ###

同样的在IDEA中配置命令行参数，`--me=10000`  
![在这里插入图片描述][4298daddeb664e9f8052a9edb2a722b4.png]  
启动后打印结果如下，覆盖以前配置的值：  
![在这里插入图片描述][41ad0027e1cb4e0995610395d83eb45a.png]

### 测试环境properties 属性 ###

该配置是在单元测试中使用，如：

@SpringBootTest(properties = {
        "me=2000"})
    class GatewayApplicationTests {
        
    
    	@Autowired
    	private Environment environment;
    
    	@Test
    	void contextLoads() {
        
    		System.out.println(environment.getProperty("me"));
    	}
    
    }

启动后，将打印`2000`

### 测试环境的@TestPropertySource 注解 ###

该配置是在单元测试中使用，如：

@TestPropertySource(properties = {
        "me=3000"})
    @SpringBootTest(properties = {
        "me=2000"})
    class SpringBootDemoTests {
        
    
    	@Autowired
    	private Environment environment;
    
    	@Test
    	void contextLoads() {
        
    		System.out.println(environment.getProperty("me"));
    	}
    
    }

启动后打印`3000`  
![在这里插入图片描述][955abfdd799347cfb9bef6bf43881034.png]

### Devtools 全局配置 ###

Devtools 是Spring Boot 提供的一套开发工具，启用需要依赖如下依赖：

<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-devtools</artifactId>
       <optional>true</optional>
    </dependency>

默认读取`$HOME/.config/spring-boot`目录下的`spring-boot-devtools.properties、spring-boot-devtools.yaml、spring-boot-devtools.yml`文件，如果不存在，会从 $HOME 目录的根目录中搜索是否存在 `.spring-bootdevtools.properties`  
如在`.spring-bootdevtools.properties`中配置：  
![在这里插入图片描述][d03e644efdab495f99e3590714b54b31.png]  
启动后打印的结果如下，已为最新值：

![在这里插入图片描述][c0b8666eb7784610886cca08ec89a4d6.png]

--------------------

> 作者其他要推荐的文章，欢迎来学习：  
> Prometheus 系列文章
> 
> 1.  [Prometheus 的介绍和安装][Prometheus]
> 2.  [直观感受PromQL及其数据类型][PromQL]
> 3.  [PromQL之选择器和运算符][PromQL 1]
> 4.  [PromQL之函数][PromQL 2]
> 5.  [Prometheus 告警机制介绍及命令解读][Prometheus 1]
> 6.  [Prometheus 告警模块配置深度解析][Prometheus 2]
> 7.  [Prometheus 配置身份认证][Prometheus 3]
> 8.  [Prometheus 动态拉取监控服务][Prometheus 4]
> 9.  [Prometheus 监控云Mysql和自建Mysql][Prometheus _Mysql_Mysql]
> 
> --------------------
> 
> Grafana 系列文章，版本：OOS v9.3.1
> 
> 1.  [Grafana 的介绍和安装][Grafana]
> 2.  [Grafana监控大屏配置参数介绍（一）][Grafana 1]
> 3.  [Grafana监控大屏配置参数介绍（二）][Grafana 2]
> 4.  [Grafana监控大屏可视化图表][Grafana 3]
> 5.  [Grafana 查询数据和转换数据][Grafana 4]
> 6.  [Grafana 告警模块介绍][Grafana 5]
> 7.  [Grafana 告警接入飞书通知][Grafana 6]
> 
> --------------------
> 
> Spring Boot Admin 系列
> 
> 1.  [Spring Boot Admin 参考指南][Spring Boot Admin]
> 2.  [SpringBoot Admin服务离线、不显示健康信息的问题][SpringBoot Admin]
> 3.  [Spring Boot Admin2 @EnableAdminServer的加载][Spring Boot Admin2 _EnableAdminServer]
> 4.  [Spring Boot Admin2 AdminServerAutoConfiguration详解][Spring Boot Admin2 AdminServerAutoConfiguration]
> 5.  [Spring Boot Admin2 实例状态监控详解][Spring Boot Admin2]
> 6.  [Spring Boot Admin2 自定义JVM监控通知][Spring Boot Admin2 _JVM]
> 7.  [Spring Boot Admin2 自定义异常监控][Spring Boot Admin2 1]
> 8.  [Spring Boot Admin 监控指标接入Grafana可视化][Spring Boot Admin _Grafana]

[Spring Boot]: https://itsaysay.blog.csdn.net/article/details/129665897
[Spring Boot 1]: https://itsaysay.blog.csdn.net/article/details/130981611
[Spring Boot 2]: https://itsaysay.blog.csdn.net/article/details/131034991
[Spring Boot 3]: https://itsaysay.blog.csdn.net/article/details/131073017
[Spring Boot banner]: https://itsaysay.blog.csdn.net/article/details/131116036
[bf5a394aca0f46d09e2364b98933cf5a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/7454b5c522984eeb9806440d9f411de9.png
[83ea80906fb34e0ea4a8f7004324f3f4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/8db2c010df3442ffbf6e3328caa98dbb.png
[cd1253f9ca68410295c6f72a9e69cb86.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/8901f79522924df2a10ea37f7f102bfd.png
[74b387adbb114248834eb41df2c63f3a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/4757a516e7704e20a26631d7dd7d691e.png
[c84a13306789413d8eed8167f757ae99.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/6c197b71d8b04631b6bcc304c45eea93.png
[d0b127e8f9b047a4bd20ad308662ad89.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/8b6d6b893e9440d3bdca657a29175d68.png
[e8d304ed5fc7455f9539adc5497a5539.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/207e9453610c48028cbe16320e7cdbc6.png
[7d76a1a7374c4f24a3b72df83cbd167e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/4239241c3ba04b8db04262c93c445e60.png
[629cdd6733f84db09d79d1fbea31eb54.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/28d181939adf4bae8b23a2513a4be98e.png
[1e30403fb7234079aa6d9ffd1371bf27.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/5146962f3e284f858164b57c76c365fd.png
[0e0b7663dd634ce39cfe1172ecb498f1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/454ca321eee34c0fa47ff6df97ee3922.png
[4298daddeb664e9f8052a9edb2a722b4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/632d4842131f474babc676d0de9702d1.png
[41ad0027e1cb4e0995610395d83eb45a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/5bc9c8c4bd35407581182efef4934666.png
[955abfdd799347cfb9bef6bf43881034.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/66300cf7553a447b9b0d29229bca2fbf.png
[d03e644efdab495f99e3590714b54b31.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/da06861b0ec04975bef6741142a1dad6.png
[c0b8666eb7784610886cca08ec89a4d6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/af80bf31d2af49c786bb71959a1fcae2.png
[Prometheus]: https://itsaysay.blog.csdn.net/article/details/128993876
[PromQL]: https://itsaysay.blog.csdn.net/article/details/128697766
[PromQL 1]: https://itsaysay.blog.csdn.net/article/details/128725788
[PromQL 2]: https://itsaysay.blog.csdn.net/article/details/128734102
[Prometheus 1]: https://itsaysay.blog.csdn.net/article/details/129035181
[Prometheus 2]: https://itsaysay.blog.csdn.net/article/details/129115894
[Prometheus 3]: https://itsaysay.blog.csdn.net/article/details/128741317
[Prometheus 4]: https://itsaysay.blog.csdn.net/article/details/128748383
[Prometheus _Mysql_Mysql]: https://itsaysay.blog.csdn.net/article/details/129248268
[Grafana]: https://itsaysay.blog.csdn.net/article/details/128260639
[Grafana 1]: https://itsaysay.blog.csdn.net/article/details/128280232
[Grafana 2]: https://blog.csdn.net/weixin_40972073/article/details/128292597
[Grafana 3]: https://itsaysay.blog.csdn.net/article/details/128309734
[Grafana 4]: https://itsaysay.blog.csdn.net/article/details/128379173
[Grafana 5]: https://itsaysay.blog.csdn.net/article/details/128586826
[Grafana 6]: https://itsaysay.blog.csdn.net/article/details/128665497
[Spring Boot Admin]: https://itsaysay.blog.csdn.net/article/details/125567451
[SpringBoot Admin]: https://itsaysay.blog.csdn.net/article/details/125302909
[Spring Boot Admin2 _EnableAdminServer]: https://itsaysay.blog.csdn.net/article/details/127986764
[Spring Boot Admin2 AdminServerAutoConfiguration]: https://itsaysay.blog.csdn.net/article/details/127990150
[Spring Boot Admin2]: https://itsaysay.blog.csdn.net/article/details/127992400
[Spring Boot Admin2 _JVM]: https://itsaysay.blog.csdn.net/article/details/128029153
[Spring Boot Admin2 1]: https://itsaysay.blog.csdn.net/article/details/128046695?spm=1001.2014.3001.5502
[Spring Boot Admin _Grafana]: https://itsaysay.blog.csdn.net/article/details/128089324?spm=1001.2014.3001.5502