SpringBoot-Yaml語法

配置檔案

SpringBoot使用一個全域性的配置檔案 ， 配置檔名稱是固定的

• application.properties

• • 語法結構 ：key=value

• application.yml

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

配置檔案的作用 ：修改SpringBoot自動配置的預設值，因為SpringBoot在底層都給我們自動配置好了；

比如我們可以在配置檔案中修改Tomcat 預設啟動的埠號！測試一下！

server.port=8081

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

yaml基礎語法

說明：語法要求嚴格！

1、空格不能省略

2、以縮排來控制層級關係，只要是左邊對齊的一列資料都是同一個層級的。

3、屬性和值的大小寫都是十分敏感的。

字面量：普通的值 [ 數字，布林值，字串 ]

字面量直接寫在後面就可以 ， 字串預設不用加上雙引號或者單引號；

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:  
	port: 8082

注入配置檔案

yaml檔案更強大的地方在於，他可以給我們的實體類直接注入匹配值！

yaml注入配置檔案

1、在springboot專案中的resources目錄下新建一個檔案 application.yml

2、編寫一個實體類 Dog；

package com.kuang.springboot.pojo;

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

3、思考，我們原來是如何給bean注入屬性值的！@Value，給狗狗類測試一下：

@Component //註冊bean
public class Dog {
    @Value("阿黃")
    private String name;
    @Value("18")
    private Integer age;
}

4、在SpringBoot的測試類下注入狗狗輸出一下；

@SpringBootTest
class DemoApplicationTests {

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

    @Test
    public void contextLoads() {
        System.out.println(dog); //列印看下狗狗物件
    }

}

結果成功輸出，@Value注入成功，這是我們原來的辦法對吧。

5、我們在編寫一個複雜一點的實體類：Person 類

@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()方法  
}

6、我們來使用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

7、我們剛才已經把person這個物件的所有值都寫好了，我們現在來注入到我們的類中！

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

8、IDEA 提示，springboot配置註解處理器沒有找到，讓我們看文件，我們可以檢視文件，找到一個依賴！

<!-- 匯入配置檔案處理器，配置檔案進行繫結就會有提示，需要重啟 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

9、確認以上配置都OK之後，我們去測試類中測試一下：

@SpringBootTest
class DemoApplicationTests {

    @Autowired
    Person person; //將person自動注入進來

    @Test
    public void contextLoads() {
        System.out.println(person); //列印person資訊
    }

}

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

yaml配置注入到實體類完全OK！

課堂測試：

1、將配置檔案的key 值 和 屬性的值設定為不一樣，則結果輸出為null，注入失敗

2、在配置一個person2，然後將 @ConfigurationProperties(prefix = "person2") 指向我們的person2；

載入指定的配置檔案

@PropertySource ：載入指定的配置檔案；

@configurationProperties：預設從全域性配置檔案中獲取值；

1、我們去在resources目錄下新建一個person.properties檔案

name=anti

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方法都是最簡單的方式，開發中最常用的；也是springboot所推薦的！那我們來嘮嘮其他的實現方式，道理都是相同的；寫還是那樣寫；配置檔案除了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=kuangshen
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就不支援

結論：

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

如果我們在某個業務中，只需要獲取配置檔案中的某個值，可以使用一下 @value；

如果說，我們專門編寫了一個JavaBean來和配置檔案進行一一對映，就直接@configurationProperties，不要猶豫！