文章目录
一、配置文件作用及格式
1.配置文件的的作用
整个项目中所有重要的数据都是在配置文件中配置的,比如:
- 数据库的连接信息(包含⽤户名和密码的设置);
- 项目的启动端口;
- 第三方系统的调用秘钥的信息;
- 用于发现和定位问题的普通日志和异常日志等。
2.配置文件的格式
Spring Boot 配置文件主要分为以下两种格式:
- .properties
- .yml
如下图:
特殊说明:
- 理论上讲 properties 可以和 yml ⼀起存在于⼀个项目当中,当 properties 和 yml ⼀起存在⼀个项目中时,如果配置文件中出现了同样的配置,比如 properties 和yml 中都配置了“server.port”,那么这个时候会以 properties 中的配置为主,也就是.properties 配置文件的优先级最高,但加载完 .properties ⽂件之后,也会加载 .yml 文件的配置信息。
- 虽然理论上来讲 .properties 可以和 .yml 共存,但实际的业务当中,我们通常会采取⼀种统⼀的配置文件格式,这样可以更好的维护(降低故障率)。
二、properties 和 yml 配置文件说明
1.properties 说明 及基本语法
properties 配置文件是最早起的配置文件格式,也是创建 Spring Boot 项目默认的配置文件。
缺点:
1.1 properties 基本语法
properties 是以键值的形式配置的,key 和 value 之间是以“=”连接的,如:
# 配置项目的端口号
server.port=9090
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root
2.yml 说明 及基本语法
yml 是 YAML 是缩写,它的全称 Yet Another Markup Language 翻译成中文就是“另⼀种标记语⾔”。
yml优点分析:
- yml 是⼀个可读性高,写法简单、易于理解,它的语法和 JSON 语言类似。
- yml ⽀持更多的数据类型,它可以简单表达清单(数组)、散列表,标量等数据形态。它使用空白符号缩进和⼤量依赖外观的特色,特别适合用来表达或编辑数据结构、各种配置文件等。
- yml 支持更多的编程语言,它不止是 Java 中可以使用在 Golang、PHP、Python、Ruby、JavaScript、Perl 中。
2.1 yml 基本语法
yml 是树形结构的配置文件,它的基础语法是“key: value”,注意 key 和 value 之间使用英文冒号加空格的方式组成的,其中空格不可省略
。
使用 yml 连接数据库
yml 示例:
spring:
datasource:
url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8
username: root
password: root
3.yml使用进阶
3.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: ~
3.2 配置对象
student:
id: 1
name: "张三"
age: 18
3.3 配置集合
dbtypes:
name:
- mysql
- sqlserver
- db2
三、读取配置文件的内容
1. 读取普通配置 @Value(“${}”)
对于普通的配置项,properties 和 yml 的读取方式是相同的,使用 @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 初始化方法,这个时候就能读取到配置信息了。
2.读取配置文件中的对象 @ConfigurationProperties
使用注解 @ConfigurationProperties 读取,具体实现如下:
package com.example.demo.entity;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
//从 yml 配置文件中获取 student 对象
//1. @ConfigurationProperties("yml中的对象名")
//2.要加五大类注解
//3.属性要与 yml 配置文件中的一致
//4.要加上 set 和 get 方法
@ConfigurationProperties("student") //从配置文件中读 student 对象
@Component
@Setter
@Getter
@ToString
public class StudentComponent {
private int id;
private String name;
private int age; //此处的属性一定要与 yml 配置文件中的一致
}
注意:
此处一定实现属性的 set 和 get 方法, 这里是使用了 lombok,代替了手写的 set 和 get 方法的代码, lombok 后面会专门写一篇文章介绍它的使用方法。
调用类的实现如下:
@Controller
public class ReadYml {
@Autowired
private StudentComponent studentComponent;
@PostConstruct
public void postConstruct(){
System.out.println(studentComponent);
}
}
执行结果如下图:
3.读取配置文件的 5 种方法
- @Value (读取单个配置项)
- @ConfigurationProperties (读取一组配置项)
- Environment 读取配置文件。
- Environment 是 Spring Core 中的一个用于读取配置文件的类,将此类使用 @Autowired 注入到类中就可以使用它的 getProperty 方法来获取某个配置项的值了。
- @PropertySource 读取指定配置文件(properties文件)的配置内容。
- 使用原生方式读取配置文件
4.更多的系统配置项
链接中查看更多配置文件中的配置项:
https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html
5.设置不同环境的配置文件
- application.yml
- application-dev.yml ->开发环境
- application-prod.yml ->生产环境
- application-test.yml ->测试环境
properties VS yml
- properties 是以 key=value 的形式配置的键值类型的配置⽂件,而 yml 使用的是类似 json 格式的树形配置方式进行配置的,yml 层级之间使用换行缩进的方式配置,key 和 value 之间使用“: ”英文冒号加空格的方式设置,并且空格不可省略。
- properties 为早期并且默认的配置文件格式,但其配置存在一定的冗余数据,使用 yml 可以很好的解决数据冗余的问题。
- yml 通用性更好,支持更多语言,如 Java、Go、Python 等,如果是云服务器开发,可以使用⼀份配置文件作为 Java 和 Go 的共同配置文件。
- yml 支持更多的数据类型。