Spring Boot配置文件

目录

1.配置文件的作用

 2.配置文件的格式

3.properties配置文件说明

3.1 properties基本语法

3.2 读取配置文件信息

3.3 properties 缺点分析

4.yml 配置⽂件说明

4.1 yml 基本语法

4.2 yml 使⽤进阶

4.2.1 yml 配置不同数据类型及 null

4.2.2 配置对象  

5.properties VS yml

6.为不同环境设置不同的配置文件

---

1.配置文件的作用

不难发现配置文件一听起来就十分不想去学习他，感觉十分的枯燥，配置的乱七八糟的东西。实际上springboot的配置文件在整个项目中起着十分重要的作用，项目的重要数据都是在配置文件中配置的，比如说：

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

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

 2.配置文件的格式

 springboot配置文件主要分为以下两种（application.properties和application.yml）：

• .properties
• .yml

 其中xx.properties是随着项目建立默认的配置文件的格式，yaml一般是开发者后来自己创建的格式，既然有这两种形式的配置文件就必然有他们的区别和使用场景。

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 注解使⽤“${}”的格式读取，如下代码所示：

package com.example.springbootdemo.component;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;@PostConstructpublic void postConstruct() {System.out.println("Read YML,port:" + port);}
}

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

3.3 properties 缺点分析

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

从上述配置key看出，properties 配置⽂件中会有很多的冗余的信息，但是这是缺点也是优点，优点就是通过这种方式简单不会出错，没有yaml的格式要求严格，刚学习可以使用这种的配置文件。但是他确实不够简洁，想要解决这个问题就可以使用yaml配置文件的格式化。

4.yml 配置⽂件说明

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

⾔”。

yml 优点分析

• yml 是⼀个可读性⾼，写法简单、易于理解，它的语法和 JSON 语⾔类似。
• yml ⽀持更多的数据类型，它可以简单表达清单（数组）、散列表，标量等数据形态。它使⽤空⽩符号缩进和⼤量依赖外观的特⾊，特别适合⽤来表达或编辑数据结构、各种配置⽂件等。
• yml ⽀持更多的编程语⾔，它不⽌是 Java 中可以使⽤在 Golang、PHP、Python、Ruby、JavaScript、Perl 中。

4.1 yml 基本语法

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

不加空格的话没有语法高亮：

 使用示例：

连接数据库：

spring:datasource:url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8username: rootpassword: root

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

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;@PostConstructpublic void postConstruct() {System.out.println("Read YML,Hello:" + hello);}
}

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

字符串默认不⽤加上单引号或者双引号 ， 但是

尝试在 application.yml 中配置如下信息，然后读取最终的值他们会是一样的吗？？

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

代码：

package com.example.springbootdemo.component;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;@PostConstructpublic void postConstruct() {System.out.println("string.str1：" + str1);System.out.println("string.str2：" + str2);System.out.println("string.str3：" + str3);}
}

程序执行结果：

从上述结果可以看出：

• 字符串默认不⽤加上单引号或者双引号。
• 双引号会转义特殊字符（\n）,这里看到最终将其转意成换行了。
• 单引号不会转义字符串⾥⾯的特殊字符；特殊字符会作为本身想表示的意思。

4.2.2 配置对象  

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

student:id: 1name: 张三age: 22

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

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

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

package com.example.springbootdemo.component;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;}@Overridepublic String toString() {return "StudentComponent{" +"id=" + id +", name='" + name + '\'' +", age=" + age +'}';}
}

调⽤类的实现如下：

package com.example.springbootdemo.component;import com.example.springbootdemo.entity.StudentComponent;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;import javax.annotation.PostConstruct;@Component
public class ReadYml2 {@Autowiredprivate StudentComponent studentComponent;@PostConstructpublic void postConstruct() {System.out.println(studentComponent);}
}

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

想要查看 Spring Boot 更多系统配置项，访问官⽹： Common Application Properties

5.properties VS yml

• properties 是以 key=value 的形式配置的键值类型的配置⽂件，⽽ yml 使⽤的是类似 json 格式的树形配置⽅式进⾏配置的，yml 层级之间使⽤换⾏缩进的⽅式配置，key 和 value 之间使⽤“: ”英⽂冒号加空格的⽅式设置，并且空格不可省略。

• properties 为早期并且默认的配置⽂件格式，但其配置存在⼀定的冗余数据，使⽤ yml 可以很好的解决数据冗余的问题。
• yml 通⽤性更好，⽀持更多语⾔，如 Java、Go、Python 等，如果是云服务器开发，可以使⽤⼀份配置⽂件作为 Java 和 Go 的共同配置⽂件。
• yml ⽀持更多的数据类型。

6.为不同环境设置不同的配置文件

当你在Spring Boot项目中想要设置不同环境的配置文件时，可以使用Spring Boot的profiles功能。这使你能够为不同的环境（如开发、测试、生产）创建不同的配置文件，并在运行时选择使用哪个配置。这样就不用繁琐的更改大量配置文件代码。

以下是一个简单的步骤来设置不同环境的配置文件：

在src/main/resources目录下，创建不同环境的配置文件，文件名为application-{profile}.yaml（例如：application-dev.yaml、application-test.yaml、application-prod.yaml）。同时创建一个application.yaml的配置文件。在application配置文件中可以写上不同环境的通用配置信息并且配置上：

spring.profiles.active=dev/test/prod   #这条配置信息可以决定启动的时候除了公用的配置信息还需要启动哪一个环境下的配置文件。

 然后再三个不同的配置文件中配置上各自需要的配置，比如不同环境下的数据库配置。

 如果配置的是spring.profiles.active=dev，那么配置信息就是application.yaml+application-dev.yaml

  

 使用这种方法，你可以根据需要轻松切换不同的环境配置，从而在开发、测试和生产环境中保持一致的应用程序行为。