【Springboot】yaml配置文件多环境切换

news2025/1/19 7:14:57

关于配置文件的详细说明可以看官方文档：

24. Externalized Configuration

以下是个人学习过程中的笔记，如有错误，请多指教！

（一）配置文件

（二）yaml的概述及基本使用

yaml基本语法

（三）注入配置文件的三种方式

（四）yaml配置文件位置

（五）多环境切换配置文件

（一）配置文件

Springboot中可以使用两种形式的配置文件：.properties文件和 .yml文件

application.properties
语法结构：key=value

application.yml
语法结构： key: value

（二）yaml的概述及基本使用

YAML是 "YAML Ain't a Markup Language" （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）

yaml语言以数据作为中心，而不是以标记语言为重点！

传统xml配置：

<server>
    <port>8081<port>
</server>

yaml配置：

server：
  port: 8080

yaml基本语法：

        1. 冒号后面必须加一个空格！

        2. yaml通过缩进区分层级关系，相同缩进的为同一层级。

        3. 属性和值的大小写都是十分敏感的。

对象、Map（键值对）

# 配置对象属性
person: 
  name: 小明
  age: 8

# 配置键值对
maps: {k1: v1, k2: v2}

数组（List、set）

用 - 值表示数组中的一个元素，比如：

pets: 
  - cat
  - dog
  - parrot

# 行内写法
pets: [cat, dog, parrot]

（三）注入配置文件的三种方式

方式一：通过yaml配置文件注入匹配值

需要文件有：一个实体类Dog（name和age属性），application.yml, 一个测试类，还需在pom.xml中另外新添一个依赖。

①实体类Dog

package com.example.pojo;


@Component  //注册bean到容器中
@ConfigurationProperties(prefix = "dog") // 加载application.yaml中的配置,前缀为dog
public class Dog{

    private String name;
    private Integer age;

    //有参无参构造方法、get和set方法、toString()方法
}

②application.yml

dog: 
  name: 旺财
  age: 3

③测试类

@SpringBootTest
class DemoApplicationTests {

    @Autowired //将狗狗自动注入进来
    private Dog dog;

    @Test
    public void contextLoads() {
        System.out.println(dog); //打印看下狗狗对象
    }

}

这里还需要在pom.xml中添加一个依赖，很关键！不加的话会爆红。

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

运行结果：

方式二（还没学到yaml时是如何给bean注入属性值的）：通过@Value进行注入

这里只需要一个实体类即可，

@Component  // 注册bean
public class Dog{

    @Value("旺财")
    private String name;
    @Value("3")
    private Integer age;
}

方式三：指定加载自定义的properties文件为对象属性赋值

要有两个文件：whatever.properties（放在resources文件夹下）和一个实体类Dog；

(ps.这里的配置文件我取名为whatever，表示配置文件的名字是什么都可以，不一定非得是application.properties）

①whatever.properties配置文件

name=旺财
age=3

②实体类Dog

@Component  //注入到容器中
@PropertySource(value = "classpath:whatever.properties") 
// 加载指定路径的配置文件，这里的whatever.properties文件放在resources文件夹下
public class Dog{
    @Value("${name}")
    private String name;
    @Value("${age}")
    private Integer age;
}

三种方式看下来，@Value是最麻烦的了。

@Value和@ConfigurationProperties对比如下：

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定（松散语法）	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持

1、@ConfigurationProperties只需要些一次就好，@Value则需要每个字段都添加。

2、松散绑定：比方说yml文件中写的last-name，实体类的属性是lastName也能匹配得上，- 后面跟着的字母默认是大写的。具体可以测试下。

3、 JSR303数据校验，就是可以在字段是增加一层过滤器验证，可以保证数据的合法性。（比如@Null 验证对象是否为null ，@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。）

4、复杂类型封装，yml中可以封装对象，@Value就不支持。

结论：

配置yml和配置properties都可以获取到值，推荐使用 yml；

如果在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @Value；

如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，不要犹豫！

（四）yaml配置文件位置

可以放在4种地方：

序号	位置	说明	优先级
①	./config/	工程文件中的config文件夹下	第一优先被配置
②	./	直接在工程文件根目录下	第二优先被配置
③	classpath:/config/	资源文件夹中的config文件夹下	第三优先被配置
④	classpath:/	直接在资源文件下	第四优先被配置