springboot学习笔记(Yaml配置注入)

Yaml配置注入

  • Yaml
    • 与properties的对比
    • yaml的运用
      • yaml的高级用法
      • 松散绑定
      • JSR303使用
    • yaml配置读取的优先级
    • yaml配置多个环境配置
    • 自己配的yaml和spring.factories有什么联系

Yaml

与properties的对比

①properties 只能保存键值对!

②yaml可以存储,它对空格的要求十分高!

#普通的键值对
name: xiaoming

#对象
student:
  name: xiaoming
  age: 10

#行内写法
student: {name: xiaozhang,age: 5}

#数组
pet:
  - cat
  - dog

pet: [cat,dog]

yaml的运用

/*
@ConfigurationProperties的作用
将配置文件中配置的每个属性,映射到这个组件中
参数perfix="person":将配置文件中的person下面的所有属性一一对应
*/
@Component//注册bean
@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> lists;
    private Dog dog;
}

yaml的高级用法

person:
  name: xiaoming${random.uuid}
  age: ${random.int}
  happy: True
  birth: 2020/02/05
  maps: {key1: v1, key2: v2}
  lists: [code,music]
  dog:
    name: ${person.hello:hello}_旺财
    age: 4

注意点:不能死专注于使用于一点,要学会变通,利用该方式运用于其他的配置,不单单局限于实体类

spring的绑定方式是:

@PropertySource(value ="classpath:resource.propertits")
public class Person {
	@value("${name}")
    private String name;

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-k2GDno0J-1596442075832)(C:\Users\76532\AppData\Roaming\Typora\typora-user-images\image-20200803141120101.png)]

松散绑定

@Component//注册bean
@ConfigurationProperties(prefix = "person")
public class Dog {
    private String dog-name;
}
dog:
  Dogname: 旺财

dog-name 与 Dogname虽然变量名不一样但仍可以进行绑定

JSR303数据校验:

3.0.0以上的springboot需要配置启动器

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-validationartifactId>
    <version>2.3.2.RELEASEversion>
dependency>

JSR303使用

@Validated
public class Person {
    @Email(message = "邮箱不合法")
    private String name;
}


空检查
@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 对象是否符合正则表达式的规则

yaml配置读取的优先级

  1. file:./config/
  2. file:./config/*/
  3. file:./
  4. classpath:/config/
  5. classpath:/

来自官方文档

https://docs.spring.io/spring-boot/docs/2.3.2.RELEASE/reference/html/spring-boot-features.html#boot-features

yaml配置多个环境配置

一个yaml可以配置多个环境配置,properties配置的话需要多个properties:

server:
  port: 8080
spring:
  profiles:
    active: dev

---
server:
  port: 8081
spring:
  profiles: dev

---
server:
  port: 8082
  spring:
    profiles: test

自己配的yaml和spring.factories有什么联系

springboot一开始会进行自动装配,

//自动装配,我们能找到自动装配的文件是atuoconfigure的jar中WETA-INF中的spring.factories的XXXAutoConfiguration类
@EnableAutoConfiguration
//表示这是一个配置类,在这些配置类中发现都有XXXProperties.class
@Configuration
//默认为XXXProperties.class的属性值
@EnableConfigurationProperties(XXXProperties.class)
//绑定Properties文件,设置前缀,这样yaml和properties就可以修改这些XXXProperties.class的属性值,然后进行自动配置
@ConfigurationProperties(
    prefix = "XXX"
)

所以可以用自己配的yaml可以动态修改springboot的配置并进行自动装配

自动装配原理精髓:

1)springboot 启动会加载大量的自动装配类

2)我们看我们需要的功能有没有在springboot默认写好的自动配置类中

3)我们再看这个自动装配类有哪些组件,只要我们需要的,组件中存在就可不用手动配置

4)给容器自动装配类添加组件的时候,会从properties类中获取某些属性,我们只需要在配置中指定执行属性的值即可

XXXAutoConfiguration:自动配置类:给容器添加组件

XXXProperties:封装配置文件中相关的属性

可以通过debug=true可以看到哪些配置生效

你可能感兴趣的:(springboot学习笔记(Yaml配置注入))