1.配置⽂件作用

首先我们要知道什么是spring的配置文件（配置文件本质上是包含成功操作程序所需信息的文件            ，这些信息以特定方式构成            。它们不是在程序中进行硬编码  
 
  
 
  
 
  
 
  
 
  
 
  ，而是用户可配置的












，通常存储在纯文本文件中
  
  
  
  
  
  
，我们可以理解为存储整个项目重要信息的文本文件）  
  
  
  
  
  
 ，在spring框架中整个项⽬中所有重要的数据都是在配置⽂件中配置的
 


 


 


 


 


 


 ，例如我们需要用一个应用程序和另外一个应用程序进行交互
 
 
 
 
 
 
，获得其中的一些信息时候   
   
   
   
   
   
 ，就需要设置一个交互的秘钥这是程序员自己定义的一个配置文件
 

 

 

 

 

 

 ，还例如系统级别的配置文件

 

 

 

 

 

 
，在数据库链接时候             ，所需要的password
 
 

 
 

 
 

 
 

 
 

 
 

 ，url












，username作为一个全局信息需要及时设置并获取                   ，这就是配置文件的重要性  
 
  
 
  
 
  
 
  
 
  
 
  。

2.配置⽂件的格式 

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

.properties

.yml

这就好像连锁店⾥⾯的统⼀服装⼀样 
 
 
 
 
 
 
 
 
 
 
 
 ，有两种不同的款式



















，properties 类型的配置⽂件就属于⽼款“服 饰            ”            ，也是创建 Spring Boot 项⽬时默认的⽂件格式（主要是由于仓库⾥还有库存）  
 
  
 
  
 
  
 
  
 
  
 
  ，⽽ yml 属于新版 款式












，如果⽤户了解情况直接指定要新款服饰
  
  
  
  
  
  
，那么就直接发给他












。 

 特殊说明

1. 理论上讲 properties 可以和 yml ⼀起存在于⼀个项⽬当中  
  
  
  
  
  
 ，当 properties 和 yml ⼀起存在⼀个项 ⽬中时
 


 


 


 


 


 


 ，如果配置⽂件中出现了同样的配置
 
 
 
 
 
 
，⽐如 properties 和 yml 中都配置了“server.port  
 
  
 
  
 
  
 
  
 
  
 
  ”   
   
   
   
   
   
 ，那 么这个时候会以 properties 中的配置为主
 

 

 

 

 

 

 ，也就是 .properties 配置⽂件的优先级最⾼

 

 

 

 

 

 
，但加载完 .properties ⽂件之后             ，也会加载 .yml ⽂件的配置信息
  
  
  
  
  
  
。

2. 虽然理论上来讲 .properties 可以和 .yml 共存
 
 

 
 

 
 

 
 

 
 

 
 

 ，但实际的业务当中












，我们通常会采取⼀种统⼀的配 置⽂件格式                   ，这样可以更好的维护（降低故障率）  
  
  
  
  
  
 。这就好像连锁店的服饰⼀样 
 
 
 
 
 
 
 
 
 
 
 
 ，不管是⽼款的服 装还是新款的服装



















，⼀定要统⼀了才好看
 


 


 


 


 


 


 。

3.properties 配置⽂件说明

properties 配置⽂件是最早期的配置⽂件格式            ，也是创建 Spring Boot 项⽬默认的配置⽂件

3.1 properties 基本语法

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











”连接的












，如：

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

 3.2 读取配置⽂件

如果在项⽬中
  
  
  
  
  
  
，想要主动的读取配置⽂件中的内容  
  
  
  
  
  
 ，可以使⽤ @Value 注解来实现
 
 
 
 
 
 
。 @Value 注解使⽤“${}
  
  
  
  
  
  
”的格式读取
 


 


 


 


 


 


 ，如下代码所示：

import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Component; import javax.annotation.PostConstruct; @Component public class ReadYml { @Value("${server.port}") private String port; @PostConstruct public void postConstruct() { System.out.println("Read YML,port:" + port); } }

结果如下

 @Component 在 Spring Boot 启动时候会注⼊到框架中
 
 
 
 
 
 
，注⼊到框架中时会执⾏ @PostConstruct 初 始化⽅法   
   
   
   
   
   
 ，这个时候就能读取到配置信息了

3.3 properties 缺点分析

properties 配置是以 key-value 的形式配置的
 

 

 

 

 

 

 ，如下图所示

 从上述配置key看出

 

 

 

 

 

 
，properties 配置⽂件中会有很多的冗余的信息             ，⽐如这些

想要解决这个问题
 
 

 
 

 
 

 
 

 
 

 
 

 ，就可以使⽤ yml 配置⽂件的格式化了   
   
   
   
   
   
 。

4.yml 配置⽂件说明 

yml 是 YMAL 是缩写












，它的全称 Yet Another Markup Language 翻译成中⽂就是“另⼀种标记语⾔  
  
  
  
  
  
 ”
 

 

 

 

 

 

 。 yml 是⼀个可读性⾼                   ，易于理解 
 
 
 
 
 
 
 
 
 
 
 
 ，⽤来表达数据序列化的格式

 

 

 

 

 

 
。它的语法和其他⾼级语⾔类似



















，并且可 以简单表达清单（数组）
  
  
  
  
  
  
 、散列表            ，标量等数据形态             。它使⽤空⽩符号缩进和⼤量依赖外观的特⾊  
 
  
 
  
 
  
 
  
 
  
 
  ，特别适合⽤来表达或编辑数据结构 
  
  
  
  
  
 、各种配置⽂件等
 
 

 
 

 
 

 
 

 
 

 
 

 。 yml 最⼤的优势是可以跨语⾔












，不⽌是 Java 中可以使⽤ golang 


 


 


 


 


 


 
、python 都可以使⽤ yaml 作为配置⽂ 件












。

yml的优点

1.yml代码简洁
  
  
  
  
  
  
，例如datasource中的url  
  
  
  
  
  
 ，password
 


 


 


 


 


 


 ，username可以只设置一个前缀简化代码的臃肿行
 
 
 
 
 
 
，增加代码的可读性

2.yml支持多种数据类型

3.最大的优势是可以跨平台   
   
   
   
   
   
 ，支持多种语言
 

 

 

 

 

 

 ，在同一项目的开发中

 

 

 

 

 

 
，不同语种可以使用同一个yml文件来设置配置文件

4.1 yml 基本语法

yml 是树形结构的配置⽂件             ，它的基础语法是“key: value
 


 


 


 


 


 


 ”
 
 

 
 

 
 

 
 

 
 

 
 

 ，注意 key 和 value 之间使⽤英⽂冒汗加空 格的⽅式组成的












，其中的空格不可省略                   。 基础语法如下：

 其中第⼀项的配置为正确的                   ，key 也是⾼亮显示的 
 
 
 
 
 
 
 
 
 
 
 
 ，⽽第⼆项没有空格是错误的使⽤⽅式



















，第⼆项的 key 也没有⾼亮显示 
 
 
 
 
 
 
 
 
 
 
 
 。

使⽤ yml 连接数据库 

spring: datasource: url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8 username: root password: root

yml 和 properties 连接数据库的配置对⽐

4.2 yml 使⽤进阶

4.2.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: ~

4.2.1.1 yml 配置读取

yml 读取配置的⽅式和 properties 相同












，使⽤ @Value 注解即可
  
  
  
  
  
  
，实现代码如下

import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Component; import javax.annotation.PostConstruct; @Component public class ReadYml { @Value("${string.hello}") private String hello; @PostConstruct public void postConstruct() { System.out.println("Read YML,Hello:" + hello); } }

 注意事项：value 值加单双引号‘

字符串默认不⽤加上单引号或者双引号  
  
  
  
  
  
 ，如果加英⽂的单双引号可以表示特殊的含义



















。

string: str1: Hello \n Spring Boot. str2: Hello \n Spring Boot. str3: "Hello \n Spring Boot.

读取程序实现代码如下：

import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Component; import javax.annotation.PostConstruct; @Component public class ReadYml { @Value("${string.str1}") private String str1; @Value("${string.str2}") private String str2; @Value("${string.str3}") private String str3; @PostConstruct public void postConstruct() { System.out.println("string.str1：" + str1); System.out.println("string.str2：" + str2); System.out.println("string.str3：" + str3); } }

以上程序的执⾏结果如下图所示：

从上述结果可以看出： 字符串默认不⽤加上单引号或者双引号            。

单引号会转义特殊字符
 


 


 


 


 


 


 ，特殊字符最终只是⼀个普通的字符串数据  
 
  
 
  
 
  
 
  
 
  
 
  。

双引号不会转义字符串⾥⾯的特殊字符；

特殊字符会作为本身想表示的意思 

4.2.2 配置对象

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

student: id: 1 name: Java age: 18

或者是使⽤⾏内写法（与上⾯的写法作⽤⼀致）：

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

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

import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; @ConfigurationProperties(prefix = "student") @Component public class StudentComponent { private int id; private String name; private int age; public int getId() { return id; } public void setId(int id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } @Override public String toString() { return "StudentComponent{" + "id=" + id + ", name=" + name + \ + ", age=" + age + }; } }

！！！以上代码中的 getter 和 setter ⽅法不能省略

调⽤类的实现如下：

@Component public class ReadYml2 { @Autowired private StudentComponent studentComponent; @PostConstruct public void postConstruct() { System.out.println(studentComponent); } }

 4.2.3 配置集合

dbtypes: name: - mysql - sqlserver - db2

或者是使⽤⾏内写法（与上⾯的写法作⽤⼀致）：

dbtypes: {name: [mysql,sqlserver,db2]}

集合的读取和对象⼀样

 

 

 

 

 

 
，也是使⽤ @ConfigurationProperties 来读取的             ，具体实现如下：

@Component @ConfigurationProperties("dbtypes") @Data public class ListConfig { private List<String> name; }

打印类的实现如下

import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import javax.annotation.PostConstruct; @Component public class ReadYml2 { @Autowired private ListConfig listConfig; @PostConstruct public void postConstruct() { System.out.println(listConfig.getName()); } }

5.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 共存
 


 


 


 


 


 


 ，但⼀个项⽬中建议使⽤统⼀的配置类型⽂件
 


 


 


 


 


 


 。