SpringBoot YAML语法基础详细整理

YAML

Spring Boot 提供了大量的自动配置，极大地简化了spring 应用的开发过程，当用户创建了一个 Spring Boot 项目后，即使不进行任何配置，该项目也能顺利的运行起来。当然，用户也可以根据自身的需要使用配置文件修改 Spring Boot 的默认设置。

SpringBoot 默认使用以下 2 种全局的配置文件，其文件名是固定的。

• application.properties
• application.yml/yaml

其中，application.yml 是一种使用 YAML 语言编写的文件，它与 application.properties一样，可以在 Spring Boot 启动时被自动读取，修改 Spring Boot 自动配置的默认值。

YAML 简介

YAML 全称 YAML Ain't Markup Language，它是一种以数据为中心的标记语言，比 XML 和 JSON 更适合作为配置文件。

想要使用 YAML 作为属性配置文件（以 .yml 或 .yaml 结尾），需要将 SnakeYAML 库添加到 classpath 下，Spring Boot 中的 spring-boot-starter-web 或 spring-boot-starter 都对 SnakeYAML 库做了集成， 只要项目中引用了这两个 Starter 中的任何一个，Spring Boot 会自动添加 SnakeYAML 库到 classpath 下。

YAML 语法

YAML 的语法如下：

• 使用缩进表示层级关系。
• 缩进时不允许使用 Tab 键，只允许使用空格。(可设置Tab替换四个空格)
• 缩进的空格数不重要，但同级元素必须左侧对齐。
• 大小写敏感。
• #表示注释。

YAML 常用写法

YAML 支持以下几种数据结构：

• 普通的值(数字、字符串、布尔、日期)
• 对象 属性值的集合
• 数组 一组按次序排列的值
• 集合 List、Set 与数组一样，Map与对象一样键值对的集合

普通值(字面量)

• 字面量是指单个的，不可拆分的值，例如：数字、字符串、布尔值、以及日期等。
• 在 YAML 中，使用“key:[空格]value”的形式表示一对键值对（空格不能省略）
• 字面量直接写在键值对的“value”中即可，且默认情况下字符串是不需要使用单引号或双引号的

username: root
password: 123456

若字符串使用单引号，则不会转义特殊字符，特殊字符会输出为其本身想表达的含义

username1: 'zhangsan \n lisi'

输出：zhangsan \n lisi

若字符串使用双引号，则会转义特殊字符,\n代表换行

username2: "zhangsan \n lisi"

输出：'zhangsan lisi'

对象(属性和值)、Map(键值对)

它们都是一对键值对，YAML 为对象提供了 2 种写法

普通写法 ，使用缩进表示对象与属性的层级关系。

map1:
    name: 张三
    age: 23

行内写法

map2: {name: 李四,age: 24}

@ConfigurationProperties获取键值对数据

@Value获取键值对数据

@Value获取map数据

map解析中，字符串一定要用"“把map所对应的value包起来，要不然解析会失败，导致不能转成 Map<StrObject>

test:
  map: "{name: '李四',age: 24}"

@Component
@Data
public class Test {
    @Value("#{${test.map}}")
    private Map<String,Object> map;
}

这里说明一下,获取的map值是Test(map={name=李四, age=24})这样的,数据是在{}里的

YAML语法中如果一个值以 “{” 开头, YAML 将认为它是一个字典, 所以我们必须如下方式引用它

map: "{name: '李四',age: 24}"

数组、list、set

YAML 使用“-”表示数组、list、set 中的元素

普通写法

  array1:
    - 张三
    - 李四
  list1:
    - 23
    - 24

行内写法

array2: [王五,毛六]
list2: [25,26]

@ConfigurationProperties获取数组与集合数据

@Value根据索引获取数组与集合单个元素数据

想从yml配置文件中读取数组，但是按照yml配置数组的形式有点麻烦,可以使用字符串去模拟数组

test:
  list: 张三,李四,王五

spring默认时按照逗号进行分割的，所以代码中可以写成

@Component
@Data
public class Test {
    @Value("${test.list}")
    private List<String> list;
}

另外，@Value注解是支持SpEL表达式的，所以还可以写成

@Component
@Data
public class Test {
    @Value("#{'${test.list}'.split(',')}")
    private List<String> list;
}

复合结构

以上几种数据结构可以任意组合使用，以实现不同的用户需求

比如List中放Map

test:
  listInMap:
    - name: 张三
      age: 23
    - name: 李四
      age: 24
    - {name: 王五,age: 25}

YAML 组织结构

一个 YAML 文件可以由一个或多个文档组成，文档之间使用“---”作为分隔符，且个文档相互独立，互不干扰。如果 YAML 文件只包含一个文档，则“---”分隔符可以省略。

#默认配置
server:
  port: 8080
#切换配置
spring:
  profiles:
    active: test
---
#开发环境
server:
  port: 8081
spring:
  config:
    activate:
      on-profile: dev
---
#测试环境
server:
  port: 8082
spring:
  config:
    activate:
      on-profile: test
---
#生产环境
server:
  port: 8083
spring:
  config:
    activate:
      on-profile: prod

到此这篇关于SpringBoot YAML语法基础详细整理的文章就介绍到这了,更多相关SpringBoot YAML内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论