Contents：
——————————
1、 yaml概述
2、 yaml基本语法
3、 注入配置文件
4、 和.properities文件进行对比
一. yaml概述
SpringBoot使用一个全局的配置文件 ， 配置文件名称固定为application.properties或application.yaml
（强烈推荐yaml） 配置文件的作用 是: 修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；
例如端口号：
server.port=8081
或：
server:
prot: 8081- application.properties
语法结构 ：key=value- application.yaml
语法结构 ：key： value （中间有一个空格）YAML是 “YAML Ain’t a Markup Language” （YAML不是一种标记语言）的递归缩写。
这种语言以数据作为中心，而不是以标记语言为重点；以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml
传统xml配置：
<server>
<port>8081<port>
</server>yaml配置：
server：
prot: 8080二. yaml基本语法
- yaml的基本语法是：
key: value (中间有一个空格)
1、空格不能省
2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。
3、属性和值的大小写都是敏感。字面量：普通的值 [ 数字，布尔值，字符串 ]
字面量直接写在后面就可以 ， 字符串默认不用加上双引号或者单引号；
k: v
注意：
“ ” 双引号：会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；
eg：
name: "kuang \n shen" 输出 ：kuang 换行 shen
'' 单引号：不会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出
eg：
name: ‘kuang \n shen’ 输出 ：kuang \n shen对象、Map（键值对）
行外写法：
k:
v1:
v2:
行内写法：(去掉换行和缩进，用，衔接不同的属性)
k: {v1: value1,v2: value}
eg:
student:
name: qdl
age: 19
或者：
student: {name: qdl,age: 19}数组（ List、set ）
行内写法：
k: [v11,v2,v3]
行外写法：
k:
-v1
-v2
-v3三. 注入配置文件
yaml文件更强大的地方在于，他可以给我们的实体类直接注入匹配值。这里将用三种方式进行注入：
- 原始的spring方法注入
- 用yaml文件注入
- 用properties文件注入
前期准备
- 新建Student类，并且在容器注册
package com.linxiaode.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.stereotype.Component;
@Component //注册到容器中
//以下是lombok
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
private String name;
private Integer age;
}1. 原始spring方法
- 用@value标签注入属性
@Component //注册到容器中
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
@Value("大宝") //注入默认属性
private String name;
@Value("19") //输入默认属性
private Integer age;
}- 在springBoor的测试类中用 @Autowired自动注入进来，进行测试
测试类
@SpringBootTest
class SpringBoot02ConfigApplicationTests {
@Autowired //自动注入容器中的属性值
Student student;
@Test
void contextLoads() {
System.out.println(student);
}
}- 测试结果
Student(name=大宝, age=19)以上@Value方法适合对象比较小的情况，但是入队对象比较复杂，那就不得不用配置文件的方式进行注入了。
2.yaml文件注入（推荐）
- 首先新建一个比较复杂的类Teacher
package com.linxiaode.pojo;
import ...
@Component //在容器中注册
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Teacher {
private String name;
private boolean isMan;
private Date birth;
private Map<String,Object> map;
private List<Object> lists;
private Student student;
}- 在application.yaml文件中写上要注入的值
//applicatioon.yaml
teacher:
name: qdl
isMan: true
birth: 2000/10/07
map: {speed: 9.8m/s, weight: 60kg}
lists: [code,run,girl]
student:
name: liuwenlong
age: 19- 在类上方用@ConfigurationProperties(prefix = “”) 注入默认属性，而不需要@value
import ...
@Component //在容器中注册
@ConfigurationProperties(prefix = "teacher") //注入属性
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Teacher {
private String name;
private boolean isMan;
private Date birth;
private Map<String,Object> map;
private List<Object> lists;
private Student student;
}可能会出现Spring Boot Configuration Annotation Processor not configured的报错，打开文档导入依赖即可
openDocumentation//依赖
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency>
- 测试
@Autowired
Teacher teacher;
@Test
void testYaml(){
System.out.println(teacher);
}- 测试结果
Teacher(name=qdl, isMan=false, birth=Sat Oct 07 00:00:00 CST 2000, map={speed=9.8m/s, weight=60kg}, lists=[code, run, girl], student=Student(name=liuwenlong, age=19))- 注意：
1.springboot会自动根据名称去yaml文件中匹配属性，如果名称不一致将会得到null值
2.可以配置多个对象，比如配置一个person2，然后将 @ConfigurationProperties(prefix = "person2") 指向我们的person2；进行注入用properties文件注入（不推荐）
- 新建perperties文件，并且写入属性
- 在要注入属性的类上使用注解@PropertySource引入文件，用@Value注入属性：
import ...
@Component //1.在容器中注册类
@PropertySource(value = "classpath:test.properties")//2.引入配置文件
@Data
@AllArgsConstructor
@NoArgsConstructor
public class People {
//3.用Value注入属性
@Value("${}")
private String name;
@Value("${people.age}")
private int age;
}- 测试
@Autowired //自动注入
People people;
@Test
void testProperties(){
System.out.println(people);
}
//结果
People(name=liuwenlong, age=19)四. 和.properities文件进行对比
- @ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加
- 松散绑定：yaml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定
- JSR303数据校验 ， 这个就是我们可以在字段是增加一层过滤器验证 ， 可以保证数据的合法性
- 复杂类型封装，yml中可以封装对象 ， 使用value就不支持
- 另外，在yaml中也可以用占位符进行赋值
Teacher(name=qdl, isMan=false, birth=Sat Oct 07 00:00:00 CST 2000, is=false, map={speed=9.8m/s, weight=60kg},
lists=[code, run, girl], student=Student(name=89cde99a-c8a7-4dbb-b6b4-5f00277d0b67, age=-905847940))五.JSR303数据校验
Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。
- 新建一个类，包含email属性，现在我们可以给他添加@Email校验
import ...
@Component //1.注册类
@ConfigurationProperties(prefix = "person")//2.注入yaml文件中的属性
@Validated //3.开启数据校验，要导入maven依赖spring-boot-starter-validation
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
@Email(message="bad email")//4.开启邮箱校验，可以自定义错误信息
private String email;
}- 测试结果
//yaml
person:
email: qdl.cs.com
//结果
default message [bad email]
//yaml
# 邮箱
person:
email: qdl.cs@
//结果
Person(email=qdl.cs@)常见参数
@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 对象是否符合正则表达式的规则
.......等等
除此以外，我们还可以自定义一些数据校验规则六. 多环境切换
1.yaml的多文档块（更为方便）
profile是Spring对不同环境提供不同配置功能的支持，可以通过激活不同的环境版本，实现快速切换环境
- 在yaml中，不需要定义多个配置文件，就能实现不同的配置，用
— — —三根线划分不同的文档块 - 用 spring.profiles.active: block来切换不同文档块：
#选择要激活那个环境块
spring:
profiles:
active: prod
server:
port: 8081
---
server:
port: 8083
spring:
profiles: dev #配置环境的名称
---
server:
port: 8084
spring:
profiles: prod #配置环境的名称2.properities多配置文件
- 在用properites的方式进行多环境切换的时候，要将文件命名为以下的形式：
application-test.properties 测试环境配置
application-dev.properties 开发环境配置- 这些文件springboot不会启用，但事实他会启用application.properties默认主配置文件，所以在主配置文件中用spring.profile.active=name的形式启用：
spring.profiles.active=test
spring.profiles.active=dev可以方便切换数据库，端口这些信息
七. yaml文件配置文件加载位置
配置位置以相反的顺序搜索。默认情况下，配置的位置可以有4种，优先级由高到低：
file:./config/
file:./config/*/
file:./
classpath:/config/
classpath:/
优先级1：项目路径下的config文件夹配置文件
优先级2：项目路径下配置文件
优先级3：资源路径下的config文件夹配置文件
优先级4：资源路径下配置文件项目打包之后仍然可以指定位置加载配置文件
我们还可以通过spring.config.location来改变默认的配置文件位置
项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；这种情况，一般是后期运维做的多，相同配置，外部指定的配置文件优先级最高
java -jar projectname.jar --spring.config.location=path/application.properties
本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。
