在spring boot使用总结（九） 使用yaml语言来写配置文件

yaml是专门用来写配置文件的语言。使用yaml来写配置文件扩展性比较强而且十分方便。spring boot支持使用yaml语言来写配置文件，使用snakeyaml库来读取配置文件。spring boot关于yaml详细用法可以参考官方文档。

下面列举一些项目中常用的写法，帮你快速入门。

1 写yml文件的基本规则

a) 层级关系用缩进表示，相同的缩进表示的层级关系相同。
b) 缩进只能使用空格，不能使用tab键
例如在properties文件中有如下属性：

spring. profiles.active=test
spring. jackson.default-property-inclusion=non_default

在yml文件要写成这样：

spring:
   profiles:
       active: test
   jackson:
       default-property-inclusion: non_default

2 支持数组类型，数组成员前面加 -

city:
  - 北京
  - 上海
  - 深圳
  - 南京
  - 重庆

3 一个yml文件中可以写多个配置文件，配置文件之间用 --分割

spring:
    profiles:
       active: test

--

spring:
  profiles: prod

--

spring:
  profiles: test

4 支持别名功能，可以先定义别名，再进行引用。使用& 定义别名，* 引用别名。

testDatabase: &testDatabase
     username: test
     password: test
     driverClassName: com.mysql.jdbc.Driver
     test-on-borrow: true
     validation-query: SELECT 1

test:
        datasource:
            url: jdbc:mysql://10.50.10.100:3306/testdb?characterEncoding=utf-8
            <<: *testDatabase

上面的代码等同于

testDatabase: &testDatabase
     username: test
     password: test
     driverClassName: com.mysql.jdbc.Driver
     test-on-borrow: true
     validation-query: SELECT 1

test:
        datasource:
            url: jdbc:mysql://10.50.10.100:3306/testdb?characterEncoding=utf-8
            username: test
            password: test
            driverClassName: com.mysql.jdbc.Driver
            test-on-borrow: true
            validation-query: SELECT 1

别名功能在有重复配置的情况下特别有用，可以直接引用，避免写重复的配置。项目中常常遇到要配置多个数据库的情况，一般除了url，用户名，密码，其他的配置都是一样的，利用别名就可以少写重复的配置，也便于后面维护。
注意别名功能只能在同一个配置文件生效。例如如上面所示，在prod文件中定义的别名不能在test文件中被引用。

5 引用变量,引用变量使用${},也可以引用数组的值。可以先定义一下相同的值，在需要的地方直接引用即可。

spring:
    profiles:
       active: test

country: 中国

city:
    - 北京
    - 上海
    - 深圳
    - 南京
    - 重庆
--

spring:
  profiles: prod

 myCountry: ${country}
 myCity: ${city[0]}

--

spring:
  profiles: test

  myCountry: ${country}
  myCity: ${city[1]}

6 写长字符串，长字符串可以用""，在换行时使用 \

longStr: "abcdefgabcdefgabcdefgabcdefgabcdefgabcdefgabcdefgabcdefgabcdefg\
abcdefgabcdefgabcdefgabcdefgabcdefgabcdefgabcdefgabcdefgabcdefgabcdefgabcdefg\
abcdefgabcdefgabcdefgabcdefgabcdefgabcdefgabcdefg"

参考文档：
yaml语言教程