狂神說SpringBoot03：yaml配置注入

狂神說SpringBoot系列連載課程，通俗易懂，基於SpringBoot2.2.5版本，歡迎各位狂粉轉發關注學習。

微信公衆號：狂神說（首發）    Bilibili：狂神說Java（視頻）

未經做者受權，禁止轉載

  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基礎語法

說明：語法要求嚴格！

一、空格不能省略

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

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

 

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

字面量直接寫在後面就能夠 ， 字符串默認不用加上雙引號或者單引號；

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注入配置文件

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

二、編寫一個實體類 Dog；

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

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

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

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

@SpringBootTest class DemoApplicationTests { @Autowired //將狗狗自動注入進來
 Dog dog; @Test public void contextLoads() { System.out.println(dog); //打印看下狗狗對象
 } }

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

 

 五、咱們在編寫一個複雜一點的實體類：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()方法 
}

六、咱們來使用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

七、咱們剛纔已經把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; }

 

八、IDEA 提示，springboot配置註解處理器沒有找到，讓咱們看文檔，咱們能夠查看文檔，找到一個依賴！

 

 

<!-- 導入配置文件處理器，配置文件進行綁定就會有提示，須要重啓 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

 

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

@SpringBootTest class DemoApplicationTests { @Autowired Person person; //將person自動注入進來
 @Test public void contextLoads() { System.out.println(person); //打印person信息
 } }

 

yaml配置注入到實體類徹底OK！

課堂測試：

一、將配置文件的key 值 和 屬性的值設置爲不同，則結果輸出爲null，注入失敗

二、在配置一個person2，而後將 @ConfigurationProperties(prefix = "person2") 指向咱們的person2；

加載指定的配置文件

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

@configurationProperties：默認從全局配置文件中獲取值；

一、咱們去在resources目錄下新建一個person.properties文件

name=kuangshen

二、而後在咱們的代碼中指定加載person.properties文件

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

三、再次輸出測試一下：指定配置文件綁定成功！

 

 

配置文件佔位符

配置文件還能夠編寫佔位符生成隨機數

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 中配置；

 

 

測試步驟：

一、新建一個實體類User

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

二、編輯配置文件 user.properties

user1.name=kuangshen 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; }

四、Springboot測試

@SpringBootTest class DemoApplicationTests { @Autowired User user; @Test public void contextLoads() { System.out.println(user); } }

結果正常輸出：

 

 

對比小結

@Value這個使用起來並不友好！咱們須要爲每一個屬性單獨註解賦值，比較麻煩；咱們來看個功能對比圖

 

 

 

一、@ConfigurationProperties只須要寫一次便可 ， @Value則須要每一個字段都添加

二、鬆散綁定：這個什麼意思呢? 好比個人yml中寫的last-name，這個和lastName是同樣的， - 後面跟着的字母默認是大寫的。這就是鬆散綁定。能夠測試一下

三、JSR303數據校驗 ， 這個就是咱們能夠在字段是增長一層過濾器驗證 ， 能夠保證數據的合法性

四、複雜類型封裝，yml中能夠封裝對象 ， 使用value就不支持

結論：

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

若是咱們在某個業務中，只須要獲取配置文件中的某個值，可使用一下 @value；

若是說，咱們專門編寫了一個JavaBean來和配置文件進行一一映射，就直接@configurationProperties，不要猶豫！