Spring Boot2篇 - 三、Spring Boot 配置文件(yaml配置注入)

灰太狼 2023-10-04 16:16 25阅读 0赞

## 三、Spring Boot 配置文件(yaml配置注入) ##

### 3.1 配置文件和yaml语法学习 ###

#### 3.1.1 配置文件 ####

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

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

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

> 比如我们可以在配置文件中修改Tomcat 默认启动的端口号
> 
>     server.port=8081

#### 3.1.2 yaml概述 ####

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

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

*  以前的配置文件，大多数都是使用xml来配置
 *  xml与yaml对比
    
     *  传统xml配置
    
        <server>
            <port>8081<port>
        </server>
    
     *  yaml配置
    
        server：
          prot: 8080

#### 3.1.2 yaml基础语法 ####

说明：语法要求**严格**

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

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

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

> k: v

注意：

*  “ ” 双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；
    
    比如 ：name: “kuang \\n shen” 输出 ：kuang 换行 shen
 *  ‘’ 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出
    
    比如 ：name: ‘kuang \\n shen’ 输出 ：kuang \\n shen

**对象、Map（键值对）**

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

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

student:
        name: qinjiang
        age: 3

行内写法

student: {
        name: qinjiang,age: 3}

**数组（ List、set ）**

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

pets:
     - cat
     - dog
     - pig

行内写法

pets: [cat,dog,pig]

**修改SpringBoot的默认端口号**

server：
      prot: 8080

### 3.2 注入配置文件 ###

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

#### 3.2.1 yaml注入配置文件 ####

*  在springboot项目中的resources目录下新建一个文件 application.yml
 *  编写一个实体类 Dog

/**
     * @author cVzhanshi
     * @create 2021-06-11 15:15
     */
    @Component//注册bean
    public class Dog {
        
        private String name;
        private Integer age;
    ...
    }

*  使用原来的放过给属性注入值 @Value注解

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

*  在SpringBoot的测试类下 测试

@SpringBootTest
    class Springboot02ConfigApplicationTests {
        
        @Autowired
        private Dog dog;
    
        @Test
        void contextLoads() {
        
            System.out.println(dog);
        }
    }

结果成功输出，@Value注入成功  
![在这里插入图片描述][20210611173448843.png]

*  编写一个复杂一点的实体类：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: cvzhanshi
      age: 3
      happy: false
      birth: 2000/01/01
      maps: {
        k1: v1,k2: v2}
      lists:
        - code
        - girl
        - music
      dog:
        name: fdsf
        age: 1

*  把person类引入到容器中，并绑定信息

@Component //注册bean
    @ConfigurationProperties(prefix = "person")
    public class Person {
        
    }

其中@ConfigurationProperties作用：

> 将配置文件中配置的每一个属性的值，映射到这个组件中；  
> 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定  
> 参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应

*  IDEA 提示，springboot配置注解处理器没有找到  
    ![在这里插入图片描述][20210611173436856.png]

解决方法，导入依赖：

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

*  测试

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

结果：所有值全部注入成功  
![在这里插入图片描述][20210611173426984.png]

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

#### 3.2.2 加载指定的配置文件 ####

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

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

*  在resources目录下新建一个**person.properties**文件

name=cvzhanshi

*  在代码中指定加载的文件

@PropertySource(value = "classpath:person.properties")
    @Component //注册bean
    public class Person {
        
    
        @Value("${name}")
        private String name;
        ...
    }

*  测试  
    ![在这里插入图片描述][20210611173412844.png]

#### 3.2.3 配置文件占位符 ####

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

person:
        name: cvzhanshi${
        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}_旺财
          age: 1

#### 3.2.4 回顾properties配置 ####

**上面采用的yaml方法都是最简单的方式，开发中最常用的；也是springboot所推荐的**

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

settings–>FileEncodings 中配置  
![在这里插入图片描述][20210611173401664.png]

*  测试使用步骤
    
     *  新建一个实体类User
    
        @Component //注册bean
        public class User {
              
            private String name;
            private int age;
            private String sex;
        }
    
     *  编辑配置文件 user.properties
    
        user1.name=cvzhanshi
        user1.age=18
        user1.sex=男
    
     *  在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;
        }
    
     *  测试
    
        @Autowired
            private User user;
        
            @Test
            void contextLoads() {
              
                System.out.println(user);
            }

![在这里插入图片描述][20210611173348890.png]

#### 3.2.5 对比小结 ####

@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw_size_16_color_FFFFFF_t_70]

*  @ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加
 *  松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下
 *  JSR303数据校验 ， 这个就是我们可以在字段是增加一层过滤器验证 ， 可以保证数据的合法性
 *  复杂类型封装，yml中可以封装对象 ， 使用value就不支持

**结论：**

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

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

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

### 3.3 JSR303数据校验 ###

#### 3.3.1 JSR303数据校验 的使用 ####

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

*  写个注解让我们的name只能支持Email格式

@Component //注册bean
    @ConfigurationProperties(prefix = "person")
    @Validated  //数据校验
    public class Person {
        
    
        @Email(message="邮箱格式错误") //name必须是邮箱格式
        private String name;
    }

运行结果会报错： default message \[邮箱格式错误\];

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

#### 3.3.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.4 多环境切换 ###

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

#### 3.4.1 多配置文件 ####

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

**例如：**

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

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

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

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

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

#### 3.4.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.4.3 配置文件加载位置 ####

官方外部配置文件说明参考文档中给出的加载位置  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw_size_16_color_FFFFFF_t_70 1]

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

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

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

**SpringBoot会从这四个位置全部加载主配置文件；互补配置；**

[20210611173448843.png]: https://img-blog.csdnimg.cn/20210611173448843.png
[20210611173436856.png]: https://img-blog.csdnimg.cn/20210611173436856.png
[20210611173426984.png]: https://img-blog.csdnimg.cn/20210611173426984.png
[20210611173412844.png]: https://img-blog.csdnimg.cn/20210611173412844.png
[20210611173401664.png]: https://img-blog.csdnimg.cn/20210611173401664.png
[20210611173348890.png]: https://img-blog.csdnimg.cn/20210611173348890.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210611173338216.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20210611204400713.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1NDA4Mzkw,size_16,color_FFFFFF,t_70