Springboot yaml配置与properties配置对比

yaml配置

• yaml是yet another mark-up language或者yaml ain’t mark-up language的简称。

• 语法格式为：key: value，key和value之间用冒号+空格间隔。 对空格的使用极为严格。

• 支持各种数据类型，对象，可直接给实体类赋值。

• 相比于传统的properties配置文件，更加简洁高效。

student:
  name: fresh
  age: 6
  hobbies: [reading,sports,drawing]
  subjects: {main: language,s1: math,s2: english}
  school:
    name: fitstAgain
    grade: two
    classNo: 1

@ConfigurationProperties

• 一般用@ConfigurationProperties来注解@Component组件类。
• 若被@ConfigurationProperties注解的类，未被@Component注解，则需用@EnableConfigurationProperties使被@ConfigurationProperties注解的类生效。
• 用@ConfigurationProperties注解类，适用于外部yaml配置，注入属性值。
• 用prefix属性指定yaml文件中的配置项，将配置项中每一个属性的值，绑定到@Component组件类的属性中。
• 实现属性值的批量注入。

@Component
@ConfigurationProperties(prefix = "student")
public class Student {
    private String name;
    private int age;
    private List<Object>  hobbies;
    private Map<String,Object> subjects;
    private School school;
    ......
}

@EnableConfigurationProperties

• 传入参数为：被@ConfigurationProperties注解的类.class

• 将被@ConfigurationProperties注解的类注入到Spring容器。

• 使被@ConfigurationProperties注解的类生效。

yaml表达式

格式为${}

• ${random.int}：支持随机生成整型
• ${student.name: better}：支持进行非空判断，若左边变量值存在不为空，取左边值，否则取冒号右边值。

properties文件配置

@PropertySource

• 一般用@PropertySource来注解@Component组件类。
• 用value属性指定properties文件名，例如：value="classpath:application.properties"
• 配合使用@Value("${XXX}")注解修饰类属性，注入properties文件中配置的属性值。
• 适用于全局变量的配置。

school.class-no=1
school.grade=one
school.name=first

@Component
@PropertySource(value = "classpath:application.properties")
public class School {
    @Value("${school.name}")
    private String name;
    @Value("${school.grade}")
    private String grade;
    @Value("${school.class-no}")
    private int classNo;
    ......
}

yaml配置与properties配置对比

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

• yaml配置，只需配置一次，使用@ConfigurationProperties进行绑定；

  properties文件配置，使用@PropertySource指定文件名，再用 @Value对每一个属性单独配置。

• 松散绑定：yaml配置支持松散匹配，例如yaml文件中配置文件名file-name，而对应类的属性是fileName，这种情况下，依然可以正常匹配上。

  @Value必须保证properties文件中的属性名和对应类中的属性名，完全一致，才能匹配上。

• JSR303数据校验是指在字段上增加一层过滤器校验，保证字段的合法性。

• yaml文件中可以封装对象，直接给实体类赋值，properties文件不支持。

最佳实践：

• yaml文件和properties文件都可以获取到属性值，优先推荐yaml配置
• 在某种业务场景中，若只需要获取配置文件中的某个值，可以用@Value
• 如果JavaBean和配置文件是映射关系，直接使用yaml文件