SpringBoot获取yml文件中数据

水深无声 2023-10-08 22:12 66阅读 0赞

## SpringBoot获取yml文件中数据 ##

#### 1.在Idea中隐藏指定文件/文件夹 ####

设置方式如下。

**步骤①**：打开设置，【Files】→【Settings】

![在这里插入图片描述][24fab1b2644c405fbbdb8cea928ddcdb.png_pic_center]

**步骤②**：打开文件类型设置界面，【Editor】→【File Types】→【Ignored Files and Folders】，忽略文件或文件夹显示

![在这里插入图片描述][703407284c48436d9c545732cb2f4f18.png_pic_center]

**步骤③**：添加你要隐藏的文件名称或文件夹名称，可以使用\*号通配符，表示任意，设置完毕即可

到这里就做完了，其实就是Idea的一个小功能

**总结**

1.  Idea中隐藏指定文件或指定类型文件
    
    1.  【Files】→【Settings】
    2.  【Editor】→【File Types】→【Ignored Files and Folders】
    3.  输入要隐藏的名称，支持\*号通配符
    4.  回车确认添加

### 2.SpringBoot基础配置 ###

#### 2-1.属性配置 ####

SpringBoot通过配置文件application.properties就可以修改默认的配置，那咱们就先找个简单的配置下手，当前访问tomcat的默认端口是8080，好熟悉的味道，但是不便于书写，我们先改成80，通过这个操作来熟悉一下SpringBoot的配置格式是什么样的

![在这里插入图片描述][238b493fadca4a26bf08a49c22979ea4.png_pic_center]

那该如何写呢？properties格式的文件书写规范是key=value

name=itheima

这个格式肯定是不能颠覆的，那就尝试性的写就行了，改端口，写port。当你输入port后，神奇的事情就发生了，这玩意儿带提示，太好了

![在这里插入图片描述][14254eb7f5a443799674d05d40893d03.png_pic_center]

根据提示敲回车，输入80端口，搞定

server.port=80

**总结**

1.  SpringBoot默认配置文件是application.properties

**关闭运行日志图表（banner)**

spring.main.banner-mode=off

**设置运行日志的显示级别**

logging.level.root=debug

打开SpringBoot的官网，找到SpringBoot官方文档，打开查看附录中的Application Properties就可以获取到对应的配置项了，网址奉上：[SpringBoot的官网][SpringBoot]

能写什么的问题解决了，再来说第二个问题，这个配置项和什么有关。在pom中注释掉导入的spring-boot-starter-web，然后刷新工程，你会发现配置的提示消失了。闹了半天是设定使用了什么技术才能做什么配置。也合理，不然配置的东西都没有使用对应技术，配了也是白配。

**温馨提示**

所有的starter中都会依赖下面这个starter，叫做spring-boot-starter。这个starter是所有的SpringBoot的starter的基础依赖，里面定义了SpringBoot相关的基础配置，关于这个starter我们到开发应用篇和原理篇中再深入讲解。

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>2.5.4</version>
        <scope>compile</scope>
    </dependency>

**总结**

1.  SpringBoot中导入对应starter后，提供对应配置属性
2.  书写SpringBoot配置采用关键字+提示形式书写

#### 2-2.配置文件分类 ####

现在已经能够进行SpringBoot相关的配置了，但是properties格式的配置写起来总是觉得看着不舒服，所以就期望存在一种书写起来更简便的配置格式提供给开发者使用。有吗？还真有，SpringBoot除了支持properties格式的配置文件，还支持另外两种格式的配置文件。分别如下:

*  properties格式
 *  yml格式
 *  yaml格式
    
    一看到全新的文件格式，各位小伙伴肯定想，这下又要学习新的语法格式了。怎么说呢？从知识角度来说，要学，从开发角度来说，不用学。为什么呢？因为SpringBoot的配置在Idea工具下有提示啊，跟着提示走就行了。下面列举三种不同文件格式配置相同的属性范例，先了解一下
 *  application.properties（properties格式）

server.port=80

*  application.yml（yml格式）

server:
      port: 81

*  application.yaml（yaml格式）

server:
      port: 82

仔细看会发现yml格式和yaml格式除了文件名后缀不一样，格式完全一样，是这样的，yml和yaml文件格式就是一模一样的，只是文件后缀不同，所以可以合并成一种格式来看。那对于这三种格式来说，以后用哪一种比较多呢？记清楚，以后基本上都是用yml格式的，本课程后面的所有知识都是基于yml格式来制作的，以后在企业开发过程中用这个格式的机会也最多，一定要重点掌握。

**总结**

1.  SpringBoot提供了3种配置文件的格式
    
     *  properties（传统格式/默认格式）
     *  **yml**（主流格式）
     *  yaml

**思考**

现在我们已经知道使用三种格式都可以做配置了，好奇宝宝们就有新的灵魂拷问了，万一我三个都写了，他们三个谁说了算呢？打一架吗？

##### 配置文件优先级 #####

其实三个文件如果共存的话，谁生效说的就是配置文件加载的优先级别。先说一点，虽然以后这种情况很少出现，但是这个知识还是可以学习一下的。我们就让三个配置文件书写同样的信息，比如都配置端口，然后我们让每个文件配置的端口号都不一样，最后启动程序后看启动端口是多少就知道谁的加载优先级比较高了。

*  application.properties（properties格式）

server.port=80

*  application.yml（yml格式）

server:
      port: 81

*  application.yaml（yaml格式）

server:
      port: 82

启动后发现目前的启动端口为80，把80对应的文件删除掉，然后再启动，现在端口又改成了81。现在我们就已经知道了3个文件的加载优先顺序是什么

application.properties  >  application.yml  >  application.yaml

虽然得到了一个知识结论，但是我们实际开发的时候还是要看最终的效果为准。也就是你要的最终效果是什么自己是明确的，上述结论只能帮助你分析结论产生的原因。这个知识了解一下就行了，因为以后同时写多种配置文件格式的情况实在是较少。

最后我们把配置文件内容给修改一下

*  application.properties（properties格式）

server.port=80
    spring.main.banner-mode=off

*  application.yml（yml格式）

server:
      port: 81
    logging: 
      level: 
        root: debug

*  application.yaml（yaml格式）

server:
      port: 82

我们发现不仅端口生效了，最终显示80，同时其他两条配置也生效了，看来每个配置文件中的项都会生效，只不过如果多个配置文件中有相同类型的配置会优先级高的文件覆盖优先级的文件中的配置。如果配置项不同的话，那所有的配置项都会生效。

**总结**

1.  配置文件间的加载优先级 properties（最高）> yml > yaml（最低）
2.  不同配置文件中相同配置按照加载优先级相互覆盖，不同配置文件中不同配置全部保留

##### **自动提示功能消失解决方案** #####

**步骤①**：打开设置，【Files】→【Project Structure…】

![在这里插入图片描述][2988305056b545bfa28568be1453cedd.png_pic_center]

**步骤②**：在弹出窗口中左侧选择【Facets】，右侧选中Spring路径下对应的模块名称，也就是你自动提示功能消失的那个模块

![在这里插入图片描述][6fb0167b587542979d93be324405c6f7.png_pic_center]

**步骤③**：点击Customize Spring Boot按钮，此时可以看到当前模块对应的配置文件是哪些了。如果没有你想要称为配置文件的文件格式，就有可能无法弹出提示  
![在这里插入图片描述][7ab38a576b0a482e80badefe88f65edd.png_pic_center]

**步骤④**：选择添加配置文件，然后选中要作为配置文件的具体文件就OK了

![在这里插入图片描述][ba8661eb6ff942a2a40c6635a615a26d.png_pic_center]

到这里就做完了，其实就是Idea的一个小功能

![在这里插入图片描述][0595c60648464e10837924648391fa20.png_pic_center]

**总结**

1.  指定SpringBoot配置文件
    
     *  Setting → Project Structure → Facets
     *  选中对应项目/工程
     *  Customize Spring Boot
     *  选择配置文件

#### 2-3.yaml文件 ####

SpringBoot的配置以后主要使用yml结尾的这种文件格式，并且在书写时可以通过提示的形式加载正确的格式。但是这种文件还是有严格的书写格式要求的。下面就来说一下具体的语法格式。

YAML（YAML Ain’t Markup Language），一种数据序列化格式。具有容易阅读、容易与脚本语言交互、以数据为核心，重数据轻格式的特点。常见的文件扩展名有两种：

*  .yml格式（主流）
 *  .yaml格式
    
    对于文件自身在书写时，具有严格的语法格式要求，具体如下：

1.  大小写敏感
2.  属性层级关系使用多行描述，**每行结尾使用冒号结束**
3.  使用缩进表示层级关系，同层级左侧对齐，只允许使用空格（不允许使用Tab键）
4.  属性值前面添加空格（属性名与属性值之间使用冒号+空格作为分隔）
5.  \#号 表示注释

上述规则不要死记硬背，按照书写习惯慢慢适应，并且在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 } ]	#对象数组缩略格式

**总结**

1.  yaml语法规则
    
     *  大小写敏感
     *  属性层级关系使用多行描述，每行结尾使用冒号结束
     *  使用缩进表示层级关系，同层级左侧对齐，只允许使用空格（不允许使用Tab键）
     *  属性值前面添加空格（属性名与属性值之间使用冒号+空格作为分隔）
     *  \#号 表示注释
2.  注意属性名冒号后面与数据之间有一个**空格**
3.  字面值、对象数据格式、数组数据格式

**思考**

现在我们已经知道了yaml具有严格的数据格式要求，并且已经可以正确的书写yaml文件了，那这些文件书写后其实是在定义一些数据。这些数据时给谁用的呢？大部分是SpringBoot框架内部使用，但是如果我们想配置一些数据自己使用，能不能用呢？答案是可以的，那如何读取yaml文件中的数据呢？咱们下一节再说。

#### 2-4.yaml数据读取 ####

对于yaml文件中的数据，其实你就可以想象成这就是一个小型的数据库，里面保存有若干数据，每个数据都有一个独立的名字，如果你想读取里面的数据，肯定是支持的，下面就介绍3种读取数据的方式

##### 读取单一数据 #####

yaml中保存的单个数据，可以使用Spring中的注解直接读取，使用@Value可以读取单个数据，属性名引用方式：**$\{一级属性名.二级属性名……\}**

![在这里插入图片描述][3714ef400068428998390b5d6e44dba1.png_pic_center]

记得使用@Value注解时，要将该注入写在某一个指定的Spring管控的bean的属性名上方。现在就可以读取到对应的单一数据行了

**总结**

1.  使用@Value配合SpEL读取单个数据
2.  如果数据存在多层级，依次书写层级名称即可

##### 读取全部数据 #####

读取单一数据可以解决读取数据的问题，但是如果定义的数据量过大，这么一个一个书写肯定会累死人的，SpringBoot提供了一个对象，能够把所有的数据都封装到这一个对象中，这个对象叫做Environment，使用自动装配注解可以将所有的yaml数据封装到这个对象中

![在这里插入图片描述][423ee21ca0f44a2c8d595c05dcab1d36.png_pic_center]

数据封装到了Environment对象中，获取属性时，通过Environment的接口操作进行，具体方法时getProperties（String），参数填写属性名即可

**总结**

1.  使用Environment对象封装全部配置信息
2.  使用@Autowired自动装配数据到Environment对象中

##### 读取对象数据 #####

单一数据读取书写比较繁琐，全数据封装又封装的太厉害了，每次拿数据还要一个一个的getProperties（）,总之用起来都不是很舒服。由于Java是一个面向对象的语言，很多情况下，我们会将一组数据封装成一个对象。SpringBoot也提供了可以将一组yaml对象数据封装一个Java对象的操作

首先定义一个对象，并将该对象纳入Spring管控的范围，也就是定义成一个bean，然后使用注解@ConfigurationProperties指定该对象加载哪一组yaml中配置的信息。  
![在这里插入图片描述][27a4e0183f5e433a8d7a3126c121f10f.png_pic_center]

这个@ConfigurationProperties必须告诉他加载的数据前缀是什么，这样当前前缀下的所有属性就封装到这个对象中。记得数据属性名要与对象的变量名一一对应啊，不然没法封装。其实以后如果你要定义一组数据自己使用，就可以先写一个对象，然后定义好属性，下面到配置中根据这个格式书写即可。

![在这里插入图片描述][dad66f46f1404e78b36236632578617b.png_pic_center]

**温馨提示**

细心的小伙伴会发现一个问题，自定义的这种数据在yaml文件中书写时没有弹出提示，是这样的，咱们到原理篇再揭秘如何弹出提示。

**总结**

1.  使用@ConfigurationProperties注解绑定配置信息到封装类中
2.  封装类需要定义为Spring管理的bean，否则无法进行属性注入

##### yaml文件中的数据引用 #####

如果你在书写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
    	center:
        dataDir: ${baseDir}/data
        tmpDir: ${baseDir}/tmp
        logDir: ${baseDir}/log
        msgDir: ${baseDir}/msgDir

还有一个注意事项，在书写字符串时，如果需要使用转义字符，需要将数据字符串使用双引号包裹起来

lesson: "Spring\tboot\nlesson"

**总结**

1.  在配置文件中可以使用$\{属性名\}方式引用属性值
2.  如果属性中出现特殊字符，可以使用双引号包裹起来作为字符解析

[24fab1b2644c405fbbdb8cea928ddcdb.png_pic_center]: https://img-blog.csdnimg.cn/24fab1b2644c405fbbdb8cea928ddcdb.png#pic_center
[703407284c48436d9c545732cb2f4f18.png_pic_center]: https://img-blog.csdnimg.cn/703407284c48436d9c545732cb2f4f18.png#pic_center
[238b493fadca4a26bf08a49c22979ea4.png_pic_center]: https://img-blog.csdnimg.cn/238b493fadca4a26bf08a49c22979ea4.png#pic_center
[14254eb7f5a443799674d05d40893d03.png_pic_center]: https://img-blog.csdnimg.cn/14254eb7f5a443799674d05d40893d03.png#pic_center
[SpringBoot]: https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties
[2988305056b545bfa28568be1453cedd.png_pic_center]: https://img-blog.csdnimg.cn/2988305056b545bfa28568be1453cedd.png#pic_center
[6fb0167b587542979d93be324405c6f7.png_pic_center]: https://img-blog.csdnimg.cn/6fb0167b587542979d93be324405c6f7.png#pic_center
[7ab38a576b0a482e80badefe88f65edd.png_pic_center]: https://img-blog.csdnimg.cn/7ab38a576b0a482e80badefe88f65edd.png#pic_center
[ba8661eb6ff942a2a40c6635a615a26d.png_pic_center]: https://img-blog.csdnimg.cn/ba8661eb6ff942a2a40c6635a615a26d.png#pic_center
[0595c60648464e10837924648391fa20.png_pic_center]: https://img-blog.csdnimg.cn/0595c60648464e10837924648391fa20.png#pic_center
[3714ef400068428998390b5d6e44dba1.png_pic_center]: https://img-blog.csdnimg.cn/3714ef400068428998390b5d6e44dba1.png#pic_center
[423ee21ca0f44a2c8d595c05dcab1d36.png_pic_center]: https://img-blog.csdnimg.cn/423ee21ca0f44a2c8d595c05dcab1d36.png#pic_center
[27a4e0183f5e433a8d7a3126c121f10f.png_pic_center]: https://img-blog.csdnimg.cn/27a4e0183f5e433a8d7a3126c121f10f.png#pic_center
[dad66f46f1404e78b36236632578617b.png_pic_center]: https://img-blog.csdnimg.cn/dad66f46f1404e78b36236632578617b.png#pic_center