SpringBoot配置文件YAML

一、简介

SpringBoot使用一个全局的配置文件，配置文件名是固定的，主要有两种格式：properties和yml

• application.properties
• application.yml

配置文件的作用是：修改SpringBoot自动配置的默认值，SpringBoot在底层会进行自动配置

yml 全称 YAML（YAML Ain’t Markup Language），以数据为中心，比 json、xml 等更适合做配置文件

SpringBoot加载yml配置文件的位置===配置文件加载位置

二、YAML语法

• k:(空格)v：表示一对键值对（空格必须有）

• 以空格的缩进来控制层次关系

• 只要是左对齐的一列数据，都是统一层级的

• 属性和值都是大小写敏感的

YAML支持的数据结构如下所示：

数据类型	描述	示例说明
字面量	单个的、不可再分的值	1)k: v：字面值直接来写； 2)字符串默认不用加上单引号或者双引号； 3)""：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思 name: “zhangsan \n lisi”：输出；zhangsan 换行 lisi 4)’’：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据 name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi
对象	键值对的集合，比较常用的方式	1)k: v：在下一行来写对象的属性和值的关系；注意缩进 2)对象还是k: v的方式；如下的dog标示对象，name与age表示属性 dog     name: beibei     age: 1
数组	一组按次序排列的值	1)一组连词线（-）开头的行，构成一个数组，注意缩进和空格 2)数组，对象可以组合使用 Animal: ‐ cat ‐ dog
复合结构	以上写法的任意组合

三、案例

准备演示所需的POJO对象

/**
 * 狗 实体类
 */
public class Dog {
    private Integer id;
    private String name;
    private Integer age;
 
   //被依赖项可以不加 @ConfigurationProperties 注解，但是必须提供 getter、setter、toString 方法
}

/**
 * @ConfigurationProperties 表示 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *  * prefix = "user" 表示 将配置文件中key为user的下面所有的属性与本类属性进行一一映射注入值，如果配置文件中
 *  * 不存在"user"的key，则不会为POJO注入值，属性值仍然为默认值
 *  * <p/>
 *  * @ConfigurationProperties (prefix = "user") 默认从全局配置文件中获取值然后进行注入
 *  * @Component 将本类标识为一个Spring 组件，因为只有是容器中的组件，容器才会为@ConfigurationProperties提供此注入功能
 */
@Component
@ConfigurationProperties(prefix = "user")
public class User {
    private Integer id;
    private String lastName;
    private Integer age;
    private Date birthday;
    private List<String> carList;
    private Map<String, String> cityMap;
    private Dog dog;

    //必须提供 getter、setter 方法才能注入值
}

示例配置文件如下：

user:
  id: 120
  lastName: 张三
  age: 24
  birthday: 2020/03/31
  carList:
    - bmw
    - buck
    - hafu
    - 五菱
  cityMap: {mapK1: mapV1, mapK2: mapV2}
  dog:
    id: 3245
    name: 哈士奇
    age : 9

取值的时候注意：必须使用 @Resource、@Autowired 注入 User 对象才能获取到它注入的属性值，直接 new User() 对象是没有注入的默认值的。