springboot使用一个全局的配置文件,配置文件名是固定的,一般有两种写法:
application.properties
application.yml
配置文件的作用:SpringBoot在底层都给我们自动配置了,而配置文件的作用就是修改SpringBoot自动配置的默认值。
之前的配置文件,都是使用的xml文件格式,但是YAML也可以做配置文件,YAML是以数据为中心,比JSON、XML等等更适合做配置文件。
配置示例(将端口号设置为8081)
server:
port: 8081
k: v:
表示一对键值对(空格必须有)。以空格的缩进来控制层级关系,只要是左对齐的一列数据,都是同一个层级的。并且其属性和值都是大小写敏感的。
示例:
server:
port: 8081
path: /hello
使用k: v:
对于字符串,默认不用加上单引号或者双引号,""
双引号不会转义字符串里面的特殊字符,特殊字符会作为本身想表示的意思;''
单引号就会转义字符,特殊字符最终只是一个普通的字符串数据。
还是使用k:v:
方式,在下一行来写对象的属性和值的关系,注意缩进,例如:
friend:
lastName: zhangsan
age: 20
这样表示lastName和age是friend对象的属性。
也可以写成行内写法:friend: {lastName: zhangsan,age: 18}
用-
表示数组中的一个元素
pets:
- cat,
- dog,
- pig
也可以写成:pets: [cat,dog,pig]
在JavaBean类中加入@ConfigurationProperties
注解将配置文件中配置的每一个属性的值映射到这个组件中,并且要将这个类加入到IOC容器中。要注意的是@ConfigurationProperties
默认是从全局配置文件中获取值的。
yml文件:
person:
lastName: zhangsan
age: 18
boss: false
birth: 2019/12/12
map: {k1: 1,k2: 2}
list:
- lisi
- zhaoliu
dog:
name: 小狗
age: 2
JavaBean(省略getter、setter、toString方法):
package com.cerr.springboot.bean;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* 将配置文件中配置的每一个属性的值映射到这个组件中
* @ConfigurationProperties告诉Springboot将本类中的所有属性和配置文件中相关的配置进行绑定
* prefix:配置文件中哪个下面的所有属性进行配置
*
* 只有这个组件是容器中的组件,才能使用容器提供的ConfigurationProperties功能
*/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map map;
private List
我们可以导入配置文件处理器,以后编写配置就有提示:
org.springframework.boot
spring-boot-configuration-processor
true
刚刚在yml中的配置也可以在properties中配置:
person.last-name=张三
person.age=14
person.birth=2019/12/2
person.boss=false
person.map.k1=11
person.map.k2=22
person.list=a,b,c
person.dog.name=dog
person.dog.age=15
对于yml或者properties配置文件,这两个注解都可以获取到配置文件的值,但是它们有以下的区别:
@ConfigurationProperties | @Value | |
---|---|---|
功能 | 批量注入配置文件中的属性 | 必须一个一个属性的指定 |
松散语法(松散绑定) | 支持 | 不支持 |
SpEL | 不支持 | 支持 |
JSR303数据校验 | 支持 | 不支持 |
复杂类型封装 | 支持 | 不支持 |
如果我们只是在某个业务逻辑中需要获取一下配置文件的某个值时,我们使用@Value
比较方便;如果我们专门编写了一个JavaBean来和配置文件进行映射,我们就直接使用@ConfigurationProperties
。
在类上标注@Validated
注解,并在你需要校验的字段标注上对应的注解即可,假设我们在lastName
字段要使用@Eamil
校验,则代码如下:
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
@Email
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map map;
private List
@PropertySource
加载指定的配置文件@PropertySource
这个注解可以加载指定的配置文件。
我们定义一个局部的配置文件,文件的位置位于类路径下,如图所示:
@PropertySource(value = {"classpath:person.properties"})
将该配置文