什么是YAML

/ 0评 / 0

YAML是"YAML Ain’t a Markup Language"(YAML不是一种标记语言)的递归缩写。YAML的意思其实是:“Yet Another Markup Language”(仍是一种标记语言)。主要强度这种语音是以数据为中心,而不是以标记语音为重心,例如像xml语言就会使用大量的标记。

YAML是一个可读性高,易于理解,用来表达数据序列化的格式。它的语法和其他高级语言类似,并且可以简单表达清单(数组)、散列表,标量等数据形态。它使用空白符号缩进和大量依赖外观的特色,特别适合用来表达或编辑数据结构、各种配置文件等。

YAML的配置文件后缀为 .yml,例如Springboot项目中使用到的配置文件 application.yml 。

基本语法

数据类型

标量

标量是最基础的数据类型,不可再分的值,他们一般用于表示单个的变量,有以下七种:

# 字符串
string.value: Hello!您好呀!
# 布尔值,true或false
boolean.value: true
boolean.value1: false
# 整数
int.value: 10
int.value1: 0b1010_0111_0100_1010_1110 # 二进制
# 浮点数
float.value: 3.14159
float.value1: 314159e-5 # 科学计数法
# Null,~代表null
null.value: ~
# 时间,时间使用ISO 8601格式,时间和日期之间使用T连接,最后使用+代表时区
datetime.value: !!timestamp 2021-04-13T10:31:00+08:00
# 日期,日期必须使用ISO 8601格式,即yyyy-MM-dd
date.value: !!timestamp 2021-04-13

这样,我们就可以在程序中引入了,如下:

@Data
@AllArgsConstructor
@NoArgsConstructor
public class TestEntity {

    @Value("{string.value}")
    private String stringValue;

    @Value("{boolean.value}")
    private boolean booleanValue;

    @Value("{boolean.value1}")
    private boolean booleanValue1;

    @Value("{int.value}")
    private int intValue;

    @Value("{int.value1}")
    private int intValue1;

    @Value("{float.value}")
    private float floatValue;

    @Value("{float.value1}")
    private float floatValue1;

    @Value("{null.value}")
    private String nullValue;

    @Value("{datetime.value}")
    private Date datetimeValue;

    @Value("{date.value}")
    private Date datevalue;
}

对象

我们知道单个变量可以用键值对,使用冒号结构表示 key: value,注意冒号后面要加一个空格。可以使用缩进层级的键值对表示一个对象,如下所示:

pre-user:
  name: 郭良俊只狗
  age: 25

然后在程序对这几个属性进行赋值到user对象中。使用@ConfigurationProperties注入对象,@value不能很好的解析复杂对象。

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * Created with IntelliJ IDEA.
 *
 * @Author: GuoLiangJun
 * @Date: 2021/4/21
 * @Time: 0:15
 */
@Component
@Data
@ConfigurationProperties(prefix = "pre-user")
public class User {
    private String name;
    private Integer age;
}

数组

可以用短横杆加空格 -开头的行组成数组的每一个元素,如下的address字段:

pre-user:
  name: 郭良俊只狗
  age: 25
  address:
    - 广州
    - 清远
    - 韶关

也可以使用中括号进行行内显示形式,如下:

pre-user:
  name: 郭良俊只狗
  age: 25
  address: [广州,清远,韶关]

在代码中引入方式如下:

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * Created with IntelliJ IDEA.
 *
 * @Author: GuoLiangJun
 * @Date: 2021/4/21
 * @Time: 0:15
 */
@Component
@Data
@ConfigurationProperties(prefix = "pre-user")
public class User {
    private String name;
    private Integer age;
    private List<String> address;
}

文本块

如果你想引入多行的文本块,可以使用|符号,注意在冒号:和 |符号之间要有空格。

pre-user:
  name: |
    Hello Javaer!!
  age: 25
  address: [广州,清远,韶关]

它和加双引号的效果一样,双引号能转义特殊字符:

pre-user:
  name: "Hello Java!!\nI am fine!\nThanks! GoodBye!"
  age: 25
  address: [广州,清远,韶关]

显示指定类型

有时我们需要显示指定某些值的类型,可以使用 !(感叹号)显式指定类型。!单叹号通常是自定义类型,!!双叹号是内置类型,例如:

# 指定为字符串
string.value: !!str HelloWorld!
# !!timestamp指定为日期时间类型
datetime.value: !!timestamp 2021-04-13T02:31:00+08:00

内置的类型如下:

引用

引用会用到 &锚点符合和 星号符号,&用来建立锚点,<< 表示合并到当前数据, 用来引用锚点。

guoliangjun: &guoliangjun
  name: 郭良俊
  age: 25

dept:
  id: dd001
  <<: *guoliangjun

上面最终相当于如下:

guoliangjun:
  name: 郭良俊
  age: 20

dept:
  id: dd001
  name: 郭良俊
  age: 20

还有一种文件内引用,引用已经定义好的变量,如下:

base.host: https://199604.com
add.person.url: ${base.host}?s=hive

单文件多配置

可以在同一个文件中,实现多文档分区,即多配置。在一个yml文件中,通过 — 分隔多个不同配置,根据spring.profiles.active 的值来决定启用哪个配置

#公共配置
spring:
  profiles:
    active: pro # 指定使用哪个文档块
---
#开发环境配置
spring:
  profiles: dev # profiles属性代表配置的名称

server:
  port: 8080
---
#生产环境配置
spring:
  profiles: pro

server:
  port: 8081

激活配置文件方式

  1. 通过在主配置文件中(application.yml或application.properties)指定变量spring.profiles.active的值,例如spring.profiles.active=dev
  2. 命令行指定:java -jar springboot-demo.jar --spring.profiles.active=dev
  3. 虚拟机参数指定:-Dspring.profiles.active=dev

配置文件加载顺序

springBoot启动会扫描读取以下位置中的配置文件,优先级由高到低:

  1. -file:./config/,即当前项目下的config文件夹(src同级目录)
  2. -file:./,即当前项目下
  3. -classpath:./config/,即当前项目中resources资源文件夹下的config文件夹
  4. -classpath:./,即当前项目中resources资源文件夹下

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注