学科分类
目录
Spring Boot开发

application.yaml配置文件

YAML文件格式是Spring Boot支持的一种JSON超集文件格式,相较于传统的Properties配置文件,YAML文件以数据为核心,是一种更为直观且容易被电脑识别的数据序列化格式。application.yaml配置文件的工作原理和application.properties是一样的,只不过yaml格式配置文件看起来更简洁一些。

​ application.yaml文件使用 “key:(空格)value”格式配置属性,使用缩进控制层级关系。

这里,针对不同数据类型的属性值,介绍一下YAML文件配置属性的写法,具体如下所示。

(1)value值为普通数据类型(例如数字、字符串、布尔等)

当YAML配置文件中配置的属性值为普通数据类型时,可以直接配置对应的属性值,同时对于字符串类型的属性值,不需要额外添加引号,示例代码如下。

server:
  port: 8081
  path: /hello

上述代码用于配置server的port和path属性,port和path属于一个级别。

(2)value值为数组和单列集合

当YAML配置文件中配置的属性值为数组或单列集合类型时,主要有两种书写方式:缩进式写法和行内式写法。

其中,缩进式写法还有两种表示形式,示例代码如下。

person:
  hobby:
    - play
    - read
    - sleep 

或者使用如下示例形式。

person:
  hobby:
    play,
    read,
    sleep

上述代码中,在YAML配置文件中通过两种缩进式写法对person对象的单列集合(或数组)类型的爱好hobby赋值为play、read和sleep。其中一种形式为“-(空格)属性值”,另一种形式为多个属性值之前加英文逗号分隔(注意,最后一个属性值后不要加逗号)。

在YAML配置文件中,还可以将上述缩进式写法简化为行内式写法,示例代码如下。

person:
  hobby: [play,read,sleep]

通过上述示例对比发现,YAML配置文件的行内式写法更加简明、方便。另外,包含属性值的中括号“[]”还可以进一步省略,在进行属性赋值时,程序会自动匹配和校对。

(3)value值为Map集合和对象

当YAML配置文件中配置的属性值为Map集合或对象类型时,YAML配置文件格式同样可以分为两种书写方式:缩进式写法和行内式写法。

其中,缩进式写法的示例代码如下。

person:
  map:
    k1: v1
    k2: v2

对应的行内式写法示例代码如下。

person:
  map: {k1: v1,k2: v2}

在YAML配置文件中,配置的属性值为Map集合或对象类型时,缩进式写法的形式按照YAML文件格式编写即可,而行内式写法的属性值要用大括号“{}”包含。

接下来,在Properties配置文件演示案例基础上,通过配置application.yaml配置文件对Person对象进行赋值,具体使用如下。

(1)在chapter02项目的resources目录下,新建一个application.yaml配置文件,在该配置文件中编写为Person类设置的配置属性,内容如文件1所示。

文件1 application.yaml

 1    #对实体类对象Person进行属性配置
 2    person:
 3      id: 2
 4      name: 张三
 5      hobby: [sing,read,sleep]
 6      family: [father,mother]
 7      map: {k1: v1,k2: v2}
 8      pet: {type: cat, name: tom}

文件1中,在Spring Boot全局配置文件application.yaml中对person的相关属性进行了配置,这些配置属性也将会通过@ConfigurationProperties(prefix = "person")注解注入到Person实体类的对应属性中。

(2)打开chapter02项目的测试类Chapter02ApplicationTests,再次执行测试方法contextLoads(),对该Person对象进行输出打印(需要将之前在application.properties配置文件中编写的配置注释),查看控制台输出效果,具体如图1所示。

图1 程序测试效果

从图1可以看出,测试方法contextLoads()同样运行成功,并正确打印出了Person实体类对象。需要说明的是,本次使用application.yaml配置文件进行测试时需要提前将application.properties配置文件中编写的配置注释,这是因为application.properties配置文件的优先级要高于application.yaml配置文件。

至此,关于Spring Boot全局配置文件application.properties和application.yaml的语法格式和使用说明就讲解完毕。通过对比发现,YAML配置文件的格式更加简明、方便,因此也更加推荐使用YAML格式配置文件。

点击此处
隐藏目录