SpringBoot 配置⽂件
- 1. 配置文件的作用
- 2. .配置⽂件的格式
- 2.1 properties
- 2.1.1 基本语法
- 2.1.2 读取配置⽂件
- 2.2 yml
- 2.2.1 概念
- 2.2.2 基本语法
- 2.2.3 配置对象
- 2.2.4 配置集合
- 2.3 properties 和 yml 对比
1. 配置文件的作用
整个项⽬中所有重要的数据都是在配置⽂件中配置的,⽐如:
- 数据库的连接信息(包含⽤户名和密码的设置);
- 项⽬的启动端⼝;
- 第三⽅系统的调⽤秘钥等信息;
- ⽤于发现和定位问题的普通⽇志和异常⽇志等。
想象⼀下如果没有配置信息,那么 Spring Boot 项⽬就不能连接和操作数据库,甚⾄是不能保存可以⽤于排查问题的关键⽇志,所以配置⽂件的作⽤是⾮常重要的.
2. .配置⽂件的格式
2.1 properties
properties 配置⽂件是最早期的配置⽂件格式,也是创建 Spring Boot 项⽬默认的配置⽂件
2.1.1 基本语法
properties 是以键值的形式配置的,key 和 value 之间是以“=”连接的,如:
# 配置项⽬端⼝号
server.port=8080
# 数据库配置
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/mydb?characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=123456
2.1.2 读取配置⽂件
如果在项⽬中,想要主动的读取配置⽂件中的内容,可以使⽤ @Value 注解来实现。
@Value 注解使⽤“${}”的格式读取,如下代码所示:
配置文件:
代码:
@RestController
public class TestController {@Value("${name}")private String name;@PostConstructpublic void getName() {System.out.println(name);}
}
执行结果为:
2.2 yml
2.2.1 概念
yml 是 YAML 是缩写,它的全称 Yet Another Markup Language 翻译成中⽂就是“另⼀种标记语⾔”.
yml 优点分析:
- yml 是⼀个可读性⾼,写法简单、易于理解,它的语法和 JSON 语⾔类似。
- yml ⽀持更多的数据类型,它可以简单表达清单(数组)、散列表,标量等数据形态。它使⽤空⽩符号缩进和⼤量依赖外观的特⾊,特别适合⽤来表达或编辑数据结构、各种配置⽂件等。
- yml ⽀持更多的编程语⾔,它不⽌是 Java 中可以使⽤在 Golang、PHP、Python、Ruby、JavaScript、Perl 中
2.2.2 基本语法
yml 是树形结构的配置⽂件,它的基础语法是“key: value”,注意 key 和 value 之间使⽤英⽂冒号加空格的⽅式组成的,其中的空格不可省略.
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 注解即可
注意: 字符串默认不⽤加上单引号或者双引号,如果加英⽂的单双引号可以表示特殊的含义.
2.2.3 配置对象
yml 中也支持配置对象, 语法如下:
student:id: 1name: Javaage: 18
也可以使用行内语法:
student: {id: 1,name: Java,age: 18}
这个时候就不能⽤ @Value 来读取配置中的对象了,此时要使⽤另⼀个注解@ConfigurationProperties 来读取,具体实现如下:
@ConfigurationProperties("student")
@Component
@Data
public class Student {private int id;private String name;private int age;
}
@Component
public class StudentComponent {@Autowiredprivate Student student;@PostConstructpublic void getStudent() {System.out.println(student);}}
执行结果:
2.2.4 配置集合
配置⽂件也可以配置 list 集合,如下所示:
students:name:- 张三- 李四- 王五
也可以使用行内写法:
students: {name: [张三, 李四, 王五]}
集合的读取和对象⼀样,也是使⽤ @ConfigurationProperties 来读取的
@Component
@ConfigurationProperties("students")
@Data
public class ListConfig {private List<String> name;
}
2.3 properties 和 yml 对比
- properties 是以 key=value 的形式配置的键值类型的配置⽂件,⽽ yml 使⽤的是类似 json 格式的树形配置⽅式进⾏配置的,yml 层级之间使⽤换⾏缩进的⽅式配置,key 和 value 之间使⽤“: ”英⽂冒号加空格的⽅式设置,并且空格不可省略
- properties 为早期并且默认的配置⽂件格式,但其配置存在⼀定的冗余数据,使⽤ yml 可以很好的解决数据冗余的问题
- yml 通⽤性更好,⽀持更多语⾔,如 Java、Go、Python 等,如果是云服务器开发,可以使⽤⼀份配置⽂件作为 Java 和 Go 的共同配置⽂件
- yml ⽀持更多的数据类型
设置不同环境的配置⽂件
- 创建不同环境的配置⽂件:
- application-dev.yml (开发环境)
- application-prod.yml (运行环境)
注意:这两个文件前缀必须是 application
- 在 application.yml 中设置运⾏环境
spring.profiles.active=dev