SpringBoot中yaml配置注入
配置文件
SpringBoot使用一个全局的配置文件，配置文件名称是固定的
- application.properties
- 语法结构：key=value
- application.yaml
- 语法结构：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: 8081
yaml基础语法
说明：语法要求严格！
- 空格不能省略
- 以缩进来控制层级关系，只要是左边对齐的一列数据都是统一层级的。
- 属性和值的大小都是十分敏感的。
字面量：普通的值[数字，布尔值，字符串]
字面量直接写在后面就可以，字符串默认不需要加双引号和单引号
k: v
注意：
- “ ” 双引号，不会转义字符串里面的特殊字符，特殊字符会作为本身想表达的意思。
- 比如：name："anle \n shen"输出anle换行shen
- ‘’ 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出
- 比如 ：name: ‘anle\n shen’ 输出 ：anle\n shen
对象、Map（键值对）
#对象、Map格式
k:
v1:
v2:
在下一行来写对象的属性和值的关系，注意缩进；比如：
student:
name: anle
age: 18
行列写法：
# 行列写法
students: {name: anle,age: 19}
数组（List、set）
用-值表示数组中的一个元素，比如：
# 数组
pets:
-cat
-dog
-pig
行列写法
petss: [cat,dog,pig]
修改SpringBoot默认的端口号
配置文件中增加，端口号的参数，就可以切换端口；
# 更改端口号
server:
port: 8099
注入配置文件
yaml文件更加强大的地方在于，他可以给我们的实体类直接注入匹配的值
yaml注入配置文件
-
我们先在resources目录下新建一个文件 application.yml
-
在pojo包中创建一个实体类
@Component//注册bean public class Dog { @Value("小黑")//赋值 private String name; @Value("2") private int age; public Dog() { } public Dog(String name, int age) { this.name = name; this.age = age; } /** * 获取 * @return name */ public String getName() { return name; } /** * 设置 * @param name */ public void setName(String name) { this.name = name; } /** * 获取 * @return age */ public int getAge() { return age; } /** * 设置 * @param age */ public void setAge(int age) { this.age = age; } public String toString() { return "Dog{name = " + name + ", age = " + age + "}"; } } -
在测试类中进行测试
@SpringBootTest class Springboot02YamlApplicationTests { @Autowired private Dog dog; //注入Dog类 @Test void contextLoads() { System.out.println(dog); //运行完的结果Dog{name = 小黑, age = 2} } } -
我们在编写一个复杂的People实体类
/** * @author: anle * @date: 2023/05/26 11:26 **/ @Component public class People { private String name; private Integer age; private Boolean happy; private Date birth; private Map<String,Object> maps; private List<Object> lists; private Dog dog; } -
我们来使用yaml配置的方式进行注入，大家写的时候注意区别和优势，我们编写一个yaml配置！
people: name: anle age: 18 happy: false birth: 2022/5/1 maps: {k1: v1,k2: v2,k3: v3} lists: -code -music -girl dog: name: 小花 age: 3 -
我们将刚刚写好的yanl配置注入到实体类中
@Component @ConfigurationProperties(prefix = "people") public class People { private String name; private Integer age; private Boolean happy; private Date birth; private Map<String,Object> maps; private List<Object> lists; private Dog dog; }这里的@ConfigurationProperties注解作用：
将配置文件中配置的每一个属性的值，映射到这个组件中；告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应。
-
在我们使用这个注解后会出这样的爆红提示，我们可以点进去看看
-
我们只需要在maven配置文件中到入相应的依赖就可以了
<!-- 导入配置文件处理器，配置文件进行绑定就会有提示，需要重启 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency> -
我们配置好以后就可以在测试文件中进行测试了
@SpringBootTest class Springboot02YamlApplicationTests { @Autowired private People people; @Test void contextLoads() { System.out.println(people); } }我们看到以下的数据就表示成功了
加载指定的配置文件
**@PropertySource ：**加载指定的配置文件；
@configurationProperties：默认从全局配置文件中获取值；
-
我们在resources目录下新创建一个person.properties文件
name=anle -
然后我们在People实体类中指定person.properties文件
@PropertySource(value = "classpath:person.properties") public class People { //SPEL表达式取出配置文件的值 @Value("${name}") private String name; private Integer age; private Boolean happy; private Date birth; private Map<String,Object> maps; private List<Object> lists; private Dog dog; } -
再次进行测试：指定文件绑定成功！
配置文件占位符
配置文件还可以编写占位符生成随机数
还可以调用上面的方法进行占位符
people:
name: anle${random.uuid}
age: ${random.int}
happy: false
birth: 2022/5/1
maps: {k1: v1,k2: v2,k3: v3}
hello: 李白
lists:
-code
-music
-girl
dog:
name: ${people.hello:hello}_小花
age: 3
回顾properties配置
上面使用yaml方式都是一些简单的方式，开发中最常用的；
【注意】properties配置文件在写中文的时候，会有乱码 ， 我们需要去IDEA中设置编码格式为UTF-8；
settings–>FileEncodings 中配置
测试：
-
新建一个User实体类
@Component //注册bean public class User { private String name; private int age; private String sex; } -
编辑配置文件user.properties
user.name=anle user.age=18 user.sex=男 -
我们在User类上使用@Value来进行注入！
@Component @PropertySource(value = "classpath:user.properties") public class User { @Value("${user.name}") private String name; @Value("${user.age}") private int age; @Value("${user.sex}") private String sex; ....... } -
在springBoot测试类中进行测试
@SpringBootTest class Springboot02YamlApplicationTests { @Autowired private User user; @Test void contextLoads() { System.out.println(user); } } -
我们能正常出结果就成功了！
总结
@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；我们来看个功能对比图
1、@ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加
2、松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下
3、JSR303数据校验 ， 这个就是我们可以在字段是增加一层过滤器验证 ， 可以保证数据的合法性
4、复杂类型封装，yml中可以封装对象 ， 使用value就不支持
结论：
配置yml和配置properties都可以获取到值 ， 强烈推荐 yml；
如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；
如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，毫不犹豫！
说一下什么是松散绑定
-
我们写一个Dog的实体类（注意看我们的名字）
@Component @ConfigurationProperties(prefix = "dog") public class Dog { private String firstName; private int age; } -
在yaml配置中进行配置（注意看这里换成了 -）
dog: first-name: 小黄 age: 10 -
到测试类中进行测试
@SpringBootTest class Springboot02YamlApplicationTests { @Autowired private Dog dog; @Test void contextLoads() { System.out.println(dog); } } -
结果：这样我们的松散绑定就成功了！
JSR303数据校验
如何使用
Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。我们这里来写个注解让我们的name只能支持Email格式；
@Component
@ConfigurationProperties(prefix = "people")
@Validated //数据校验
public class People {
@Email(message = "邮箱格式错误") //这里的name属性必须要为邮箱格式
private String name;
}
运行结果：我们可以看见这里就是我们上面写的错误
注意在这里我们的@Email注解可能会爆红，我们只需要在maven配置文件中导入对应的依赖就行。
<!--导入JSR303依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
使用数据校验，可以保证数据的正确性；
常见的参数
@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 对象是否符合正则表达式的规则
.......等等
除此以外，我们还可以自定义一些数据校验规则
多环境切换
profile是Spring对不同环境提供不同配置功能的支持，可以通过激活不同的环境版本，实现快速切换环境；
ull还有被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 对象是否符合正则表达式的规则
…等等
除此以外，我们还可以自定义一些数据校验规则
多环境切换
profile是Spring对不同环境提供不同配置功能的支持，可以通过激活不同的环境版本，实现快速切换环境；
扫一扫
425
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
