【Spring】SpringBoot 配置文件

一.配置文件作用

整个项目中所有重要的数据都是在配置文件中配置的，比如：

• 数据库的连接信息（包含用户名和密码的设置）；
• 项目的启动端口；
• 第三方系统的调用秘钥等信息；
• 用于发现和定位问题的普通用志和异常日志等。

如果没有配置信息，那么 Spring Boot 项目就不能连接和操作数据库，甚至是不能保存可以用于排查问题的关键日志，所以配置文件的作用是非常重要的

---

二.配置文件的格式

Spring Boot 配置文件主要分为以下两种格式

• .properties
• .yml

注意此处名字(application)和后缀都不能随意改

properties 类型的配置文件属于老版，而 yml 属于新版

1. properties 可以和 yml 一起存在于一个项目当中，当 properties 和 yml 一起存在一个项目中时，如果配置文件中出现了同样的配置，比如 properties 和 yml 中都配置了“server.port”，那么这个时候会以 properties 中的配置为主，也就是 .properties 配置文件的优先级最高，但加载完 .properties 文件之后，也会加载 .yml 文件的配置信息。

2. 虽然理论上来讲 .properties 可以和 .yml 共存，但实际的业务当中，通常会采取⼀种统⼀的配置文件格式，这样可以更好的维护（降低故障率）。

---

三.properties 配置文件说明

1.properties 基本语法

properties 是以键值的形式配置的，key 和 value 之间是以“=”连接的

# 配置项⽬端⼝号
server.port=8084
spring.datasource.url=jdbc:mysql://127.0.0.1:8181/testdb?characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=123456789

2.读取配置文件

如果在项目中，想要主动的读取配置文件中的内容，可以使用 @Value 注解来实现。
@Value 注解使用 “${}” 的格式读取，如下代码所示：

@Value("${server.port}")
private String port;

注意 @Value 注解的使用，一定是 @Value(“${xxxx}”)

properties 优点：

写法简单，不易出错，等号前面是 key 值，等号后面是 value 值。

properties 缺点：

写法不够灵活和简便，如以下数据库的配置，同样的前缀需要写多次:

想要解决这个问题，就可以使用 yml 配置文件的格式化

---

四.yml 配置文件说明

yml 是 YAML 是缩写，它的全称 Yet Another Markup Language 翻译成中文就是“另⼀种标记语言”。

yml 优点分析：

• yml 可读性高，写法简单、易于理解，它的语法和 JSON 语言类似
• yml 支持更多的数据类型，它可以简单表达清单（数组）、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件等。
• yml 支持更多的编程语言，它不止是在 Java 中可以使用，在 Golang、PHP、Python、Ruby、JavaScript 等等语言中也都可以

1.yml 基本语法

yml 是树形结构的配置文件，它的基础语法是 “key: value”，注意 key 和 value 之间使用英文冒汗加空格的方式组成的，其中的空格不可省略

一级目录：key: value

多级目录：

注意 n 级目录前面就有 n-1 个 tab 空格，每个命令后面也都需要空格再输入

所以此时 yml 和 properties 单从数据库这个方面来看就更加具有灵活性和简易性。

2.yml 使用进阶

1. yml 配置不同数据类型及 null

# 字符串
string.value: Hello

# 布尔值，true或false
boolean.value: true
boolean.value1: false

# 整数
int.value: 10
int.value1: 0b1010_0111_0100_1010_1110 # ⼆进制

# 浮点数
float.value: 3.14159
float.value1: 314159e-5 # 科学计数法

# Null，~代表null
null.value: ~

2. yml 配置读取

yml 读取配置的方式和 properties 相同，使用 @Value 注解即可

3. yml 字符串修饰符的问题

例如：

yml 配置如果使用了双引号修饰 value 值，那么 value 值中的特殊字符就会发挥自身的用途，比如 “\n” 就会实现换行的效果。

3.配置对象

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

student:
	id: 1
	name: Java
	age: 18

或者是使用行内写法（与上面的写法作用⼀致）：

student: {id: 1,name: Java,age: 18}

4.yml 配置对象

这个时候就不能用 @Value 来读取配置中的对象了，此时要使用另⼀个注解
@ConfigurationProperties 来读取，具体实现如下

新创一个类，同级或者下一级

注意：以上代码中的 getter 和 setter 方法不能省略。

1. 读取配置文件的实体类不能没有 setter 方法(如果没有 setter 方法启动就报错了)，@ConfigurationProperties 注解在实现时是通过setter将配置文件中的内容赋值给字段的。

2. @ConfigurationProperties 需要配合注册注解，如 @Component 注解一起使用。

5.yml读取集合

1. 配置文件中配置集合

• 原始写法

• 行内写法

2. 读取配置文件中的集合

注意此处 LIst 后的名字不能修改，是固定的

补充：

配置文件中的乱码问题：
 
在 properties 配置文件中，无论是注解还是配置，只要是使用了中文，下一次打开就会成为 “?” 乱码，且是不可逆的，无法还原，所以此处就得先设置好 UTF-8。
 

 

 

---

五.设置不同环境的配置文件

多平台的配置文件设置:
- 开发环境的配置文件
- 测试环境的配置文件
- 生产环境的配置文件
…

1、创建不同环境的配置文件：

• application-dev.yml
• application-prod.yml

像第一个格式，除了 dev 可以改变，其余的均不可变

设置配置文件的运行环境：

spring.profiles.active=dev

---

六.properties VS yml

• properties 是以 key=value 的形式配置的键值类型的配置文件，而 yml 使用的是类似 json 格式的树形配置方式进行配置的，yml 层级之间使用换行缩进的方式配置，key 和 value 之间使用“: ”英文冒号加空格的方式设置，并且空格不可省略。
• properties 为早期并且默认的配置文件格式，但其配置存在⼀定的冗余数据，使用 yml 可以很好的解决数据冗余的问题
• yml 通用性更好，支持更多语言，如 Java、Go、Python 等，如果是云服务器开发，可以使用⼀份配置文件作为 Java 和 Go 的共同配置文件。
• yml 支持更多的数据类型。