SpringBoot 优雅的读取yml（yml规范篇）

最新推荐文章于 2025-05-19 17:31:43 发布
最新推荐文章于 2025-05-19 17:31:43 发布
阅读量2.2k 收藏 5
点赞数 2
CC 4.0 BY-SA版权
分类专栏： Spring Boot 文章标签： yml规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/zhangzijiejiayou/article/details/103961563
本文深入解析YAML数据序列化语言的特点与规范，探讨其在数据交换与编程领域的优势，对比JSON与XML，并详解YAML的文档结构、编写规则及数据类型约定。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

一 认识 YAML

YAML（发音 /ˈjæməl/）是一个类似 XML、JSON 的数据序列化语言。其强调以数据为中心，旨在方便人类使用；并且适用于日常常见任务的现代编程语言。因而 YAML 本身的定义比较简单，号称“一种人性化的数据格式语言”。

YAML 的设计目标

人类容易阅读
可用于不同程序间的数据交换
适合描述程序所使用的数据结构，特别是脚本语言
丰富的表达能力与可扩展性
易于使用

YAML 与 XML、JSON

YAML 与 XML

具有 XML 同样的优点，但比 XML 更加简单、敏捷等

YAML 与 JSON

1.JSON 可以看作是 YAML 的子集，也就是说 JSON 能够做的事情，YAML 也能够做
2.YAML 能表示得比 JSON 更加简单和阅读，例如“字符串不需要引号”。所以 YAML 容易可以写成 JSON 的格式，但并不建议这种做。
3.YAML 能够描述比 JSON 更加复杂的结构，例如“关系锚点”可以表示数据引用（如重复数据的引用）。

YAML 组织结构

YAML 文件可以由一或多个文档组成（也即相对独立的组织结构组成），文档间使用“---”（三个横线）在每文档开始作为分隔符。同时，文档也可以使用“…”（三个点号）作为结束符（可选）。如下图所示：

1.如果只是单个文档，分隔符“---”可省略。
2.每个文档并不需要使用结束符“…”来表示结束，但是对于网络传输或者流来说，作为明确结束的符号，有利于软件处理。（例如不需要知道流关闭就能知道文档结束）
3.YAML 认为数据由以下三种结构组成：（每个文档由三种结构混合组成）

标量 （相当于数据类型）
序列 （相当于数组和列表）
键值表（相当于 Map 表）

二 YAML 编写规范

它的基本语法规则如下：
1）大小写敏感
2）使用缩进表示层级关系
3）缩进时不允许使用Tab键，只允许使用空格。
4）缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

规范一：文档使用 Unicode 编码作为字符标准编码，例如 UTF-8

规范二：使用“#”来表示注释内容

# 客户订单
date: 2015-02-01
customer:
  - name: Jai
items:
  - no: 1234         # 订单号
  - descript: cpu

规范三：使用空格作为嵌套缩进工具。通常建议使用两个空格缩进，不建议使用 tab （甚至不支持）

规范四：序列表示

使用“-”（横线） + 单个空格表示单个列表项

--- # 文档开始
- 第一章 简介
- 第二章 设计目录

使用"[]"表示一组数据

--- # 文档开始
[blue, red, green]

组合表示。每个结构都可以嵌套组成复杂的表示结构。

--- # 文档开始
- [blue, red, green]     # 列表项本身也是一个列表
- [Age, Bag]
- site: {osc:www.oschina.net, baidu: www.baidu.com}  # 这里是同 键值表 组合表示

规范五：键值表

使用 “:”（冒号） + 空格表示单个键值对

# 客户订单
date: 2015-02-01
customer:
  - name: Jai
items:
  - no: 1234         # 订单号
  - descript: cpu
  - price: ￥800.00

使用"{}"表示一个键值表

# 客户订单
date: 2015-02-01
customer:
  - name: Jai
items: {no: 1234, descript: cpu, price: ￥800.00}

"? " 问号+空格表示复杂的键。当键是一个列表或键值表时，就需要使用本符号来标记。

 # 使用一个列表作为键
 ? [blue, reg, green]: Color
 # 等价于
 ? - blue
   - reg
   - gree
 : Color

组合表示。每个结构都可以嵌套组成复杂的表示结构。

Color:
    - blue
    - red
    - green

 # 相当于 (也是 JSON 的表示)
 {Color: [blue, red, green]}

 div:
    - border: {color: red, width: 2px}
    - background: {color: green}
    - padding: [0, 10px, 0, 10px]

 # 使用缩进表示的键值表与列表项
 items:
    - item: cpu
      model: i3
      price: ￥800.00
    - item: HD
      model: WD
      price: ￥450.00

 # 上面使用 “-” 前导与缩进来表示多个列表项，相当于下面的JSON表示
 items: [{item:cpu, model:i3, price:￥800.00}, {item:HD, model:WD, price: ￥450.00}]

规范六：文本块

使用 “|” 和文本内容缩进表示的块：保留块中已有的回车换行。相当于段落块

yaml: | # 注意 ":" 与 "|" 之间的空格
JSON的语法其实是YAML的子集，大部分的JSON文件都可以被YAML的解释器解释。

使用 “>” 和文本内容缩进表示的块：将块中回车替换为空格，最终连接成一行。

yaml: > # 注意 ":" 与 ">" 之间的空格，另外可以使用空行来分段落
JSON的语法其实是YAML的子集，
大部分的JSON文件都可以被YAML的解释器解释。

使用定界符“”（双引号）、‘’（单引号）或回车表示的块：最终表示成一行。

yaml: # 使用回车的多行，最终连接成一行。
JSON的语法其实是YAML的子集，
大部分的JSON文件都可以被YAML的解释器解释。

yaml: # 使用了双引号，双引号的好处是可以转义，即在里面可以使用特殊符号
"JSON的语法其实是YAML的子集，
大部分的JSON文件都可以被YAML的解释器解释。"

规范七：数据类型的约定

对一些常用数据类型的表示格式进行了约定，包括:

 integer: 12345     # 整数标准形式
 octal: 0o34        # 八进制表示，第二个是字母 o
 hex: 0xFF          # 十六进制表示

 float: 1.23e+3     # 浮点数
 fixed: 13.67       # 固定小数
 minmin: -.inf      # 表示负无穷
 notNumber: .NaN    # 无效数字

 null:              # 空值
 boolean: [true, false] # 布尔值
 string: '12345'    # 字符串

 date: 2015-08-23   # 日期
 datetime: 2015-08-23T02:02:00.1z  # 日期时间
 iso8601: 2015-08-23t21:59:43.10-05:00  # iso8601 日期格式
 spaced: 2015-08-23 21:59:43.10 -5      # ?

“!”（叹号）显式指示类型，或自定义类型标识。单叹号通常是自定义类型，双叹号是内置类型

isString: !!str 2015-08-23     # 强调是字符串不是日期数据
 picture: !!binary |            # Base64  图片
     R0lGODlhDAAMAIQAAP//9/X
     17unp5WZmZgAAAOfn515eXv
     Pz7Y6OjuDg4J+fn5OTk6enp
     56enmleECcgggoBADs=
 #下面是内置类型
 !!int               # 整数类型
 !!float             # 浮点类型
 !!bool              # 布尔类型
 !!str               # 字符串类型
 !!binary            # 也是字符串类型
 !!timestamp         # 日期时间类型
 !!null              # 空值
 !!set               # 集合
 !!omap, !!pairs     # 键值列表或对象列表
 !!seq               # 序列，也是列表
 !!map               # 键值表
 #下面是一些例子：
 --- !!omap
 - Mark: 65
 - Sammy: 63
 - Key: 58

 --- !!set           # 注意，“?”表示键为列表，在这里列表为 null
 ? Mark
 ? Sammy
 ? Key

 # 下面是自定义的类型或标识
 %TAG ! tag:clarkevans.com,2002:   # % 是指令符号
 --- !shape
 # Use the ! handle for presenting
 # tag:clarkevans.com,2002:circle
 - !circle
   center: &ORIGIN {x: 73, y: 129}
   radius: 7
 - !line
   start: *ORIGIN
   finish: { x: 89, y: 102 }
 - !label
   start: *ORIGIN
   color: 0xFFEEBB
   text: Pretty vector drawing.

规范八：锚点与引用，定义数据的复用。

第一步：使用 “&” 定义数据锚点（即要复制的数据）

第二步：使用 “*” 引用上述锚点数据（即数据的复制目的地）

---
 hr:
   - Mark McGwire
   # Following node labeled SS
   - &SS Sammy Sosa            # 定义要复制的数据
 rbi:
   - *SS # Subsequent occurrence   这里是数据复制目标
   - Ken Griffey

详尽语法见官网：http://www.yaml.org/spec/1.2/spec.html

转自：https://www.cnblogs.com/BlogNetSpace/p/8444861.html

SpringBoot double保留两位
私信可回答各种问题~
04-23 2342
SpringBoot double保留两位
SpringBoot中读取yml中配置的list对象的配置项
BADAO_LIUMANG_QIZHI的博客
12-29 1480
参考上面获取yml配置文件中简单的配置项的方式。如果需要获取application.yml中配置的list数据，且每个list有多个属性的内容，比如下面添加在application.yml中的内容可以通过如下方式实现。
springboot读取配置文件（yml）内容
qq_38303546的博客
04-24 279
前言 在项目开发中，有时会从配置文件中动态读取配置信息，springboot项目如何去读取yml配置文件信息呢，方法如下： 方法 在Controller加上@Component注解，然后通过@Value("${}"）读取，如图： 配置文件： 具体使用方法： ...
SpringBoot
最新发布
马朋帅的博客
05-19 1309
/定义切面@Aspect@Component//定义切点@Pointcut注解本身不执行任何操作//定义切面@Aspect@Component//定义切点//定义前置通知System.out.println("执行了前置通知");//定义后置通知System.out.println("执行了后置通知");//环绕通知System.out.println("环绕前通知");System.out.println("环绕后通知");return ret;
Spring Boot读取Yml配置文件的3种方法
IWinds的博客
11-12 2万+
简述： 项目开发中难免要读取配置文件，本文结合开发经验介绍使用过的几种读取配置文件的几种方法。 1.基础用法，使用注解@Autowired注入Environment类 这种方式比较常见，就像注入service或者dao一样，声明一个Environment类变量，并在变量上加上@Autowire注解。如下： @Autowired private Environment environment; 该类所属包： import org.springframework.core.env.Envir
【SpringBoot系列】读取yml文件的几种方式
热门推荐
Venus's Blog
05-12 9万+
Spring Boot读取yml文件的主要方式有以下几种:​ 我们可以在bean的属性上使用@Value注解,直接读取yml中的值,如:application.yml: Bean: 2.Environment对象 我们可以通过注入Environment对象来读取yml值,如: 3.@ConfigurationProperties注解 我们可以使用@ConfigurationProperties注解将yml中的值映射到bean的属性上,如:application.yml: Bean: 4.YmlProper
spring boot 的yml配置文件定义list集合、数组和map以及使用中出现的错误
冰冻非一日之寒
03-13 5万+
1. 在平时的yml配置文件中，我们经常使用到配置基本数据类型的字符串，比如配置日志文件的写法如下： # 配置日志输出级别 logging: # 指定logback配置文件的位置 config: classpath:logback-spring.xml # 文件日志要输出的路径 path: E:/logs/springboot_server # 日志的输出级别 lev...
springboot 在xml里读取yml的配置信息的示例代码
09-07
YAML文件以`.yml`为扩展名，常用于存储应用程序的环境变量、数据库连接信息、服务器设置等。与XML相比，YAML的语法更加紧凑，更适合于配置文件。 然而，在某些场景下，可能需要在传统的XML配置文件中引用YAML配置...
详解springboot读取yml配置的几种方式
08-25
接下来，我们将介绍SpringBoot读取YML配置的三种方式： **第一种方式：@Value注解** 当只需获取配置文件中的个别值时，使用`@Value`是最直接的方法。例如： ```java @Configuration public class AppConfig { @...
SpringBoot读取yml配置文件
weixin_60719453的博客
09-20 5717
YAML（YAML Ain't Markup Language），一种数据序列化格式容易阅读容易与脚本语言交互以数据为核心，重数据轻格式YANL文件扩展名.yml（主流）.yaml几种数据格式比较application.yaml配置文件中的信息#创建类，用于封装下面的数据#有spring带我们去加载数据到对象中，且告诉spring加载这组信息#使用时从spring中直接获取信息使用自定义一个类//1、定义数据类型模型封装yaml文件中对应的数据。
SpringBoot 中 读取yml、properties 配置文件中的值，注入到实体类中
norang的博客
09-13 4017
这里写目录标题读取 yaml 配置文件 中的数据，映射到 实体类中1、使用@ConfigurationProperties("person") 注解读取 properties 配置文件 中的数据，映射到 实体类中1、使用@ConfigurationProperties("person") 注解2、使用@PropertySource(value ="classpath:koma.properties") 和 @Value("${person.name}") 注解@Value注解 和 @Configuratio
springboot项目中的yaml文件语法规则
十三月的博客
06-01 252
yaml文件
springboot入门教程之yml
农码一生
12-09 2474
按照外国人的读法yml叫雅妹儿 test启动  
【SpringBoot】yml配置集合，集合自定义对象，Map结构数据获取
Itmei的博客
08-28 1万+
SpringBoot的yml文件，想必大家应该都知道，里面配置了程序的配置文件，好多时候我们会在该文件配置一些我们自己的参数以键值对的方式定义，现在我打包成jar包后我们可以在jar包同级目录添加那么程序就会使用我们创建的配置信息，如果我们需要配置集合应该如何设置，并且我们还存在，集合里面是我们自定义的类又该如何获取呢？如果有个需求:现在要定时把库存信息请求到第三方平台中,这个时候我们就需要调用第三方接口回传库存信息等SpringBoot使用Scheduled定时任务时需要在注解类中添加。...
Spring Boot 优雅配置yml配置文件定义集合、数组和Map
给自己一个smile
10-27 1万+
Spring Boot 优雅配置yml配置文件定义集合、数组和Map
springboot yml文件自定义配置的读取、使用 字符串 数组 对象 集合
test
05-25 6207
springboot yml文件自定义配置的读取、使用 字符串 数组 对象 集合
Spring Boot 核心配置文件，yml 语法规范、多环境配置、配置文件加载顺序，EnvironmentAware 读取 yml 配置
蚩尤后裔-汪茂雄
07-13 1万+
目录 需求分析 多 profile 文件形式 yml 文档块形式 需求分析 Profile 是 Spring 对不同环境提供不同配置功能的支持，可以通过激活、指定参数等方式快速切换环境 项目开发时有开发环境、测试环境、部署环境等，可以通过 profile 配置切换 多 profile 文件形式 格式：application-{profile}.properties/yml，如：ap...
SpringBoot 中yml配置文件：定义list集合、数组及注意事项
qq_44761854的博客
02-29 4903
2.下面说一下如何在yml配置文件中定义list集合、对象集合、数组以及map集合等。如果使用@value注解会报错；2.1定义list集合。
SpringBoot（三） yaml配置文件
这里是阿安的博客
08-17 2469
YAML 和XML或properties等一样，是一种标记语言，常用作配置文件。YAML 的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件。YAML 的配置文件后缀为 .yml或.yaml。
springboot怎么读取yml
03-19
<think>嗯，用户想了解在Spring Boot中如何读取yml文件的方法及配置示例。首先，我需要回忆一下Spring Boot处理配置的几种方式。根据之前的引用资料，主要有使用@Value注解、Environment对象、@ConfigurationProperties绑定对象等方法。 首先，@Value注解是最直接的，适合单个属性的注入。比如在yml里有个属性name，就可以用@Value("${property.name}")来获取。不过如果有很多属性，逐个写@Value可能比较麻烦，这时候用@ConfigurationProperties批量绑定会更方便。 然后，Environment对象也是一个方法，通过env.getProperty("key")来获取值。这种方法在需要动态获取配置的时候比较有用，比如在非Bean的类中使用。 接下来是@ConfigurationProperties，这个需要定义一个Bean，并在类上标注@Component和@ConfigurationProperties(prefix="...")。这样可以自动将配置中的属性映射到类的字段上，特别是当配置有层次结构时，这种方式更清晰，比如数据源的配置。 用户可能还需要知道如何开启配置类的支持，记得在启动类上加@EnableConfigurationProperties，或者在配置类上加@Configuration。另外，可能需要处理类型转换的问题，比如列表或复杂结构，这时候需要确保字段类型正确，并且有相应的setter方法或者使用Lombok的@Data注解。 还有，用户可能会关心不同环境的配置，比如application-dev.yml和application-prod.yml，这时候可以通过spring.profiles.active来指定激活的环境。这部分可能需要提到多环境配置的处理方式。 另外，需要注意yml文件的格式是否正确，比如缩进和冒号的使用，避免因为格式错误导致配置无法读取。同时，如果配置属性不存在，可能需要设置默认值或者处理异常情况，比如使用@Value的默认值语法${property:default}。 可能还需要提到自定义配置的位置，比如通过spring.config.location来指定外部配置文件，这在部署时可能会有用。不过大部分情况下默认的application.yml已经足够。 最后，示例代码的展示很重要，用户可能需要具体的代码来参考如何实现。比如用@ConfigurationProperties定义一个数据源配置类，然后在业务类中注入使用。同时，测试是否成功读取配置，可以通过打印日志或者单元测试来验证。 需要确保回答覆盖所有主要方法，并且给出实际例子，这样用户能够根据步骤操作。同时，相关问题的生成要围绕可能的扩展点，比如多环境配置、验证配置有效性、复杂结构处理等，帮助用户进一步深入理解。</think>在Spring Boot中读取.yml文件的方式主要有以下三种方法，每种方法适用于不同的场景： ### 一、使用@Value注解直接注入 ```java @Component public class AppConfig { @Value("${server.port}") private int port; @Value("${spring.datasource.url}") private String dbUrl; } ``` 对应.yml配置示例： ```yaml server: port: 8080 spring: datasource: url: jdbc:mysql://localhost:3306/test ``` ### 二、通过Environment对象获取 ```java @Service public class MyService { @Autowired private Environment env; public void showConfig() { String timeout = env.getProperty("http.request.timeout"); // 使用配置值 } } ``` ### 三、使用@ConfigurationProperties绑定对象（推荐方式）[^3] 1. 定义配置类： ```java @Component @ConfigurationProperties(prefix = "custom.config") @Data // Lombok注解自动生成getter/setter public class CustomConfig { private String apiEndpoint; private int retryCount; private List<String> whiteList; } ``` 2. 配置示例： ```yaml custom: config: api-endpoint: https://api.example.com retry-count: 3 white-list: - 192.168.1.1 - 10.0.0.1 ``` ### 四、多环境配置示例 ```yaml # application-dev.yml spring: profiles: dev server: port: 8081 # application-prod.yml spring: profiles: prod server: port: 80 ``` ### 五、注意事项 1. 需要在启动类添加注解： ```java @SpringBootApplication @EnableConfigurationProperties // 启用配置属性绑定 public class Application { ... } ``` 2. 使用@ConfigurationProperties时支持类型自动转换： $$ \int_{a}^{b} f(x)dx \quad \text{类型转换示例} $$
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值