六、语法介绍
YAML(YAML Ain't Markup Language),一种数据序列化格式。具有容易阅读、容易与脚本语言交互、以数据为核心,重数据轻格式的特点。常见的文件扩展名有两种:
.yml格式(主流)
.yaml格式
对于文件自身在书写时,具有严格的语法格式要求,具体如下:
大小写敏感
属性层级关系使用多行描述,每行结尾使用冒号结束
使用缩进表示层级关系,同层级左侧对齐,只允许使用空格(不允许使用Tab键)
属性值前面添加空格(属性名与属性值之间使用冒号+空格作为分隔)
#号 表示注释
上述规则不要死记硬背,按照书写习惯慢慢适应,并且在Idea下由于具有提示功能,慢慢适应着写格式就行了。核心的一条规则要记住,数据前面要加空格与冒号隔开
下面列出常见的数据书写格式,熟悉一下
boolean: TRUE #TRUE,true,True,FALSE,false,False均可 float: 3.14 #6.8523015e+5 #支持科学计数法 int: 123 #0b1010_0111_0100_1010_1110 #支持二进制、八进制、十六进制 null: ~ #使用~表示null string: HelloWorld #字符串可以直接书写 string2: "Hello World" #可以使用双引号包裹特殊字符 date: 2018-02-17 #日期必须使用yyyy-MM-dd格式 datetime: 2018-02-17T15:02:31+08:00 #时间和日期之间使用T连接,最后使用+代表时区
此外,yaml格式中也可以表示数组,在属性名书写位置的下方使用减号作为数据开始符号,每行书写一个数据,减号与数据间空格分隔
subject: - Java - 前端 - 大数据 enterprise: name: itcast age: 16 subject: - Java - 前端 - 大数据 likes: [王者荣耀,刺激战场] #数组书写缩略格式 users: #对象数组格式一 - name: Tom age: 4 - name: Jerry age: 5 users: #对象数组格式二 - name: Tom age: 4 - name: Jerry age: 5 users2: [ { name:Tom , age:4 } , { name:Jerry , age:5 } ] #对象数组缩略格式
现在我们已经知道了yaml具有严格的数据格式要求,并且已经可以正确的书写yaml文件了,那这些文件书写后其实是在定义一些数据。这些数据时给谁用的呢?大部分是SpringBoot框架内部使用,但是如果我们想配置一些数据自己使用,能不能用呢?答案是可以的,那如何读取yaml文件中的数据呢?
七、数据读取
对于yaml文件中的数据,其实你就可以想象成这就是一个小型的数据库,里面保存有若干数据,每个数据都有一个独立的名字,如果你想读取里面的数据,肯定是支持的,下面就介绍3种读取数据的方式
为了方便测试,先看看我在配置文件中写的测试数据内容
1、读取单一数据
yaml中保存的单个数据,可以使用Spring中的注解直接读取,使用@Value可以读取单个数据,属性名引用方式:${一级属性名.二级属性名……}
写一个代码测试一下:
@RestController @RequestMapping("/books") public class BookController { //yml读取单一数据 @Value("${country}") private String country; //对象的某个属性值 @Value("${user1.name}") private String name; //普通数组的某个值 @Value("${hobby[0]}") private String hobby; //对象数组的某个属性的值 @Value("${users[0].name}") private String age; @GetMapping("/getBooks") public String getBooks() { System.out.println("SpringBoot 正在运行~"); System.out.println("单一数据country是:" + country); System.out.println("对象的某个属性值是:" + name); System.out.println("普通数组的某个值是:" + hobby); System.out.println("对象数组的某个属性的值是:" + age); return "Hello,SpringBoot is running"; } }
运行结果完全正确!
2、读取全部数据
读取单一数据可以解决读取数据的问题,但是如果定义的数据量过大,这么一个一个书写肯定会累死人的,SpringBoot提供了一个对象,能够把所有的数据都封装到这一个对象中,这个对象叫做Environment,使用自动装配注解可以将所有的yaml数据封装到这个对象中
@RestController @RequestMapping("/books") public class BookController { @Autowired private Environment environment; @GetMapping("/getBooks") public String getBooks() { System.out.println("SpringBoot 正在运行~"); System.out.println("单一数据country是:" + environment.getProperty("country")); System.out.println("对象的某个属性值是:" + environment.getProperty("user1.name")); System.out.println("普通数组的某个值是:" + environment.getProperty("hobby[0]")); System.out.println("对象数组的某个属性的值是:" + environment.getProperty("users[0].age")); return "Hello,SpringBoot is running"; } }
运行结果也是完全正确的!
注意:Environment对应的包不要导错了。是org.springframework.core.env.Environment包下的
3、读取对象数据
单一数据读取书写比较繁琐,全数据封装又封装的太厉害了,每次拿数据还要一个一个的getProperties(),总之用起来都不是很舒服。由于Java是一个面向对象的语言,很多情况下,我们会将一组数据封装成一个对象。SpringBoot也提供了可以将一组yaml对象数据封装一个Java对象的操作
首先定义一个对象,并将该对象纳入Spring管控的范围,也就是定义成一个bean,然后使用注解@ConfigurationProperties指定该对象加载哪一组yaml中配置的信息。
@RestController @RequestMapping("/books") public class BookController { @Autowired private User1 user1; @GetMapping("/getBooks") public String getBooks() { System.out.println("SpringBoot 正在运行~"); System.out.println(user1); return "Hello,SpringBoot is running"; } }
这个@ConfigurationProperties必须告诉他加载的数据前缀是什么,这样当前前缀下的所有属性就封装到这个对象中。记得数据属性名要与对象的变量名一一对应啊,不然没法封装。其实以后如果你要定义一组数据自己使用,就可以先写一个对象,然后定义好属性,下面到配置中根据这个格式书写即可。
运行结果依然是正确的!
4、数据引用
在书写yaml数据时,经常出现如下现象,比如很多个文件都具有相同的目录前缀
center: dataDir: /usr/local/fire/data tmpDir: /usr/local/fire/tmp logDir: /usr/local/fire/log msgDir: /usr/local/fire/msgDir
或者
center: dataDir: D:/usr/local/fire/data tmpDir: D:/usr/local/fire/tmp logDir: D:/usr/local/fire/log msgDir: D:/usr/local/fire/msgDir
这个时候就可以使用引用格式来定义数据,其实就是搞了个变量名,然后引用变量了,格式如下:
baseDir: /usr/local/fire dataDir: ${baseDir}/data tmpDir: ${baseDir}/tmp logDir: ${baseDir}/log msgDir: ${baseDir}/msgDir
注意事项:在书写字符串时,如果需要使用转义字符,需要将数据字符串使用双引号包裹起来
lesson: "Spring\tboot\nlesson"
小结
在配置文件中可以使用${属性名}方式引用属性值
如果属性中出现特殊字符,可以使用双引号包裹起来作为字符解析
八、总结
SpringBoot配置文件的使用也同样简化了开发的步骤,非常重要,我们要熟练使用。博主正在积极准备SpringBoot整合第三方技术相关的博客文章,喜欢的话,可以给博主一个赞哦~~