Spring Boot的配置文件
配置文件
SpringBoot使用一个全局的配置文件,配置文件名是固定的:
- application.properties
- application.yml
配置文件的作用:修改springboot自动配置的默认值
yaml介绍
YAML(YAML Ain’t Markup Language)
YAML A Markup Language : 是一个标记语言
YAML isn't Markup Language : 不是一个标记语言
标记语言:
以前的配置文件大多使用的都是xxx.xml文件
.yml是yaml语言的文件,以数据为中心的,比json、xml更适合做配置文件
xml与yaml的对比:
1、xml:
<server>
<port>8080</port>
</server>
2、yaml:
server:
port: 8080
yaml的语法
1、基本语法:
k:空格 v: 表示一对键值对(空格必须有)
以空格的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的
server:
port: 8080
path: /hello
yaml的语法特点:
1、大小写敏感
2、使用缩进表示层级关系
3、缩进时不允许使用Tab键,只允许使用空格。
4、缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
2、值的写法
字面量:普通的值(数字、字符串、布尔)
k: v: XX
字面直接来写;
字符串默认不用加上单引号或者双引号;
" ":双引号,不会转义字符串里面的特殊字符;特殊字符会作为本身想表达的意思。
例: name: "zhangsan \n lisi"
输出: zhangsan 换行 lisi
' ':单引号,会转义特殊字符,特殊字符最终只是一个普通的字符串数据
例: name: 'zhangsan \n lisi'
输出: zhangsan \n lisi
对象、Map(属性和值)(键值对):
k : v: 在下一行写对象的属性和值的关系,注意缩进
对象还是k: v: 的方式
一般写法:
friends:
lastName: zhangsan
age: 20
行内写法:
friends: {lastName: zhangsan,age: 18}
数组(List、Set)
用- 值表示数组中的一个元素
一般写法:
pets:
- cat
- dog
- pig
行内写法:
pets: [cat,dog,pig]
案例:yaml配置文件值的获取
配置文件值注入
yaml:
person:
lastName: zhangsan
age: 18
boss: false
birth: 2017/12/12
maps: {k1: v1,k2: 12}
lists:
- lisi
- zhaoliu
dog:
name: 小白
age: 2
或者使用properties注入:
person.last-name=张三
person.boss=true
person.age=18
person.birth=2017/8/9
person.maps.k1=v1
person.maps.k2=14
person.dog.name=dog
person.dog.age=3
person.lists=1,2,3,4
javaBean:
/**
* 将配置文件中配置的每一个属性的值,映射到这个组件中
* //@ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
* prefix = "person": 配置文件中哪个下面的所有属性进行一一映射
*
* 只有这个组件是容器中的组件,容器提供的@ConfigurationProperties功能才能生效
*/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
相关getter、setter方法
或使用javabean的另一种注入方式:
@Component
public class Person {
@Value("${person.last-name}")
private String lastName;
@Value("#{11*2}")
private Integer age;
@Value("true")
private Boolean boss;
.......
ModelTest:
/**
* springboot 单元测试
*/
@SpringBootTest
class HelloworldApplicationTests {
@Autowired
Person person;
@Test
void contextLoads() {
System.out.println(person);
}
}
pom.xml导入配置文件处理器:
<!--导入配置文件处理器,配置文件进行绑定就会有提示-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
测试结果:
@Value获取值和@ConfigurationProperties(prefix = “XXX”)获取值的比较
@Value | @ConfigurationProperties(prefix = “XXX”) | |
---|---|---|
功能 | 一个个指定 | 批量注入配置文件中的属性 |
松散语法绑定 | 不支持 | 支持 |
SPEL | 支持 | 不支持 |
JSR303数据校验 | 不支持 | 支持 |
复杂类型封装 | 不支持 | 支持 |
特点:
配置文件yaml还是properties他们都能获取到值
1、如果我们只是在某个业务逻辑中获取一下配置文件的某项值,使用@Value;
2、如果我们专门编写了一个javaBean来和配置文件映射,直接使用@ConfigurationProperties;
@PropertySource和@ImportResource
@PropertySource:加载指定的配置文件
@Component
@PropertySource(value = {"classpath:person.yml"})
@Validated //开启JRS303数据校验
@ConfigurationProperties(prefix = "person")
public class Person {
@Email(message = "该值必须是一个邮箱")
private String lastName;
@NotNull
private Integer age;
//@Value("true")
private Boolean boss;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
@ImportResource:导入Spring的配置文件,让配置文件的内容生效;
Srping Boot 里面没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别;
将@ImportResource(locations = {“xxxx”})标注在一个配置类上