一、yml简介
1、配置文件
Springboot使用一个全局配置文件,配置文件名是固定的:
- application.properties
- application.yml
配置文件的作用:修改springboot自动配置的默认值。
2、标记语言
以前的配置文件,大多使用的是xxxx.xml文件;
YML:以数据为中心,比json、xml更适合做配置文件;
二、yml语法
1、基本语法
k:(空格)v :表示一对键值对(空格必须有);
以空格的缩进来控制层级关系;只要是左对齐的一列数据,都是一个层级的;
属性和值也是大小写敏感的;
2、值的写法
- 字面量:普通的值(数字、字符型、布尔);
k: v :字面量直接来写(不要忘记空格);
字符串默认不加单引号或双引号;
"":双引号:不会转义字符串里的特殊字符;
name: "zhangsan \n list";
输出:zhangsan(换行)list
'':单引号:会转义特殊字符;
name: 'zhangsan \n list';
输出:zhangsan \n list
- 对象、Map(属性和值)(键值对):
k: v:在下一行来写对象的属性和值的关系;注意缩进
对象还是k: v的方式:
friends:
lastName: zhangsan
age: 20
行内写法:
friends: {lastName: zhangsan,age: 20}
- 数组(Lise、Set):
用 - 值 表示数组中的一个元素:
pets:
- cat
- dog
- pig
行内写法:
pets: [cat,dog,pig]
三、yml配置文件值获取(注入到类中)
第一种方式:@ConfiguratingProperties
1、导入配置文件处理器,以后编写配置就有配置提示;
<!--导入配置文件处理器,配置文件绑定就会有输入提示-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
2、@ConfiguratingProperties(prefix = "person")
@ConfiguratingProperties注解加在类名前面,告诉Springboot将本类中的所有属性和配置文件中的相关配置进行绑定:
prefix = "person":说明把配置文件中的哪个配置的所有属性与本类一一映射
import org.springframework.boot.context.properties.ConfigurationProperties;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
* @ConfigurationProperties将配置文件中配置的每一个属性的值,映射到这个组件中
* prefix = "person"配置文件中这个下面的所有属性进行一一映射
*/
//类中所有属性和配置文件中相关的配置进行绑定
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String lastName;
private Integer age;
private boolean boos;
private Date birth;
private Map<String,Object> maps;
private List<Object> lists;
private Dog dog;
@Override
public String toString() {
return "Person{" +
"lastName='" + lastName + '\'' +
", age=" + age +
", boos=" + boos +
", birth=" + birth +
", maps=" + maps +
", lists=" + lists +
", dog=" + dog +
'}';
}
public String getLastName() {
return lastName;
}
public void setLastName(String lastName) {
this.lastName = lastName;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public boolean isBoos() {
return boos;
}
public void setBoos(boolean boos) {
this.boos = boos;
}
public Date getBirth() {
return birth;
}
public void setBirth(Date birth) {
this.birth = birth;
}
public Map<String, Object> getMaps() {
return maps;
}
public void setMaps(Map<String, Object> maps) {
this.maps = maps;
}
public List<Object> getLists() {
return lists;
}
public void setLists(List<Object> lists) {
this.lists = lists;
}
public Dog getDog() {
return dog;
}
public void setDog(Dog dog) {
this.dog = dog;
}
}
public class Dog {
private String name;
private String age;
@Override
public String toString() {
return "Dog{" +
"name='" + name + '\'' +
", age='" + age + '\'' +
'}';
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getAge() {
return age;
}
public void setAge(String age) {
this.age = age;
}
}
person:
lastName: zhangsan
age: 18
boss: false
birth: 2017/12/12
maps: {k1: v1,k2: 12}
lists:
- list
- zhaoliu
dog:
name: 小狗
age: 2
3、@component
@component加在@ConfiguratingProperties之前:
只有这个组件是容器中的组件,才能使用容器提供的@ConfiguratingProperties功能;
SpringBoot项目的单元测试用spring的启动器而不是Junit
第二种方式:@value
@Value注解的使用方法见我的另一篇博客:https://blog.csdn.net/qq_26356861/article/details/100271043
@Value用于给指定属性注入值;
@Value和@ConfiguratingProperties区别:
功能 | @ConfiguratingProperties | @Value |
松散绑定(松散语法) | 支持 | 不支持 |
SpEL语法 | 不支持 | 支持 |
JSR303数据校验 | 支持 | 不支持 |
复杂类型分装 | 支持 | 不支持 |
配置文件yml还是properties都能获取到值;
- 如果说,我们只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value;
- 如果说,我们专门编写了一个javabean来和配置文件进行映射,我们就直接使用@ConfigurationProperties;
注:yml文件编码乱码解决:修改setting中的文件编码方式。