SpringBoot | 配置文件

「这是我参与11月更文挑战的第26天，活动详情查看：2021最后一次更文挑战」。

前言

SpringBoot 项目配置文件使我们的项目配置更加灵活，同时支持多种文件类型。原先的 properties 在 SpingBoot 中同样支持，用法同之前一样。但是开发中更多的是使用 YAML 格式，YAML 的语法中利用缩进，使得配置项结构更加清晰，并且更加简洁明了，更加适合用来作为以数据为中心的配置文件。

基础语法

• key: value; k-v键值对形式，注意":" 后面必须有空格
• 大小写敏感；
• 使用缩进表示层级关系;
• 缩进不允许使用tab，只允许空格
• 缩进的空格书不重要，只要相同层级的元素左对齐即可
• # 表示注释
• 字符串不需要加引号，加引号表示字符内容会被转义/不转义

数据类型

• 字面值，简单类型，不可再分的值。date、boolean、string、number、null

k: v

• 数组 一组按次序排列的值 array、list、queue

# 行内写法
k: [v1,v2,v3]
# 缩进写法
k:
 - v1
 - v2
 - v3

• 对象，键值对的集合。map、hash、set、object

# 行内写法
k: {k1:v1,k2:v2,k3:v3}
# 缩进写法
k:
 k1:v1
 k2:v2
 k3:v3

例子

我们创建一个Person 类，定义其中的属性，包括所有可能的数据类型，尝试通过 yml 配置文件，赋值。

@ConfigurationProperties(prefix = "person")
@Component
@Data
public class Person {
	
	private String userName;
	private Boolean boss;
	private Date birth;
	private Integer age;
	private Pet pet;
	private String[] interests;
	private List<String> animal;
	private Map<String, Object> score;
	private Set<Double> salarys;
	private Map<String, List<Pet>> allPets;
}

@Data
public class Pet {
	private String name;
	private Double weight;
}

# yaml表示以上对象
person:
  userName: zhangsan
  boss: false
  birth: 2019/12/12 20:12:33
  age: 18
  pet: 
    name: tomcat
    weight: 23.4
  interests: [篮球,游泳]
  animal: 
    - jerry
    - mario
  score:
    english: 
      first: 30
      second: 40
      third: 50
    math: [131,140,148]
    chinese: {first: 128,second: 136}
  salarys: [3999,4999.98,5999.99]
  allPets:
    sick:
      - {name: tom}
      - {name: jerry,weight: 47}
    health: [{name: mario,weight: 47}]

测试

@GetMapping(value = "/")
private Person  getPerson() {
    return person;
}

总结

1. yml 语法上手简单，并且易于理解，之后的项目中首选 yml 作为配置文件类型
2. yml 和 properties 是可以同时存在的，并且同时生效，但是加载优先级为 先加载 yml 在加载 properties ，所以当同时存在时，最后 properties 里的值会覆盖 yml 中的配置项
3. 当值为字符串类型时，可以不加引号，加上双引号则表示所写的内容不会被转义，比如 "张三 /n 18" 输出是 /n 不会被转义打印出来后会有换行效果。而如果 加上单引号 则表示将所有内容作为字符串输出，所见及所得，会将 /n 转义，打印出来就是 "张三 /n 18"