读取 YAML 配置文件

基本语法

• 大小写敏感
• 使用缩进表示层级关系，k: v，使用空格分割k,v
• 缩进时不允许使用Tab键，只允许使用空格。换行
• 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
• # 表示注释，从这个字符一直到行尾，都会被解析器忽略。

支持的写法：

• 对象：键值对的集合，如：映射（map）/ 哈希（hash） / 字典（dictionary）
• 数组：一组按次序排列的值，如：序列（sequence） / 列表（list）
• 纯量：单个的、不可再分的值，如：字符串、数字、bool、日期

实例

@Component //加到类路径自动扫描 
@ConfigurationProperties(prefix = "person") //和配置文件person前缀的所有配置进行绑定
@Data //自动生成JavaBean属性的getter/setter
//@NoArgsConstructor //自动生成无参构造器
//@AllArgsConstructor //自动生成全参构造器
public class Person {
    private String name;
    private Integer age;
    private Date birthDay;
    private Boolean like;
    private Child child; //嵌套对象
    private List<Dog> dogs; //数组（里面是对象）
    private Map<String,Cat> cats; //表示Map
    private static String description; // 静态变量；多行文本
    
    public static String getDescription() {
        return description;
    }

    /**
     * 此方法修改的是静态变量description，注意不能是静态方法。
     */
    public void setDescription(String description) {
        Person.description = description;
    }
}

@Data
public class Dog {
    private String name;
    private Integer age;
}

@Data
public class Child {
    private String name;
    private Integer age;
    private Date birthDay;
    private List<String> text; //数组
}

@Data
public class Cat {
    private String name;
    private Integer age;
}

• 除了使用 @Component 加到类路径自动扫描，还可以使用 @Configuration + @Bean 方式。

  Peson类去除

  @Component //加到类路径自动扫描 
  @ConfigurationProperties(prefix = "person") //和配置文件person前缀的所有配置进行绑定
  

  新增配置类

  @Configuration // 代表这个类是一个配置类，可理解为用spring的时候xml里面的<beans>标签
  public class AppConfig {
  
      @Bean // 用来定义一个bean，可以指定初始、销毁方法，及bean范围等，可理解为用spring的时候xml里面的<bean>标签
      @ConfigurationProperties(prefix = "person")
      Person person() {
          return new Person();
      }
      
  }
  

yml

person:
  name: 张三
  age: 18
  # birthDay: 2010/10/10 12:12:12 推荐写为 birth-day
  birth-day: 2010/10/10 12:12:12
  like: true
  # private Child child; //嵌套对象
  child:
    name: 李四
    age: 20
    birth-day: 2018/10/10
    # private List<String> text; //数组
    text: ["abc","def"]
  # private List<Dog> dogs; //数组（里面是对象）
  dogs:
    - name: 小黑
      age: 3
    - name: 小白
      age: 2
  # private Map<String,Cat> cats; //表示Map
  cats:
    c1:
      name: 小蓝
      age: 3
    c2: {name: 小绿,age: 2} #对象也可用{}表示
  # | 保留文本格式，换行符正确显示
#   description: |
#     这是一个多行字符串的示例，
#     在这个示例中，
#     换行符和空格都会被保留。
  # > 折叠换行符，显示为一行
  description: >
    这是一个多行字符串的示例，
    在这个示例中，
    换行符和空格不会被保留。

细节

• birthDay 推荐写为 birth-day
• 文本：
  • 单引号不会转义【\n 则为普通字符串显示】
  • 双引号会转义【\n会显示为换行符】
• 大文本
  • |开头，大文本写在下层，保留文本格式，换行符正确显示
  • >开头，大文本写在下层，折叠换行符
• 多文档合并
  • 使用--可以把多个yaml文档合并在一个文档中，每个文档区依然认为内容独立

取值

// 获取静态变量
Person.getDescription()

// 获取非静态变量
@Resource
private Person person;

person.getName()