正文

一步一步教你yaml快速入门

waiwei  waiwei  2023-04-25  742

关键词：

Java学习之路迢迢，无论是开局hello word，还是从头文件说起，总之，都是有顺序可言。

我们学习Java，都是先介绍properties文件，使用properties文件配合Properties对象能够很方便的适用于应用配置上。然后在引入XML的时候，我们介绍properties格式在表现层级关系和结构关系的时候，十分欠缺，而XML在数据格式描述和较复杂数据内容展示方面，更加优秀。到后面介绍JSON格式的时候，我们发现JSON格式比较XML格式，更加方便（除去数据格式限制之外），所以现在很多配置文件（比如Nginx和大部分脚本语言的配置文件）都习惯使用JSON的方式来完成，包括Springboot的出现目的也是在一定程度上去掉XML的繁琐配置。

在Springboot中，推荐使用properties或者YAML文件来完成配置，但是对于较复杂的数据结构来说，YAML又远远优于properties。本文就快速介绍YAML的常见语法格式。

先来看一个Springboot中的properties文件和对应YAML文件的对比：

#properties(示例来源于Springboot User guide):

environments.dev.url=http://dev.bar.com

environments.dev.name=Developer Setup

environments.prod.url=http://foo.bar.com

environments.prod.name=My Cool App

my.servers[0]=dev.bar.com

my.servers[1]=foo.bar.com

可以明显的看到，在处理层级关系的时候，properties需要使用大量的路径来描述层级（或者属性），比如environments.dev.url和environments.dev.name。其次，对于较为复杂的结构，比如数组（my.servers），写起来更为复杂。而对应的YAML格式文件就简单很多：

#YAML格式

environments:

dev:

url: http://dev.bar.com

prod:

url: http://foo.bar.com

my:

servers:

- dev.bar.com

- foo.bar.com

可以直观的看到，YAML使用冒号加缩进的方式代表层级（属性）关系，使用短横杠(-)代表数组元素。
经过这个示例的演示，可以很明显的看到YAML针对properties文件的优异之处。

快速入门

下面立刻展示YAML最基本，最常用的一些使用格式：
首先YAML中允许表示三种格式，分别是常量值，对象和数组
例如：

#即表示url属性值；

url: http://www.wolfcode.cn

#即表示server.host属性的值；

server:

host: http://www.wolfcode.cn

#数组，即表示server为[a,b,c]

server:

- 120.168.117.21

- 120.168.117.22

- 120.168.117.23

#常量

pi: 3.14 #定义一个数值3.14

hasChild: true #定义一个boolean值

注释

和properties相同，使用#作为注释，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

较为复杂的对象格式，可以使用问号加一个空格代表一个复杂的key，配合一个冒号加一个空格代表一个value：

- complexkey1

- complexkey2

- complexvalue1

- complexvalue2

意思即对象的属性是一个数组[complexkey1,complexkey2]，对应的值也是一个数组[complexvalue1,complexvalue2]

数组

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

hobby:

- Java

- LOL

当然也可以有这样的写法：

- Java

- LOL

可以简单理解为：[[Java,LOL]]
一个相对复杂的例子：

companies:

id: 1

price: 200W

id: 2

price: 500W

意思是companies属性是一个数组，每一个数组元素又是由id,name,price三个属性构成；
数组也可以使用流式(flow)的方式表示：

companies: [id: 1,name: company1,price: 200W,id: 2,name: company2,price: 500W]

常量

YAML中提供了多种常量结构，包括：整数，浮点数，字符串，NULL，日期，布尔，时间。下面使用一个例子来快速了解常量的基本使用：

boolean:

- TRUE #true,True都可以

- FALSE #false，False都可以

float:

- 3.14

- 6.8523015e+5 #可以使用科学计数法

int:

- 123

- 0b1010_0111_0100_1010_1110 #二进制表示

null:

nodeName: ‘node‘

parent: ~ #使用~表示null

string:

- 哈哈

- ‘Hello world‘ #可以使用双引号或者单引号包裹特殊字符

- newline

newline2 #字符串可以拆成多行，每一行会被转化成一个空格

date:

- 2018-02-17 #日期必须使用ISO 8601格式，即yyyy-MM-dd

datetime:

- 2018-02-17T15:02:31+08:00 #时间使用ISO 8601格式，时间和日期之间使用T连接，最后使用+代表时区

一些特殊符号

YAML中提供了很多特殊符号，在这里简单介绍常用的一些：
1，--- YAML可以在同一个文件中，使用---表示一个文档的开始；比如Springboot中profile的定义：

server:

address: 192.168.1.100

---

spring:

profiles: development

server:

address: 127.0.0.1

---

spring:

profiles: production

server:

address: 192.168.1.120

代表定义了两个profile，一个是development，一个production；也常常使用---来分割不同的内容，比如记录日志：

---

Time: 2018-02-17T15:02:31+08:00

User: ed

Warning:

This is an error message for the log file

---

Time: 2018-02-17T15:05:21+08:00

User: ed

Warning:

A slightly different error message.

2，... 和---配合使用，在一个配置文件中代表一个文件的结束：

---

time: 20:03:20

player: Sammy Sosa

action: strike (miss)

...

---

time: 20:03:47

player: Sammy Sosa

action: grand slam

...

相当于在一个yaml文件中连续写了两个yaml配置项。

3，!! YAML中使用!!做类型强行转换：

string:

- !!str 54321

- !!str true

相当于把数字和布尔类型强转为字符串。当然允许转型的类型很多，比如：

--- !!set

- Mark McGwire: 65

- Sammy Sosa: 63

- Ken Griffy: 58

将数组解析为set，简单理解，转化的内容就是：[Ken Griffy=58, Mark McGwire=65, Sammy Sosa=63]，重复的Sammy Sosa去掉；

4，>在字符串中折叠换行，| 保留换行符，这两个符号是YAML中字符串经常使用的符号，比如：

accomplishment: >

Mark set a major league

home run record in 1998.

stats: |

65 Home Runs

0.278 Batting Average

那么结果是：

stats=65 Home Runs

0.278 Batting Average,

即| 符号保留了换行符，而accomplishment的结果为：

accomplishment=Mark set a major league home run record in 1998.

即将换行符转化成了空格；要注意一点的是，每行的文本前一定要有一个空格。
|符号常见用于在YAML中配置HTML片段：

phraseTemplate: |

some template $msg

</p>

5，引用。重复的内容在YAML中可以使用&来完成锚点定义，使用*来完成锚点引用，例如：

hr:

- Mark McGwire

- &SS Sammy Sosa

rbi:

- *SS

- Ken Griffey

可以看到，在hr中，使用&SS为Sammy Sosa设置了一个锚点（引用），名称为SS，在rbi中，使用*SS完成了锚点使用，那么结果为：

rbi=[Sammy Sosa, Ken Griffey], hr=[Mark McGwire, Sammy Sosa]

我们也可以这样定义：

SS: &SS Sammy Sosa

hr:

- Mark McGwire

- *SS

rbi:

- *SS

- Ken Griffey

注意，不能独立的定义锚点，比如不能直接这样写：&SS Sammy Sosa；另外，锚点能够定义更复杂的内容，比如：

default: &default

- Mark McGwire

- Sammy Sosa

hr: *default

那么hr相当于引用了default的数组，注意，hr: *default要写在同一行。

6，合并内容。主要和锚点配合使用，可以将一个锚点内容直接合并到一个对象中。来看一个示例：

merge:

- &CENTER x: 1, y: 2

- &LEFT x: 0, y: 2

- &BIG r: 10

- &SMALL r: 1

sample1:

<<: *CENTER

r: 10

sample2:

<< : [ *CENTER, *BIG ]

other: haha

sample3:

<< : [ *CENTER, *BIG ]

r: 100

在merge中，定义了四个锚点，分别在sample中使用。
sample1中，<<: *CENTER意思是引用x: 1,y: 2，并且合并到sample1中，那么合并的结果为：sample1=r=10, y=2, x=1

sample2中，<<: [*CENTER, *BIG] 意思是联合引用x: 1,y: 2和r: 10，并且合并到sample2中，那么合并的结果为：sample2=other=haha, x=1, y=2, r=10

sample3中，引入了*CENTER, *BIG，还使用了r: 100覆盖了引入的r: 10，所以sample3值为：sample3=r=100, y=2, x=1

有了合并，我们就可以在配置中，把相同的基础配置抽取出来，在不同的子配置中合并引用即可。

以上示例均通过Snakeyaml测试通过

好啦，今天的Java学习就到这里了，想要了解更多资讯，等待下期哟

一步一步教你认识闭包

...什么用？为什么要用闭包？今天我们就带着这3个问题来一步一步认识闭包。闭包和函数紧密联系在一起，介绍闭包前有必要先介绍一些背景知识，诸如嵌套函数、变量的作用域等概念作用域作用域是程序运行时变量可被访问的... 查看详情

一步一步教你接入tinker热修复

官方文档：https://github.com/Tencent/tinker 下面我们按照官方文档和这个里面的tinker-sample-android来进行集成Tinker。注意说明，官方demo的使用https://github.com/Tencent/tinker/wiki/Tinker-接入指南里面的使用步骤详解,注意：官方demo导... 查看详情

一步一步教你ssm整合swagger(代码片段)

一：什么是swagger？?swagger是一款非常好用的写API文档的框架。其他自行百度二：ssm整合swagger？1：在maven的pom文件中引入依赖：（注意版本，否则会导致tomcat不能正常启动）<depende... 查看详情

一步一步教你如何制件zkeacms的扩展组件/插件

前言如果你还不知道ZKEACMS，不妨先了解一下。ASP.NETMVC开源建站系统ZKEACMS推荐，从此网站“拼”起来官方地址：http://www.zkea.net/zkeacms下载地址：https://github.com/SeriaWei/ASP.NET-MVC-CMS/releasesGitHub:https://github.com/SeriaWei/ASP. 查看详情

一步一步教你反向传播的样例

背景反向传播(Backpropagation)是训练神经网络最通用的方法之中的一个，网上有很多文章尝试解释反向传播是如何工作的，可是非常少有包括真实数字的样例，这篇博文尝试通过离散的数据解释它是如何工作的。Python实现的反向传... 查看详情

02~一步一步教你使用svn之svn的介绍

SVN的介绍一.学习SVN的主要内容的介绍1.基本操作:学习SVN有哪些基本操作2.服务器端的安装配置:SVN中必不可少的2个环境之一,会在下面的课程中介绍服务器如何去安装和配置3.客户端软件的使用:在实际开发中,使用客户端软件来操... 查看详情

一步一步教你将开源项目上传到jcenter

...来，希望能帮助到小伙伴们，现在觉得还是挺简单的。第一步：首先是注册，这就是我踩的最大的一个坑，导致我一天都没有上传成功。网上说的都是去jcenter的网站上注册就查看详情

一步一步教你在docker容器下使用mmdetection训练自己的数据集

这里不再介绍mmdetection的安装和配置，使用mmdetection较简单的方法是使用已安装mmdetection的docker容器。这样直接省去了安装mmdetection的过程，让重心放在模型训练上！如果你对docker和mmdetection还不是很熟悉，请自行搜索一下，本文... 查看详情

一步一步教你制作销售目标分析报告

　　前面的文章中我已经使用了一个入门案例动态销售报告来带领大家入门PowerBI的入门学习，基于动态销售报告，我可以在来进行细化处理销售目标表中的数据。本文的主题就是销售目标的分析。我们都知道销售目标是销售的... 查看详情

一步一步教你制作的第一个wordpress插件(代码片段)

💂个人网站:【海拥】【摸鱼小游戏】【神级源码资源网站】🤟风趣幽默的前端学习课程：👉28个案例趣学前端💅想寻找共同学习交流、摸鱼划水的小伙伴，请点击【摸鱼学习交流群】💬免费且实用... 查看详情

一步一步教你制作的第一个wordpress插件(代码片段)

2.一步一步教你使用pycharm运行起第一个django项目(代码片段)

下面步骤展示的是如何经过VirtualBox管理器，使得pycharm和ubuntu中的项目环境连接对应起来！如果你有属于自己的服务器，核心步骤都是大差不差的，甚至使用服务器步骤更简单许多哦！（但是要注意：... 查看详情

一步一步教你apache深入优化

Aache深入优化一、在Centos01上安装apache服务，在Centos02配置DNS服务器使用域名www.stz.com1、在Centos01上安装apache服务配置网站1）切换光盘2）挂载光盘解压源代码程序[root@centos01~]#mount/dev/cdrom/mnt/mount:/dev/sr0写保护，将以只读方式挂载[r... 查看详情

一步一步教你nginx地址重写

Nginx地址重写一、在Centos01上安装安装Nginx，设置网站根目录/www使用域名www.stz.com访问，Cent02上安装DNS服务解析www.stz.com和www.stz.com.cn以及www.stz.com.en域名1、在Centos01上安装nginx依赖1）挂载系统光盘配置本地yum仓库[root@centos01~]#mount/d... 查看详情

一步一步教你tomcat优化和发布动态网站

Tomcat性能优化一、安装Centos01上安装tomcat发布动态网站jpress使用www.Benet.com访问，配置虚拟机主机通过www.benet.com和www.accp.com访问不同的虚拟主机1）上传tomcat文件包[root@centos01~]#rz[root@centos01~]#lsanaconda-ks.cfg公共图片音乐apache-tomcat-8.5... 查看详情

一步一步教你nginx优化和防盗链

Nginx优化和防盗链一、在Centos01上安装Nginx，设置根目录/www/使用域名www.stz.con访问1、在Centos01上安装Nginx依赖程序1）挂载系统光盘配置本地yum仓库[root@centos01~]#mount/dev/cdrom/mnt/mount:/dev/sr0写保护，将以只读方... 查看详情

一步一步教你nginx平滑升级和动静分离

一、在Centos01安装Nginx服务，配置网站主页，使用www.szt.com访问Nginx1、在Centos01上安装Nginx依赖1）挂载光盘配置本地yum仓库[root@centos01~]#mount/dev/cdrom/mnt/mount:/dev/sr0写保护，将以只读方式挂载[root@centos01~]#rm-rf/etc/yum.repos.d/CentOS-*2）安... 查看详情