yml语法及yml属性值自动注入@ConfigurationProperties

前言

在Springboot中，推荐使用properties或者YAML文件来完成配置，但是对于较复杂的数据结构来说，YAML远远优于properties

yml语法

YAML中允许表示三种格式，分别是常量值，对象和数组

基本格式要求

1.YAML大小写敏感
2.使用缩进代表层级关系
3.缩进只能使用空格，不能使用TAB，不要求空格个数，只需要相同层级左对齐（一般2个或4个空格）

对象

使用冒号代表，格式为key: value。冒号后面要加一个空格

key: value

使用缩进表示层级关系

key:
    child-key: value
    child-key2: value2

YAML中还支持流式(flow)语法表示对象

key: {child-key: value,child-key2: value2}

数组

短横线加一个空格代表一个数组项

 hobby:  #也支持写法["play","watch","read"]
    - play
    - watch
    - read

数值

YAML中提供了多种常量结构，包括：整数，浮点数，字符串，NULL，日期，布尔，时间。

boolean: 
    - TRUE  #true,True都可以
    - FALSE  #false，False都可以
float:
    - 3.14
    - 1.23456e+5  #可以使用科学计数法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    #二进制表示
null:
    nodeName: 'node'
    parent: ~  #使用~表示null
string:
    - Hello world
    - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行，每一行会被转化成一个空格
date:
    - 2018-02-17    #日期必须使用ISO 8601格式，即yyyy-MM-dd
datetime: 
    -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

yml组装为bean

springboot 默认可以处理yml文件数据，当我们需要用到xml或者properties配置时吗，需要引入以下架包

 引入Jar

<!-- @ConfigurationProperties的支持 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration-processor</artifactId>
			<optional>true</optional>
		</dependency>

 

yml文件

person:
  name: 'li'  #字符串
  age: 18   #数字
  sex: true #boolean
  hobby:  #list  也支持写法["play","watch","read"]
    - "play"
    - "watch"
    - "read"
  own:   #map
   child-key: value
   child-key2: value2
  own2: {child-key: value,child-key2: value2} #yaml支持流式语法表示对象

bean文件

@ConfigurationProperties需要和@Component配合使用(默认读取application.yml，可以通过@PropertySource注解指定源文件)

@Component
@ConfigurationProperties(prefix = "person")
public class PersonProperties {
    private String name;
    private int age;
    private boolean sex;
    private List<String> hobby;
    private Map<String,String> own;

   //get/set ...
}

 或：@ConfigurationProperties也可以注释在方法上面

// 也可以注释在方法上面和@Bean配合使用
    @Bean
    @ConfigurationProperties(prefix = "person")
    public PersonProperties personProperties(){
        return new PersonProperties();
    }

 

springboot启动类使用 @EnableConfigurationProperties

@EnableConfigurationProperties
public class MSpringBootApplication {
	public static void main(String[] args) {
		SpringApplication.run(MSpringBootApplication.class, args);
	}
}

被@ConfigurationProperties注释的类需要注入springcain才能生效。除了使用@Component。我们还可以使用

@EnableConfigurationProperties({PersonProperties.class}) 方式来指定
 

 
注意：@Value 也能注入yml中的值，但只对基本类型有效,如下写法启动时会报错，Cannot resolve placeholder

@Value("${person.hobby}")
private List<String> hobby;