SpringBoot学习记录02——yaml配置

SpringBoot配置文件

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

• application.properties

key1=value1
key2=value2

• application.yaml
  注意：冒号后面的空格一定不能省略

key1: value1
key2: value2

配置文件用于修改SpringBoot自动配置的默认值，因为默认的配置SpringBoot在底层都给我们自动配置好了
例如：修改Tomcat默认端口号

service.port=8081

yaml概述

YAML是"YAML Ain’t a Markup Language"（YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言），但为了强调这种语言以数据做为中心，而不是以标记语言为重点，而用反向缩略语重命名。

YAML的语法和其他高级语言类似，并且可以简单表达清单、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲（例如：许多电子邮件标题格式和YAML非常接近）。尽管它比较适合用来表达层次结构式（hierarchical model）的数据结构，不过也有精致的语法可以表示关系性（relational model）的数据。由于YAML使用空白字符和分行来分隔数据，使得它特别适合用grep/Python/Perl/Ruby操作。其让人最容易上手的特色是巧妙避开各种封闭符号，如：引号、各种括号等，这些符号在嵌套结构时会变得复杂而难以辨认。

yaml配置端口号

service:
	port: 8081

yaml基础语法

yaml语法要求严格

• 空格不能省略

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

• 属性和值的大小写都是十分敏感的

注释

yaml使用#来表示注释，只支持单行注释

# 注释

# 多行
# 多行

基本类型

基本类型包括，数字，字符串，布尔值等
使用键值对来表式，直接将值写在value的位置即可

key1: value1

# 例
name: wcy
age: 18
happy: false

注意，字符串的表示可以不用引号括起来

字符串使用双引号和单引号的区别

• 双引号
  使用双引号表示字符串时，可用倒斜线（\）开始的转义字符表示特殊字符

name: "wcy \n 111"

# 输出 wcy 回车 111

• 单引号

name: 'wcy \n 111'

# 输出 wcy \n 111

对象和map

例如：

• person对象
  表示person对象的三个属性

person:
  name: wcy
  age: 12
  happy: false

或者使用行内写法

person: {name: wcy, age: 12, happy: false}

• map

map:
	k1: v1
	k2: v2 

map: {k1: v1, k2: v2}

数组

用 - value表示数组中的一个元素

例如：

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat, dog, pig]

yaml注入配置文件

在resource目录下创建一个application.yaml配置文件

编写实体类

1. 编写一个实体类 Dog；

@Component  //注册bean到容器中
public class Dog {
    private String name;
    private Integer age;
    
    //有参无参构造、get、set方法、toString()方法  
}

2. 我们原来是使用@Value给bean注入属性值的

@Component //注册bean
public class Dog {
    @Value("阿黄")
    private String name;
    @Value("18")
    private Integer age;
}

3. 在SpringBoot的测试类下注入输出一下；

@SpringBootTest
class DemoApplicationTests {

    @Autowired //自动注入
    Dog dog;

    @Test
    public void contextLoads() {
        System.out.println(dog);
    }
}

结果正常输出

接下来编写一个复杂的实体类用yaml注入

1. 编写person类

@Component
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;
	
	...

2. application.yaml

person:
  name: 'wcy'
  age: 12
  happy: false
  birth: 2000/01/01
  maps:
    k1: v1
    k2: v2
  lists:
    - a
    - b
    - c
  dog:
    name: john
    age: 3

3. 使用@ConfigurationProperties(prefix = “person”)注入配置
   @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> lists;
    private Dog dog;

4. 测试
   输出结果，正常输出

Person{
	name='wcy', 
	age=12, 
	happy=false, 
	birth=Sat Jan 01 00:00:00 CST 2000, 
	maps={k1=v1, k2=v2}, 
	lists=[a, b, c], 
	dog=Dog{name='john', age=3}
}

注释处理器

这是一个可选项

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

配置文件占位符

person:
    name: qinjiang${random.uuid} # 随机uuid
    age: ${random.int}  # 随机int
    happy: false
    birth: 2000/01/01
    maps: {k1: v1,k2: v2}
    lists:
      - code
      - girl
      - music
    dog:
      name: ${person.hello:other}_John  # person.hello存在就取其值，不存在就取后面的值
      age: 1

导入指定配置文件

前面说到，springboot的默认配置文件名为application.yaml
那么要如何配置自己的配置文件呢？

首先来看一下这两个注解

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

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

看来需要用到@PropertySource 注解，测试一下

1. 新建一个person.perproties配置文件

name=wcy`在这里插入代码片`

2. 配置@PropertySource注解

@Component
@PropertySource("classpath:person.properties")
public class Person {
    @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;

3. 测试正常输出

Person{name='wcy', age=null, happy=null, birth=null, maps=null, lists=null, dog=null}

properties配置文件

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

测试：
1、新建一个实体类User

@Component //注册bean
public class User {
    private String name;
    private int age;
    private String sex;
}

2、编辑配置文件 user.properties

user.name=wcy
user.age=18
user.sex=男

3、我们在User类上使用@Value来进行注入！

@Component //注册bean
@PropertySource(value = "classpath:user.properties")
public class User {
    //直接使用@value
    @Value("${user.name}") //从配置文件中取值
    private String name;
    @Value("#{9*2}")  // #{SPEL} Spring表达式
    private int age;
    @Value("男")  // 字面量
    private String sex;
}

4、Springboot测试

@SpringBootTest
class DemoApplicationTests {

    @Autowired
    User user;

    @Test
    public void contextLoads() {
        System.out.println(user);
    }
}

结果正常输出

@ConfigurationProperties和 @Value对比

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

• 松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。

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

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

结论：

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

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

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

JSR303数据校验

先看看如何使用
Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。我们这里来写个注解让我们的name只能支持Email格式；

这里需要导入一个依赖

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

@Component //注册bean
@ConfigurationProperties(prefix = "person")
@Validated  //数据校验
public class Person {

    @Email(message="邮箱格式错误") //name必须是邮箱格式
    private String name;
}

运行结果 ：default message [不是一个合法的电子邮件地址];

使用数据校验，可以保证数据的正确性；

常见参数

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

.......等等
除此以外，我们还可以自定义一些数据校验规则

多环境

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

例如：

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

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

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

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

#比如在配置文件中指定使用dev环境，我们可以通过设置不同的端口号进行测试；
#我们启动SpringBoot，就可以看到已经切换到dev下的配置了；
spring.profiles.active=dev

yaml的多文档块

和properties配置文件中一样，但是使用yml去实现不需要创建多个配置文件，更加方便了 !

server:
  port: 8081
#选择要激活那个环境块
spring:
  profiles:
    active: prod

---
server:
  port: 8083
spring:
  config:
    activate:
      on-profile: dev
---
server:
  port: 8084
spring:
  config:
    activate:
      on-profile: prod

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

配置文件加载位置
外部加载配置文件的方式十分多，我们选择最常用的即可，在开发的资源文件中进行配置！

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件：

优先级1：项目路径下的config文件夹配置文件
优先级2：项目路径下配置文件
优先级3：资源路径下的config文件夹配置文件
优先级4：资源路径下配置文件

优先级由高到底，高优先级的配置会覆盖低优先级的配置；
SpringBoot会从这四个位置全部加载主配置文件；互补配置；