2022.6.9 文件配置与多环境切换

4、文件配置

新建一个springboot项目，删掉多余东西，新建application.yaml

 

 

 

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

  • application.properties

    • 语法结构 ：key=value

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

    settings-->FileEncodings 中配置

     

     

     

  • application.yml/yaml

    • 语法结构 ：key：空格 value

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

yaml(yml)概述

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

以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml

传统xml配置：

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

yaml配置：

 server：  
     prot: 8080

yaml基础语法

说明：语法要求严格！

1、空格不能省略

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

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

对比：

application.yaml

 ​
 # 对象
 student:
   name: xiaoming
   age: 3
 ​
 # 对象行内写法
 student1: {name: xiaoming,age: 3}
 ​
 # 数组
 person:
   - teacher
   - girl
   - boy
 ​
 car: [changcheng,tesila]

application.properties

 # 只能保存键值对
 student.name = xiaoming
 student.age = 3

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

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

 k: v

注意：

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

    比如 ：name: "kuang \n shen" 输出 ：kuang 换行 shen

  • '' 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出

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

修改SpringBoot的默认端口号

配置文件中添加，端口号的参数，就可以切换端口；

 server:
   port: 8082

注入配置文件

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

yaml注入配置文件

1、使用@value

1、在springboot项目中的resources目录下新建一个文件 application.yml

2、编写一个实体类 Dog

 package com.xing.pojo;
 ​
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 ​
 /**
  * @program: springboot-02-config
  * @ClassName:Dog
  * @Date: 2022/06/09
  * @author: 16159
  * @description:
  * @Modified By：
  **/
 ​
 @Component //注册bean到容器中
 @Data
 @AllArgsConstructor
 @NoArgsConstructor
 public class Dog {
     @Value("阿黄")   //相当于name="阿黄"，可以写在set方法上 
     private String name;
     @Value("3")
     private Integer age;
 }
 ​

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

 package com.xing;
 ​
 import com.xing.pojo.Dog;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 ​
 @SpringBootTest
 class SpringbootConfig1ApplicationTests {
 ​
     @Autowired
     private Dog dog;
 ​
     @Test
     void contextLoads() {
         System.out.println(dog);
     }
 ​
 }
 ​

结果成功输出，@Value注入成功，这是我们原来的办法对吧。

 

 

 

2、使用yaml配置文件(@ConfigurationProperties)

1、我们在编写一个复杂一点的实体类：Person 类

 package com.xing.pojo;
 ​
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import org.springframework.stereotype.Component;
 ​
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
 ​
 /**
  * @program: springboot-02-config
  * @ClassName:Person
  * @Date: 2022/06/09
  * @author: 16159
  * @description:
  * @Modified By：
  **/
 @Component //注册bean到容器中
 @Data
 @AllArgsConstructor
 @NoArgsConstructor
 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、我们来使用yaml配置的方式进行注入，大家写的时候注意区别和优势，我们编写一个yaml配置！

 person:
   name: xiaoming
   age: 3
   happy: false
   birth: 2000/01/01
   maps: {k1: v1,k2: v2}
   # list相当于数组
   lists:
     - code
     - girl
     - music
   dog:
     name: 旺财
     age: 1

3、我们刚才已经把person这个对象的所有值都写好了，我们现在来注入到我们的类中！

 /*
 @ConfigurationProperties作用：
 将配置文件中配置的每一个属性的值，映射到这个组件中；
 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
 参数prefix = “person”:将yaml配置文件中的person下面的所有属性一一对应
 */
 ​
 ​
 package com.xing.pojo;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.stereotype.Component;
 ​
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
 /**
  * @program: springboot-02-config
  * @ClassName:Person
  * @Date: 2022/06/09
  * @author: 16159
  * @description:
  * @Modified By：
  **/
 @Component //注册bean到容器中
 @Data
 @AllArgsConstructor
 @NoArgsConstructor
 @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、IDEA 提示，springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到一个依赖，添加就不会报红，不添加也不影响运行

 

 

 

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

5、确认以上配置都OK之后，我们去测试类中测试一下：

 package com.xing;
 ​
 import com.xing.pojo.Person;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 ​
 @SpringBootTest
 class SpringbootConfig1ApplicationTests {
 ​
     @Autowired
     private Person person;
 ​
     @Test
     void contextLoads() {
         System.out.println(person);
     }
 ​
 }
 ​

结果：所有值全部注入成功！

 

 

 

3、使用properties配置文件(@PropertySource )

新建一个test.properties

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

1、我们去在resources目录下新建一个test.properties文件

 name=xiaoming

2、然后在我们的代码中指定加载test.properties文件

使用@PropertySource(value = "classpath:test.properties") //加载指定配置文件，并用//SPEL表达式取出配置文件的值 @Value("${name}")

 package com.xing.pojo;
 ​
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.annotation.PropertySource;
 import org.springframework.stereotype.Component;
 ​
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
 ​
 /**
  * @program: springboot-02-config
  * @ClassName:Person
  * @Date: 2022/06/09
  * @author: 16159
  * @description:
  * @Modified By：
  **/
 @Component //注册bean到容器中
 @Data
 @AllArgsConstructor
 @NoArgsConstructor
 @PropertySource(value = "classpath:test.properties") //加载指定配置文件
 public class Person {
     //SPEL表达式取出配置文件的值
     @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、再次输出测试一下：指定配置文件绑定成功！

 

 

 

4、配置文件占位符

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

 person:
     name: xiaoming${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

 

 

 

对比小结

@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦；我们来看个功能对比图

 

 

 

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

2、松散绑定：这个什么意思呢? 比如我的yaml中写的last-name，这个和lastName是一样的(相当于类中变量名为lastName)， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下

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

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

结论：

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

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

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

 

6、多环境(配置文件)切换

优先级 1：项目路径下的config文件夹配置文件优先级

 

 

2：项目路径下配置文件优先级

 

 

3：资源路径（classpath）下的config文件夹配置文件优先级

 

 

4：资源路径下配置文件

 

 

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

使用properties配置多套配置

例如

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

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

 

 

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

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

application.properties

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

使用yml的多文档块

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

 server:
   port: 8081
 #选择要激活那个环境块
 spring:
   profiles:
     active: test
 ​
 --- #分割文档
 server:
   port: 8083   #dev配置环境的端口号
 spring:
   profiles: dev #配置环境的名称
 ​
 ​
 ---
 ​
 server:
   port: 8084
 spring:
   profiles: test  #配置环境的名称

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

 
posted @ 2022-06-10 10:37  暴躁C语言  阅读(55)  评论(0)    收藏  举报