SpringBoot02---yaml配置注入及多环境切换

1. yaml语法学习

1.1 简介

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

application.properties --> 语法结构：key=value
application.yml --> 语法结构：key：空格 value

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

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

传统xml配置：

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

yaml配置：

server：
  prot: 8080

1.2 yaml基础语法

说明：语法要求严格！

空格不能省略
以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。
属性和值的大小写都是十分敏感的。

字面量：普通的值 [ 数字，布尔值，字符串 ]
字面量直接写在后面就可以，字符串默认不用加上双引号或者单引号；

k: v

对象、Map（键值对）

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

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

student:
    name: qc
    age: 23

# 行内写法
student: {name: qc,age: 23}

数组（ List、set ）

pets:
 - cat
 - dog
 - pig

# 行内写法
pets: [cat,dog,pig]

1.3 注入配置文件

编写一个复杂一点的实体类：Person 类

@Component //注册bean到容器中
@ConfigurationProperties(prefix = "person")
@Data
@AllArgsConstructor
@NoArgsConstructor
@Validated  //数据校验
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    @Email(message="邮箱格式错误")
    private String email;
    private Dog dog;
}

编写一个yaml配置

person:
  name: qichao
  age: 24
  happy: true
  birth: 1997/04/05
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - girl
    - music
    - movie
  email: 1169284508@qq.com
  dog:
    name: 旺财
    age: 5

yaml配置的方式进行注入 @ConfigurationProperties

/*
@ConfigurationProperties作用：
将配置文件中配置的每一个属性的值，映射到这个组件中；
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@ConfigurationProperties(prefix = "person")
public class Person {...}

IDEA 提示,添加依赖

<!-- 导入配置文件处理器，配置文件进行绑定就会有提示，需要重启 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

测试类中测试

@SpringBootTest
class DemoApplicationTests {

    @Autowired
    Person person; //将person自动注入进来

    @Test
    public void contextLoads() {
        System.out.println(person); //打印person信息
    }
}

1.4 加载指定的配置文件

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

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

我们去在resources目录下新建一个person.properties文件 name=gaiya
然后在我们的代码中指定加载person.properties文件


@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {

    @Value("${name}")
    private String name;

    ......  
}

1.5 对比小结properties配置

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

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

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

2. JSR303数据校验

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

提示：使用新版IDEA的时候，不能自动导入了，所以我们引入新的依赖后，需要手动刷新下，导入依赖。

<!--引入校验-->
<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 对象是否符合正则表达式的规则

3. 多环境切换

3.1 properties多配置文件

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

但是Springboot并不会直接启动这些配置文件，它默认使用application.properties主配置文件；我们需要通过一个配置来选择需要激活的环境：

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

3.2 yaml的多文档块

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

server:
  port: 8081
#选择要激活那个环境块
spring:
  profiles:
    active: test
---
server:
  port: 8083
spring:
  profiles: dev #配置环境的名称
---
server:
  port: 8084
spring:
  profiles: test  #配置环境的名称

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

3.3 配置文件加载位置

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

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

优先级由高到底，高优先级的配置会覆盖低优先级的配置；

posted @ 2021-07-27 16:23 qi_chao 阅读(596) 评论(0) 编辑收藏举报

刷新页面返回顶部

qi_chao

往事随风，一往无前