SpringBoot（二）Yaml语法/注入和加载配置文件

文章目录

学习视频链接，以示尊重：https://www.bilibili.com/video/BV1PE411i7CV

一、配置文件

SpringBoot使用一个全局的配置文件，配置文件名称是固定的，有两种文件类型：

application.properties
- 语法结构：key=value
application.yaml（官方推荐）
- 语法结构：key：空格 value

配置文件的作用 ：修改SpringBoot自动配置的默认值，因为 SpringBoot 在底层都自动配置完成。

比如我们可以在配置文件中修改 Tomcat 默认启动的端口号：

server.port=8081

二、Yaml解析

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

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

以前的配置文件，大多数都是使用xml来配置。比如一个简单的端口配置，来对比下yaml和xml

扫描二维码关注公众号，回复： 11935381 查看本文章

传统xml配置：

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

yaml配置：

server:
  port: 8081

三、Yaml语法

语法：

3.1 普通值

字面量：普通的值 [ 数字，布尔值，字符串 ]

其中，字面量直接写在后面就可以，字符串默认不用加上双引号或者单引号；

yaml 的语法要求严格，注意：

空格不能省略
以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的
属性和值的大小写都是十分敏感的
单引号与双引号的区别：
- “ ” 双引号，不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思；
比如：name: “xingyu \n yu” 输出：xing 换行 yu
- ‘’ 单引号，会转义特殊字符，特殊字符最终会变成和普通字符一样输出
比如：name: ‘xingyu \n yu’ 输出：xing \n yu

3.2 对象、Map（键值对）

#对象、Map格式
k: 
    v1:
    v2:

比如：

student:
    name: LiuXingyu
    age: 22

行内写法：

student: {
    
    name: LiuXingyu,age: 22}

3.3 数组（ List、set ）

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

pets:
 - cat
 - dog
 - pig

行内写法：

pets: [cat,dog,pig]

四、注入配置文件

yaml文件更强大的地方在于，可以给实体类直接注入匹配值。举例使用：

1、在springboot项目中的resources目录下新建一个文件 application.yaml

2、编写一个实体类 Dog：

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
@Component  //注册bean到容器中
public class Dog {
    
    

    private String name;
    private Integer age;
    
    //有参无参构造、get、set方法、toString()方法  
}

3、之前使用注解@Value，来给bean注入属性值：

@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
@Component  //注册bean到容器中
public class Dog {
    
    

    @Value("小虎")
    private String name;
    @Value("22")
    private Integer age;
    
    //有参无参构造、get、set方法、toString()方法  
}

4、在SpringBoot的测试类下注入狗狗输出一下：

@SpringBootTest
class SpringbootLearnApplicationTests {
    
    

    @Autowired
    private Dog dog;
    @Test
    void contextLoads() {
    
    
        System.out.println(dog);
    }

}

//输出：
//Dog(name=小虎, age=22)

5、编写一个复杂一点的实体类：Person 类

@Data
@NoArgsConstructor
@AllArgsConstructor
@Component //注册bean到容器中
public class Person {
    
    
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

}

6、使用yaml配置的方式进行注入：

server:
  port: 8081
person:
  name: qinjiang
  age: 3
  happy: false
  birth: 2000/01/01
  maps: {
    
    k1: v1,k2: v2}
  lists:
    - code
    - girl
    - music
  dog:
    name: 旺财
    age: 1

7、使用@ConfigurationProperties注解注入到Person类中：

@ConfigurationProperties 作用：

将配置文件中配置的每一个属性的值，映射到这个组件中
告诉 SpringBoot 将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应

@Data
@NoArgsConstructor
@AllArgsConstructor
@Component //注册bean到容器中
@ConfigurationProperties(prefix = "person")
public class Person {
    
    
	......
}

注意：IDEA 会提示，springboot配置注解处理器没有找到，这时添加依赖：

<!-- 导入配置文件处理器，配置文件进行绑定就会有提示，需要重启 --><dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-configuration-processor</artifactId>  
    <optional>true</optional>
</dependency>

8、测试：

//输出
Person(name=xingyu, age=22, happy=false, birth=Sat Jan 01 00:00:00 CST 2000, maps={
    
    k1=v1, k2=v2}, lists=[code, girl, music], dog=Dog(name=旺财, age=1))

五、加载指定的配置文件

@PropertySource ：加载指定的配置文件；

@ConfigurationProperties：默认从全局配置文件（application.yaml）中获取值；

1、去resources目录下新建一个person.properties文件：

name=xingyu

2、在代码中指定加载person.properties文件：

@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {
    
    
    @Value("${name}")    
    private String name;
    ......  
}

3、再次测试，可以发现配置文件绑定成功。

六、配置文件占位符

配置文件还可以编写占位符生成随机数。

person:
  name: xingyu${
    
    random.uuid} # 随机uuid
  age: ${
    
    random.int}  # 随机int
  happy: false
  birth: 2000/01/01
  maps: {
    
    k1: v1,k2: v2}
  lists:
    - code
    - girl
    - music
  dog:
    name: ${
    
    person.hello:other}_旺财
    age: 1

七、总结

总结：

配置 yaml 和配置 properties 都可以获取到值，但是比较推荐 yaml。
如果在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value。
如果说，专门编写了一个 JavaBean 来和配置文件进行一一映射，就果断直接使用 @configurationProperties。

其他知识：

松散绑定：比如 yaml 中写的 last-name，这个和lastName是一样的，后面跟着的字母默认是大写的。这就是松散绑定
JSR303数据校验，这个可以在字段是增加一层过滤器验证，可以保证数据的合法性
复杂类型封装，yaml中可以封装对象，使用value就不支持