yaml配置文件與注入

一、yaml語法學習

1. 配置文件

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

• application.properties

• • 語法結構 ：key=value

• application.yml

• • 語法結構 ：key：空格 value

配置文件的作用 ：修改SpringBoot自動配置的默認值，因為SpringBoot在底層已經自動配置好了。如我們可以在配置文件中修改Tomcat 默認啟動的端口號

server.port=8081

2. 什么是yaml

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

3. yaml語法

說明：語法要求嚴格

1、空格不能省略

2、以縮進來控制層級關系，只要是左邊對齊的一列數據都是同一層級

3、屬性和值的大小寫敏感

配置普通數據

字面量：如普通的值 [ 數字，布爾值，字符串 ]

字面量直接寫在后面就可以 ， 字符串默認不用加上雙引號或者單引號

語法： key: value

k: v

注意：

• value之前有一個空格

• “ ” 雙引號不會轉義字符串里面的特殊字符 ， 特殊字符能表達本身想表示的意思

  比如 ：name: "Hello \n Springboot" 輸出 ：Hello 換行 Springboot

• '' 單引號會轉義特殊字符 ， 特殊字符最終會變成和普通字符一樣輸出

  比如 ：name: ‘Hello \n Springboot’ 輸出 ：Hello \n Springboot

配置對象、Map（鍵值對）數據

#對象、Map格式
key: 
	key1: value1
	key2: value2
	
#行內寫法
	key: {key1: value1,key2: value2}

示例代碼：

• person:
    name: java
    age: 18
  
  #或者
  person: {name: haohao,age: 31}
  

配置數組（List、Set）數據

用-值表示數組中的一個元素，注意value與數據之間的 - 之間存在一個空格

#語法：
key: 
	- value1
	- value2
	
#行內寫法
	key: [value1,value2]

二、注入配置文件

yaml文件強大的地方在於可以給實體類直接注入匹配值

1. yaml注入配置文件

① 在springboot項目中的resources目錄下新建一個文件 application.yml

② 編寫一個實體類 Dog

package com.kuang.springboot.pojo;

@Component  //注冊bean到容器中
public class Dog {
    private String name;
    private Integer age;
    
    //有參無參構造、get、set方法、toString()方法  
}

③ 試着用@Value給bean注入屬性值

@Component //注冊bean
public class Dog {
    @Value("旺財")
    private String name;
    @Value("1")
    private Integer age;
}

④ 在SpringBoot的測試類下注入並輸出

@SpringBootTest
class DemoApplicationTests {

    @Autowired //將狗狗自動注入進來
    Dog dog;

    @Test
    public void contextLoads() {
        System.out.println(dog); //打印看下狗狗對象
    }

}

結果成功輸出，@Value注入成功

Dog{name='旺財', age=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 Dog dog;
    
    //有參無參構造、get、set方法、toString()方法  
}

⑥ 使用yaml配置的方式進行注入

寫的時候注意區別和優勢，首先編寫一個yaml配置

person:
  name: qinjiang
  age: 3
  happy: false
  birth: 2000/01/01
  maps: {k1: v1,k2: v2}
  lists:
   - code
   - girl
   - music
  dog:
    name: 旺財
    age: 1

⑦ 把對象的所有值都寫好后，注入到類中

/*
@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 Dog dog;
}

⑧ IDEA 提示，springboot配置注解處理器沒有找到

Not Found

The requested URL /spring-boot/docs/2.3.3.RELEASE/reference/html/configuration-metadata.html was not found on this server.

查看文檔(在網址中更改版本獲得，如回到2.1.9)，找到一個依賴

<!-- 導入配置文件處理器，配置文件進行綁定就會有提示，需要重啟 -->
<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信息
    }

}

結果：所有值全部注入成功

2. 加載指定配置文件

@PropertySource ：加載指定的配置文件；
@configurationProperties：默認從全局配置文件中獲取值

1. 在resources目錄下新建一個person.properties文件

name=hello

2. 在代碼中指定加載person.properties文件

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

3. 再次輸出測試，指定配置文件綁定成功

配置文件占位符

配置文件還可以編寫占位符生成隨機數

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}_旺財
      age: 1

回顧properties配置

上面采用的yaml方法都是最簡單的方式，也是開發中最常用的、pringboot所推薦的

接下來看看其他的實現方式，原理都是相同的，寫還是那樣寫

配置文件除了yml還有之前常用的properties

【注意】properties配置文件在寫中文的時候會有亂碼 ， 需要去IDEA中設置編碼格式為UTF-8：settings-->FileEncodings 中配置

測試步驟

1. 新建一個實體類User

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

2. 編輯配置文件 user.properties

user1.name=Hello
user1.age=18
user1.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);
    }

}

結果正常輸出

對比小結

@Value使用起來並不友好！我們需要為每個屬性單獨注解賦值比較麻煩

1. @ConfigurationProperties只需要寫一次即可 ， @Value則需要每個字段都添加
2. 松散綁定：這個什么意思呢? 比如yml中寫的last-name，這個和lastName是一樣的， - 后面跟着的字母默認是大寫的。這就是松散綁定
3. JSR303數據校驗 ，可以在字段是增加一層過濾器驗證 ， 保證數據的合法性
4. 復雜類型封裝，yml中可以封裝對象 ， 使用value就不支持

結論：

1. 配置yml和配置properties都可以獲取到值 ， 強烈推薦 yml；

2. 如果在某個業務中，只需要獲取配置文件中的某個值，可以使用一下 @value；

3. 如果專門編寫了一個JavaBean來和配置文件進行一一映射，就直接使用@configurationProperties

JSR303數據校驗

Springboot中可以用@validated來校驗數據，如果數據異常則會統一拋出異常，方便異常中心統一處理。這里來寫個注解讓name只能支持Email格式

@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 對象是否符合正則表達式的規則
.......等等
除此以外，我們還可以自定義一些數據校驗規則

三、多環境切換

profile是Spring對不同環境提供不同配置功能的支持，可以通過激活不同的環境版本，實現快速切換環境

多配置文件

在主配置文件編寫的時候，文件名可以是 application-{profile}.properties/yml , 用來指定多個環境版本。例如：application-test.properties 代表測試環境配置 application-dev.properties 代表開發環境配置
但是Springboot並不會直接啟動這些配置文件，它默認使用application.properties主配置文件。但可以通過配置來選擇需要激活的環境

#比如在配置文件中指定使用dev環境，我們可以通過設置不同的端口號進行測試；
#我們啟動SpringBoot，就可以看到已經切換到dev下的配置了；
spring.profiles.active=dev

yml的多文檔塊

和properties配置文件中一樣，但使用yml去實現不需要創建多個配置文件，更加方便

server:
	port: 8081
#選擇要激活那個環境塊
spring:
	profiles:
		active: prod
---
server:
	port: 8083
spring:
	profiles: dev #配置環境的名稱
	
---
server:
	port: 8084
spring:
	profiles: prod #配置環境的名稱

注意：如果yml和properties同時都配置了端口，並且沒有激活其他環境 ， 默認會使用properties配置文件的

配置文件加載位置

外部加載配置文件的方式很多，一般選擇最常用的即可，在開發的資源文件中進行配置

springboot 啟動會掃描以下位置的application.properties或者application.yml文件作為Spring boot的默認配置文件

優先級1：項目路徑下的config文件夾配置文件
優先級2：項目路徑下配置文件
優先級3：資源路徑下的config文件夾配置文件
優先級4：資源路徑下配置文件

優先級由高到底，高優先級的配置會覆蓋低優先級的配置；
SpringBoot會從這四個位置全部加載主配置文件；互補配置