技術標籤：springbootspring

文章目錄

• yaml基礎語法
• • 字面量：普通的值 [ 數字，布林值，字串 ]
  • 物件、Map（鍵值對）
  • 陣列（ List、set ）
  • 修改SpringBoot的預設埠號
• yaml注入配置檔案
• • 原來的方法
  • Yaml方法
• 載入指定的配置檔案
• • `@PropertySource`的使用
  • `@configurationProperties`的使用
  • 結論

yaml基礎語法

說明：語法要求嚴格！

1、空格不能省略

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

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

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

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

k: v

注意：

• “ ” 雙引號，不會轉義字串裡面的特殊字元 ， 特殊字元會作為本身想表示的意思；

  比如 ：

  yaml name: "kuang \n shen"

  輸出 ：

  yaml kuang 換行 shen

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

  比如 ：

  yaml name: ‘kuang \n shen’

  輸出 ：

  yaml 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注入配置檔案

原來的方法

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注入成功，這是原來的辦法。

Yaml方法

我們在編寫一個實體類：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;
}

確認以上配置之後，測試類中測試一下

@SpringBootTest
class DemoApplicationTests {

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

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

}

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

載入指定的配置檔案

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

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

@PropertySource的使用

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

name=kuangshen

2、然後在程式碼中指定載入person.properties檔案

@PropertySource(value = "classpath:person.properties")
@Component //註冊bean
public class Person {

    @Value("${name}")
    private String name;

    ......  
}

3、再次輸出測試一下：指定配置檔案繫結成功

@configurationProperties的使用

配合yaml檔案使用，具體看上邊的程式理解。

結論

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

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

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