yaml语法学习
配置文件
SpringBoot使用一个全局的配置文件 ， 配置文件名称是固定的
- application.properties
- 语法结构：key=value
- application.yml
- 语法结构：key: 空格value
配置文件的作用：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；比如我们可以在配置文件中修改Tomcat 默认启动的端口号！测试一下！
server.port=8081
yaml概述
YAML是 "YAML Ain't a Markup Language" （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）
这种语言以数据作为中心，而不是以标记语言为重点！
以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml
传统xml配置
<server>
<port>8081<port>
</server>yaml配置
server:
port: 8080yaml基础语法
说明：语法要求严格
1. 空格不能省略
2. 以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的
3. 属性和值的大小写都是十分敏感的
字面量：普通的值 [ 数字，布尔值，字符串 ]
字面量直接写在后面就可以 ， 字符串默认不用加上双引号或者单引号；
注意：
- ""双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；
比如 ：name: "hello \n world" 输出 ：hello 换行 world
- ''单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出
比如 ：name: ‘hello \n world’ 输出 ：hello \n world
对象、Map（键值对）
#对象、Map格式
k:
v1:
v2:
在下一行来写对象的属性和值的关系，注意缩进；比如：
student:
name: xiaoming
age: 18
行内写法
student: {name: xiaoming, age: 18}
数组（ List、set ）
用 - 值表示数组中的一个元素,比如：
pets:
- cat
- dog
- pig
行内写法
pets: [cat, dog, pig]
修改SpringBoot的默认端口号
server:
port: 8082
注入配置文件
yaml文件更强大的地方在于，他可以给我们的实体类直接注入匹配值！
yaml注入配置文件
-
在springboot项目中的resources目录下新建一个文件 application.yaml
-
编写一个实体类Dog，并用@Value给bean注入属性值(注：通过配置文件给属性注入值，一定要写set方法，下面类其实可以暂时不用写set方法，不过后面会用到)
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class Dog {
@Value("旺财")
private String name;
@Value("3")
private Integer age;
public Dog() {
}
public Dog(String name, Integer age) {
this.name = name;
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
@Override
public String toString() {
return "Dog{" +
"name='" + name + '\'' +
", age=" + age +
'}';
}
}在测试类验证一下
import com.yuan.pojo.Dog;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class Springboot02ConfigApplicationTests {
@Autowired
private Dog dog;
@Test
void contextLoads() {
System.out.println(dog);
}
}打印输入如下
再新建一个复杂点的实体类Person 并注入到我们的类中
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 = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String name;
private Integer age;
private Boolean happy;
private Date birth;
private Map<String,Object> maps;
private List<Object> list;
private Dog dog;
public Person() {
}
public Person(String name, Integer age, Boolean happy, Date birth, Map<String, Object> maps, List<Object> list, Dog dog) {
this.name = name;
this.age = age;
this.happy = happy;
this.birth = birth;
this.maps = maps;
this.list = list;
this.dog = dog;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public Boolean getHappy() {
return happy;
}
public void setHappy(Boolean happy) {
this.happy = happy;
}
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> getList() {
return list;
}
public void setList(List<Object> list) {
this.list = list;
}
public Dog getDog() {
return dog;
}
public void setDog(Dog dog) {
this.dog = dog;
}
@Override
public String toString() {
return "Person{" +
"name='" + name + '\'' +
", age=" + age +
", happy=" + happy +
", birth=" + birth +
", maps=" + maps +
", list=" + list +
", dog=" + dog +
'}';
}
}我们来使用yaml配置的方式进行注入，大家写的时候注意区别和优势，我们编写一个yaml配置！
person:
name: xiaoming
age: 18
happy: true
birth: 2000/10/01
maps: {k1: v1,k2: v2}
list:
-code
-music
-run
dog:
name: 旺财
age: 3IDEA 提示，springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到一个依赖！
点击打开，跳转链接Configuration Metadata
按照文档提供在pom.xml中导入依赖包,就不会报错了
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>测试
import com.yuan.pojo.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class Springboot02ConfigApplicationTests {
@Autowired
private Person person;
@Test
void contextLoads() {
System.out.println(person);
}
}
加载指定的配置文件
@PropertySource ：加载指定的配置文件；
@ConfigurationProperties：默认从全局配置文件中获取值；
我们去在resources目录下新建一个person.properties文件
name=xiaoming新建Person2，指定配置文件
@Component
@PropertySource(value = "classpath:person.properties")
public class Person2 {
@Value("${name}")
private String name;
//...
}配置文件占位符
配置文件还可以编写占位符生成随机数
person:
name: xiaoming${random.uuid} # 随机uuid
age: ${random.int} # 随机int
happy: true
birth: 1995/11/20
map: {k1: v1, k2: v2}
hello: a
list:
- code
- music
dog:
name: ${person.hello:other}_小黄 # other代表默认值
age: 1打印结果如下
Person{name='zyye360040f-0b1b-4562-b555-fa409901a021', age=218521969, happy=true, birth=Mon Nov 20 00:00:00 CST 1995, map={k1=v1, k2=v2}, list=[code, music], dog=Dog{name='a_小黄', age=1}}
小结：
- ${person.hello:other} 的用法是：当hello没有赋值的时候，直接赋予other值
回顾properties配置
【注意】properties配置文件在写中文的时候，会有乱码 ， 我们需要去IDEA中设置编码格式为UTF-8；
新建一个配置文件user.properties
name=xiaoming
age=18
sex=男新建一个实体类User，并给属性注入值
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
@Component
@PropertySource(value = "classpath:application.properties")
public class User {
/**
* 从配置文件中取值
*/
@Value("${name}")
private String name;
/**
* #{SPEL} Spring表达式
*/
@Value("#{9*2}")
private int age;
/**
* 字面量
*/
@Value("男")
private String sex;
@Override
public String toString() {
return "User{" +
"name='" + name + '\'' +
", age=" + age +
", sex='" + sex + '\'' +
'}';
}
}测试验证
import com.yuan.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class Springboot01IdeaApplicationTests {
@Autowired
private User user;
@Test
void contextLoads() {
System.out.println(user);
}
}
对比小结
@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；我们来看个功能对比图
| @ConfigurationProperties | @Value | |
|---|---|---|
| 功能 | 批量注入配置文件中的属性 | 一个个指定 |
| 松散绑定 | 支持 | 不支持 |
| SPEL | 不支持 | 支持 |
| JSR303数据校验 | 支持 | 不支持 |
| 复杂类型封装 | 支持 | 不支持 |
1. @ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加
2. 松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的，后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下（注意set方法必须修改）
yaml
person:
last-name: xiaoming${random.uuid} # 随机uuid
age: ${random.int} # 随机int
# ....//...
@Component
@ConfigurationProperties(prefix="person")
public class Person {
private String lastName;
//...
public void setLastName(String lastName) {
this.lastName = lastName;
}
//...
}这种也是可以正常输出的
3.JSR303数据校验 ， 这个就是我们可以在字段是增加一层过滤器验证 ， 可以保证数据的合法性
导入jar包
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
</dependency>
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>实体类校验
//...
@Component
@ConfigurationProperties(prefix = "person")
@Validated //数据校验
public class Person {
@NotBlank(message = "姓名不可为空")
private String name;
private int age;
//...
}application.yaml配置类
person:
age: 18测试验证，报错如下
拓展：
部分代码：
@NotNull(message="名字不能为空")
private String userName;
@Max(value=120,message="年龄最大不能查过120")
private int age;
@Email(message="邮箱格式错误")
private String email;
-----------------------
空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false
长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=) string is between min and max included.日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前
@Future 验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern 验证 String 对象是否符合正则表达式的规则
4.复杂类型封装，yml中可以封装对象 ， 使用value就不支持
结论
- 配置yml和配置properties都可以获取到值 ， 强烈推荐 yaml；
- 如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；
- 如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接使用@configurationProperties
扫一扫
1519
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
