SpringBoot-03 yaml+JSR303

Yaml

1.配置文件

SpringBoot使用一个全局的配置文件，配置文件名称是固定的

YAML是 "YAML Ain't a Markup Language" （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）

这种语言以数据作为中心，而不是以标记语言为重点！

application.properties
- 语法结构：key=value
application.yaml
- 语法结构：key: 空格 value

配置文件的作用：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；

SpringBoot可以有多个配置文件，但是他会自动识别后缀名识别优先级。

2.Yaml配置

通过对比XML、properties、Yaml文件：

比如我们可以在配置文件中修改Tomcat 默认启动的端口号

XML文件

<server>
    <port>8081<port>
</server>

properties文件

server.port=8081

Yaml文件

server:
  port: 8081

这时候访问路径为：http://localhost:8081/ ，端口号已经发生变化。

3.yaml基础语法

语法要求严格：

1、空格不能省略

2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。

3、属性和值的大小写都是十分敏感的。

字面量：普通的值 [ 数字，布尔值，字符串 ]

字面量直接写在后面就可以，字符串默认不用加上双引号或者单引号；

k: v

注意：

“ ” 双引号，不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思；

比如：name: "kuang \n shen" 输出：kuang 换行 shen
'' 单引号，会转义特殊字符，特殊字符最终会变成和普通字符一样输出

比如：name: ‘kuang \n shen’ 输出：kuang \n shen

对象、Map（键值对）

#对象、Map格式
k:
 v1:
 v2:

在下一行来写对象的属性和值得关系，注意缩进；比如：

people:
    name: zc
    age: 20

行内写法

people: {name: zc,age: 20}     #对象用{}

数组（ List、set ）

用 - 值表示数组中的一个元素,比如：

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]    #数组用[]

yaml文件更强大的地方在于，他可以给我们的实体类直接注入匹配值！

4.yaml注入配置文件

该项目中的 class类 都要在 启动类同级目录 下才可以

4.1 @Vlaue注入

1.项目中的resources资源文件夹下新建一个文件 application.yaml

2.创建实体类

@Component           //将实体类注册到容器中
public class people {
    private String name;
    private int age;
    // 有参无参构造方法
    // get、set方法
    // toString()方法
}

3.使用 @Vlaue 注解

  @Component           //将实体类注册到容器中
public class people {
    @Value("zc")
    private String name;
    @Value("20")
    private int age;
    // 有参无参构造方法
    // get、set方法
    // toString()方法
}

4.进行测试

在test中进行，不要在启动器

@SpringBootTest
class ZcApplicationTests {
    @Autowired
    people people;
    @Test
    void contextLoads() {
        System.out.println(people);
    }
}

4.2 Yaml配置文件注入

1.创建一个新的实体类

@Component               //注册bean到容器中
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 people people;
    // 有参无参构造方法
    // get、set方法
    // toString()方法
}

2.在yaml配置文件进行注入

person:
  name: zc
  age: 20
  happy: true
  birth: 2000/10/29
  maps: {k1: v1,k2: v2}
  lists:
    - a
    - b
    - c
  people:
    name: zc
    age: 20

3.注入到实体类中

@ConfigurationProperties作用：
将配置文件中配置的每一个属性的值，映射到这个组件中；
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “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 people people;
    // 有参无参构造方法
    // get、set方法
    // toString()方法
}

4.这时候会出现一个问题，打开后，提示需要加入依赖

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-configuration-processor</artifactId>
      <optional>true</optional>
</dependency>

5.测试运行

@SpringBootTest
class ZcApplicationTests {
    @Autowired
    Person person;
    @Test
    void contextLoads() {
        System.out.println(person);
    }
}

注意：将配置文件的key 值和属性的值设置为不一样，则结果输出为null，注入失败

4.3 加载指定的配置文件

@PropertySource ：加载指定的配置文件；

@configurationProperties：默认从全局配置文件中获取值；

1.在resources共享文件夹下新建一个person.properties文件

name=zc1

2.在我们的实体类中指定加载文件

@Component
@PropertySource(value = "classpath:person.properties")
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 people people;
    // 有参无参构造方法
    // get、set方法
    // toString()方法
}

注意：

@PropertySource() -------@PropertySources()

这两个只差一个s，有时候看不清就会补充出错

在这里使用的是@PropertySource()，只引用了一个资源文件

用法对比：

都可以加载多个配置文件，但是@PropertySources可以添加约束。
@PropertySource(value = {"classpath:person.properties","classpath:test.properties"})
@PropertySources({@PropertySource(value = "classpath:person.properties",ignoreResourceNotFound = true,encoding = "UTF-8"),
        @PropertySource(value = "classpath:test.properties",ignoreResourceNotFound = true,encoding = "UTF-8")})

3.测试运行

@SpringBootTest
class ZcApplicationTests {
    @Autowired
    Person person;
    @Test
    void contextLoads() {
        System.out.println(person);
    }
}

4.4 配置文件占位符

配置文件还可以编写占位符生成随机数

person:
  name: ${random.uuid}      #随机uuid
  age: ${random.int}        #随机int
  happy: true
  birth: 2000/10/29
  maps: {k1: v1,k2: v2}
  lists:
    - a
    - b
    - c
  people:
    name: zc
    age: 20

5.回顾properties配置

上面采用的yaml方法都是最简单的方式。

开发中最常用的；也是springboot所推荐的那我们来唠唠其他的实现方式；

【注意】properties配置文件在写中文的时候，会有乱码，我们需要去IDEA中设置编码格式为UTF-8；

settings--> Editor-->FileEncodings 中配置:

测试案例：

1、新建一个实体类User

@Component
public class User {
    private String name;
    private int age;
    private String sex;
    // 有参无参构造方法
    // get、set方法
    // toString()方法
}

2、编辑配置文件 user.properties

user.name=zc
user.age=20
user.sex=男

3.@Value注入

@Value("${user.name}") //从配置文件中取值
private String name;
@Value("#{9*2}")  // #{SPEL} Spring表达式
private int age;
@Value("男")  // 字面量
private String sex;

4.测试运行

@SpringBootTest
class ZcApplicationTests {
    @Autowired
    User user;
    @Test
    void contextLoads() {
        System.out.println(user);
    }
}

这里测试的是完全引用user.properties的配置

6.Yaml总结

1、@ConfigurationProperties只需要写一次即可， @Value则需要每个字段都添加

2、松散绑定：比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。

3、**JSR303数据校验 **，这个就是在字段是增加一层过滤器验证，可以保证数据的合法性

4、复杂类型封装，yml中可以封装对象 ，使用value就不支持

结论：

配置yml和配置properties都可以获取到值，强烈推荐 yml；

如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；

如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@ConfigurationProperties

JSR303

1.使用方法

Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。

这里来写个注解让我们的name只能支持Email格式；

这里新版本要注意：

需要加上validation启动器

<dependency>
     <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

之后加入注解：

@Component
@ConfigurationProperties(prefix = "person")
@Validated            //数据校验
public class Person {
    @Email()
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private people people;
    // Set/Get方法
    // 有参/无参方法
    // toString()方法
}

运行会发现错误：

2.常见参数

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

3.多配置切换

配置文件可以存放的位置：

1.file:./config/

2.file:./

3.classpath:/config/

4.classpath:/

优先顺序也是按这个1234排序，下图为项目中位置

3.1 多环境配置

profile是Spring对不同环境提供不同配置功能的支持，可以通过激活不同的环境版本，实现快速切换环境

我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml , 用来指定多个环境版本；

例如：

application-test.properties 代表测试环境配置

application-dev.properties 代表开发环境配置

但是Springboot并不会直接启动这些配置文件，它默认使用application.properties主配置文件；

我们需要通过一个配置来选择需要激活的环境：

在application.properties选择你想用的环境配置；

#我们启动SpringBoot，就可以看到已经切换到dev/test下的配置了
spring.profiles.active=test
#或者
spring.profiles.active=dev

3.2 yaml的多文档块

server:
  port: 8081
#选择要激活那个环境块
spring:
  profiles:
    active: dev
---
server:
  port: 8082
spring:
  profiles: dev
---
server:
  port: 8083
spring:
  profiles: test

注意：如果yml和properties同时都配置了端口，并且没有激活其他环境，默认会使用properties配置文件的

个人博客为：

MoYu's HomePage

MoYu's Gitee Blog