SpringBoot配置文件（学习笔记）

野性酷女 2024-04-23 15:32 57阅读 0赞

**目录**

一、配置文件概述

配置文件的作用

配置文件的格式

二、application.properties 配置文件

基本语法

读取配置文件

三、application.yml 配置文件

基本语法

读取yml中的配置

1、yml配置的简单读取

2、读取yml 配置中不同数据类型及 null编辑

2、读取yml配置文件的补充

yml配置对象

yml配置集合

四、Properties VS yml 总结和补充

关于properites的乱码问题

--------------------

## 一、配置文件概述 ##

### 配置文件的作用 ###

> 整个项目中所有重要的数据都是在配置文件中配置的。  
> 比如：
> 
> **1、数据库的连接信息（包含用户名和密码的设置）  
> 2、项目的启动端口  
> 3、第三方系统的调用密钥等信息  
> 4、用于发现和定位问题的普通日志 和 异常日志 等。  
> 5、还可以配置 日志的级别（规定只显示达到某个级别的日志），以及日志的持久化存储**。
> 
> 想象一下：  
> 如果没有配置信息，那么 Spring Boot 项目就不能连接和操作数据库，甚至是不能保存可以用于排查问题的关键日志，所以配置文件的作用是非常重要的  
>

>   
>    
> 配置文件还有一个优点：
> 
> 配置文件可以设置 开发环境 和 测试境，两个配置文件。  
> 然后呢，在运行打包的时候，通过修改一个变量，就可以指定 当前项目 “走”哪一个配置文件。  
> **所以，配置文件之间是可以并存的！  
> 意思就是：  
> 可以将两个，或两个以上的配置文件（开发的，测试的，运维的），项目上线的时候，我们只需要改一个参数，改一个名字。**  
> 然后，项目中所有的内容，全部都会走 另一个配置文件。非常方便！  
> 到时候，会给你们演示一下。
> 
> 另外，再补充一点。  
> 配置文件的分类，里面的内容可以分为两个类：
> 
>  *  1、系统级别的
>  *  2、自定义级别的

### 配置文件的格式 ###

> Spring Boot 配置⽂件主要分为以下两种格式：
> 
>  *  1、.properties
>  *  2、.yml
> 
> 【文件的后缀代表着文件的格式；配置文件也是如此！！！】
> 
> 至于为什么要有两种格式？
> 
> 这两者之间的关系，就像前面讲Bean 作用域 和 生命周期中的 @PostConstruct 与 init- method 之间的关系一样。  
> 两者的功能是一样的，但是！是来自于 两个不同时间段 的 产物。  
>    
> 最早出现的配合文件格式是 .properties。  
> 然后，在后期的使用中发现： properties 存在着一些缺陷。  
> 那么，自然就会产生一个想法：properties 该怎么去优化？  
> 于是，.yml 格式的配置文件，就诞生了。  
> 这就和 maven 和 gradle 之间的关系一样。  
> gradle 是 maven 的升级版。  
> 我们的 .yml格式的配置文件，就是 .properties格式配置文件 的 升级版。

> 前面讲过：一个项目中，可以存在多个配置文件。  
> 即：配置文件之间是可以共存的！
> 
> > 也就是说：我们可以直接在项目中传建其他的配置文件，格式可以不同

## 二、application.properties 配置文件 ##

###  ###

### 基本语法 ###

> ![d69db67304cd4602ba19e85a8a36b6e0.png][]
> 
> 而且！  
> 在填写完后面的 value 值 之后，也不能加上一个空格。  
> 会出事！！！  
> 比如：  
> 设置端口号：
> 
> ![f6aa2a630d2f4ede93826db5a995fb06.png][]
> 
> **另外，我们还可以自定义键值对。【上面的是系统级别的配置】**
> 
> ![33fed19f262248f58fb583362e31f8bf.png][]
> 
>  因为我们已经把项目的端口号改成了9090，所有你再启动项目的时候端口号就变了
> 
> ![55738b09e283414fae217061d2af625f.png][]

更多配置文件详见：[官方文档][Link 1]

![8172079565fe4beb88f12118418a1a93.png][]

### 读取配置文件 ###

> 到了 Spring Boot 时代，几乎所有的功能，都可以通过 注解来搞定。  
> 读取配置文件也是一样的，  
> 可以使⽤ @Value 注解来实现。  
> @Value 注解使⽤“$\{\}”的格式读取.
> 
> ![1d931ea398554f4d9cd1a215773f855c.png][]
> 
> 在配置文件中用户可自定义各自类型的数据![e035c1faba064f45b7583b563ce498b6.png][]

--------------------

## 三、application.yml 配置文件 ##

> yml 是 YAML 是缩写，它的全称 Yet Another Markup Language 翻译成中⽂就是“另⼀种标记语⾔”。  
>    
> yml 是⼀个可读性⾼，易于理解，⽤来表达数据序列化的格式。它的语法和其他⾼级语⾔类似（与 json 格式类似，键值对之间使用冒号+空格，进行分隔）**，并且可以简单表达清单（数组）、散列表，对象，标量，布尔，int等数据形态，甚至连 null 都可以设置！！！  
>  **  
> 它使⽤空⽩符号缩进和⼤量依赖外观的特⾊，特别适合⽤来表达或编辑数据结构、各种配置⽂件等。  
>    
> **yml 最⼤的优势是可以跨语⾔，不⽌是 Java 中可以使⽤。  
> golang、python 都可以使⽤ yml 作为配置⽂件。**  
>

> 总结下来， yml 配置文件一共有三个优点：  
> 1、写法简单  
> 2、支持多种数据类型  
> 3、支持跨语言
> 
> > **上述这三个优点，都是 properties 配置文件所不具备的。**

### 基本语法 ###

> **yml 是树形结构的配置⽂件，它的基础语法是“key: value”，注意 key 和 value 之间使⽤英⽂冒号加空格的⽅式组成的，其中的空格不可省略。**
> 
> 上面我们说了一个项目中，可以存在多个配置文件。
> 
> 那么我们可以直接在项目中传建其他的配置文件，格式可以不同

![d35b3c0bfa4a4aceb4b6c971aa3d9e7c.png][]

**当一个项目的某个配置，出现在两种格式的配置文件中时，那么配置项会以properties 为主（忽略 yml 中的配置）。**

如下图所示：

![6686a2ecc4d542d89aac76271fb76f15.png][]

但其实与上面的application.properties相比，.yml配置文件还是挺好用的。

![5bad5449ae2b483386b7f2971dd20209.png][]

--------------------

### 读取yml中的配置 ###

#### 1、yml配置的简单读取 ####

这个和对properitices的读取是相同

![e3cb0e979e8745678a695cf9f5413d83.png][]

#### 2、读取yml 配置中不同数据类型及 null   ![577ac064a9c14acdb5660c8d5e16f6e2.png][] ####

--------------------

#### 2、读取yml配置文件的补充 ####

**先来看一个栗子?**

![1dbfb59f276645deac7a699137255329.png][]

![95ef623e2e704ebeb5d2b878049415ea.png][]

--------------------

### yml配置对象 ###

我们可以在 yml 中配置对象，如下配置：

![fe5687a57106483ca5e274f71f2fb7ca.png][]

那么怎么读取我们yml中的配置文件呢？

> 可能你会说：还用
> 
>     @Value("${mykey.key}")不行吗？
> 
> 答案是不行，我们要用的专门的类做这一件事
> 
> ![0ba25939ac924cb5a81cc54fa98a3fa9.png][]  
>  ![47bf4829e1264c1d9cc1d25361230619.png][]

### yml配置集合 ###

首先我们在yml配置文件里把集合配置上

![4910ba7366294d989f7e6ddec5ddedb8.png][]

那么接下来我们看看是怎么读取集合的

> **集合的读取和对象⼀样，也是使⽤ @ConfigurationProperties 来读取的，创建一个类并在该类中设置一个集合属性，具体实现如下：**

![6d737ef409e4423181c97491902654eb.png][]

## 四、Properties VS yml 总结和补充 ##

> 1、properties 是以 key=value 的形式配置的键值类型的配置⽂件.  
> ⽽ yml 使⽤的是类似 json 格式的树形配置⽅式进⾏配置的.  
> yml 层级之间使⽤换⾏缩进的⽅式配置，key 和 value 之间使⽤“: ”（英⽂）冒号加空格的⽅式设置，并且空格不可省略。  
>    
> 2**、properties 为早期并且默认的配置⽂件格式，但其配置存在⼀定的冗余数据，使⽤ yml 可以很好的解决数据冗余的问题。  
>  **  
> 3、yml 通⽤性更好，⽀持更多语⾔，如 Java、Go、Python 等，如果是云服务器开发，可以使⽤⼀份配置⽂件作为 Java 和 Go 的共同配置⽂件。  
>    
> 4、yml 虽然可以和 properties 共存，但⼀个项⽬中建议使⽤统⼀的配置类型⽂件。
> 
> **当一个项目的某个配置，出现在两种格式的配置文件中时，那么配置项会以properties 为主（忽略 yml 中的配置）。**

### 关于properites的乱码问题 ###

这是因为 application.properties 是属于早期的配置文件，而早期的 配置文件是不支持中文的。  
而 yml 是天生就支持中文的（utf8）。  
要想 application.properties 支持中文，需要进行配置。

> ![99760efa485748178d496e0288146876.png][]

[d69db67304cd4602ba19e85a8a36b6e0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/e21b50ba425142baa98f7a98d8ca827d.png
[f6aa2a630d2f4ede93826db5a995fb06.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/454fd6af54be45358ce4d0ad758d0584.png
[33fed19f262248f58fb583362e31f8bf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/99427ef00c3148ab83455068ec57ea2c.png
[55738b09e283414fae217061d2af625f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/b545f16dc7674202a44081ce818b96dc.png
[Link 1]: https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties.data
[8172079565fe4beb88f12118418a1a93.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/ca95974153bc40fba1d709e1b57944bd.png
[1d931ea398554f4d9cd1a215773f855c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/9905c19e51544be78eb0df20cabbd789.png
[e035c1faba064f45b7583b563ce498b6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/813e1fbbaa004cb2946fd13c9477fcf6.png
[d35b3c0bfa4a4aceb4b6c971aa3d9e7c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/f5361a02ca5b4033b61234ba462334fb.png
[6686a2ecc4d542d89aac76271fb76f15.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/c803f91ae3834ce49a4c4e58dfad4104.png
[5bad5449ae2b483386b7f2971dd20209.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/907229ae94154234aceeac456d8928a3.png
[e3cb0e979e8745678a695cf9f5413d83.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/569fa69f80854eb59719b0c6f105193b.png
[577ac064a9c14acdb5660c8d5e16f6e2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/7906af0f6bc1439ebc2203f105f7943f.png
[1dbfb59f276645deac7a699137255329.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/8999696d25334e0ebb244412920b54b6.png
[95ef623e2e704ebeb5d2b878049415ea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/c87851f0a2f748d0a0db4b746aee0454.png
[fe5687a57106483ca5e274f71f2fb7ca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/044f1a313cf7445f81a483788c3dbbb5.png
[0ba25939ac924cb5a81cc54fa98a3fa9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/ca72dc928bb844b68715daa1ba816a22.png
[47bf4829e1264c1d9cc1d25361230619.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/30f73f757bac47bda66dc08d276fe462.png
[4910ba7366294d989f7e6ddec5ddedb8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/9f66e0dfeafa491cb1366d02402c8ee9.png
[6d737ef409e4423181c97491902654eb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/6ed9a31a82d2453484bc94fc4f9ca5d5.png
[99760efa485748178d496e0288146876.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/23/96cdcc3ab76d4ce9a81c22f9b684755a.png