yaml
YAML(/ˈjæməl/,尾音类似camel骆驼)是一个可读性高,用来表达数据序列化的格式。YAML参考了其他多种语言,包括:C语言、Python、Perl,并从XML、电子邮件的数据格式(RFC 2822)中获得灵感。Clark Evans在2001年首次发表了这种语言,另外Ingy döt Net与Oren Ben-Kiki也是这语言的共同设计者。当前已经有数种编程语言或脚本语言支持(或者说解析)这种语言。
YAML是"YAML Ain’t a Markup Language"(YAML不是一种标记语言)的递归缩写。在开发的这种语言时,YAML 的意思其实是:“Yet Another Markup Language”(仍是一种标记语言),但为了强调这种语言以数据做为中心,而不是以标记语言为重点,而用反向缩略语重命名。
1.yaml语法格式
- key: value;kv之间有空格
- 大小写敏感
- 使用缩进表示层级关系
- 缩进不允许使用tab,只允许空格
- 缩进的空格数不重要,只要相同层级的元素左对齐即可
'#'
表示注释- 字符串无需加引号,如果要加,
'单引号
与"双引号
表示字符串内容 会被 转义/不转义
2.数据类型表示
- 字面量:单个的、不可再分的值。date、boolean、string、number、null
k: v
- 对象:键值对的集合。map、hash、set、object
行内写法: k: {
k1:v1,k2:v2,k3:v3}
#或
k:
k1: v1
k2: v2
k3: v3
- 数组:一组按次序排列的值。array、list、…
行内写法: k: [v1,v2,v3]
#或者
k:
- v1
- v2
- v3
springboot中yaml的使用
1. @ConfigurationProperties注解及bean的创建
@ConfigurationProperties
注解,用于将properties文件或者yml文件配置绑定到javabean组件上面。
创建一个Person的bean组件:
package com.robin.boot.bean;
import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.Set;
@ConfigurationProperties(prefix = "person") // 将application.yaml中前缀为person的数据绑定到person的bean组件中
@Component // 将person的javabean当作一个容器中的组件
@ToString
@Data
public class Person {
private String userName;
private Boolean boss;
private Date birth;
private Integer age;
private Pet pet;
private String[] hobbies;
private List<String> animal;
private Map<String, Object> score;
private Set<Double> pinMoney;
private Map<String, List<Pet>> allPets;
}
创建依赖的Pet的类:
package com.robin.boot.bean;
import lombok.Data;
import lombok.ToString;
@ToString
@Data
public class Pet {
private String name;
private int age;
}
2.编写controller
使用@RequestMapping注解,将指定的url路径请求映射做出响应:
package com.robin.boot.controller;
import com.robin.boot.bean.Person;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class TestController {
@Autowired // 自动装配
Person person;
@RequestMapping("/test") // 路径请求映射
public Person person(){
return person;
}
}
3.配置application.yaml配置文件
使用yaml语法格式,将对应的Person的属性写入并且绑定:
# yaml表示以上对象
person:
userName: robin
boss: true
birth: 2001/08/09
age: 21
pet:
name: 小白
age: 3
hobbies: [下棋,长跑,编程]
animal:
- 小狗
- 小猫
- 小猪
score: {
操作系统:88,数据结构:92,计网:97,计组:91}
pinMoney:
- 1500.01
- 2009.99
allPets:
sick:
- 小狗:
name: 小黄
age: 2
healthy:
- 小猫: {
name: 胖橘,age: 4}
- 小猪: {
name: 大花,age: 1}
4.pom.xml中开启yaml提示
使用到的lombok和yaml提示的pom.xml配置:
<!-- Lombok -->
<dependency>
<groupId>cn.itlym.shoulder</groupId>
<artifactId>lombok</artifactId>
<version>0.1</version>
</dependency>
<!-- 开启yml提示 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
过滤资源 configuration-processor:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<!-- 将yml提示的configuration-processor 取消避免打包到jar中 -->
<configuration>
<excludes>
<exclude>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>