SpringBoot yaml和properties

yaml語法學習

配置文件

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

• application.yaml
  • 語法結構: key:空格 value
• application.properties
  • 語法結構: key=value

配置文件的作用: 修改SpringBoot自動配置的默認值，因爲SpringBoot在底層都給我們自動配置好了

在application.properties修改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:
  port: 8081

yaml基礎語法

1. 空格不能省略
2. 以縮進來控制層級關係，只要是左邊對齊的一列數據都是同一個層級的
3. 屬性和值的大小寫都是十分敏感的

普通的值【數字，布爾值，字符串】

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

name: 張三

注意:

• “ ” 雙引號，不會轉義字符串裏面的特殊字符 ， 特殊字符會作爲本身想表示的意思
• ‘’ 單引號，會轉義特殊字符 ， 特殊字符最終會變成和普通字符一樣輸出

對象、Map（鍵值對）

對象的屬性和值得關係

#對象、Map
student:
  name: 張三
  age: 18

#行內寫法
student2: {name: 張三2,age: 32}

數組（ List、set ）

用 - 值表示數組中的一個元素

pets:
 - cat
 - dog
 - pig

#行內寫法
pets: [cat,dog,pig]

注入配置文件

yaml文件更強大的地方在於，它可以給我們的實體類直接匹配值

yaml注入配置文件

1. 在SpringBoot項目的resources目錄下創建一個application.yml
2. 編寫一個實體類Dog

@Component //註冊bean
public class Dog {
    private String name;
    private int age;

    //有參無參構造、get、set方法、toString()方法
    }

3. 用@value給bean注入屬性值

    @Value("小黃")
    private String name;
    @Value("3")
    private int age;

4. 在SpringBoot的測試類下注入dog

@SpringBootTest
class DemoApplicationTests {

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

	@Test
	void contextLoads() {
		//打印一下，查看詳細信息
		System.out.println(dog);
	}

}

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

@Component //註冊到bean容器中
public class Person{
    private String name;
    private int age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

    //省略有參無參構造、get、set方法、toString()方法  
}

6. 現在來使用yaml配置的方式進行注入，大家寫的時候注意區別和優勢

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

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. 寫完成之後可能出現，一下報紅
   
   解決方法：pom.xml添加依賴

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

9. 到測試類中進行測試

@SpringBootTest
class DemoApplicationTests {

	@Autowired
	private Person person;

	@Test
	void contextLoads() {
		//打印一下，查看詳細信息
		System.out.println(person);
	}

}

然後yaml配置注入到實體類就完成了

加載指定的配置文件

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

properties配置文件在寫中文的時候，會有亂碼 ， 我們需要去IDEA中設置編碼格式爲UTF-8

1. 在resources目錄下新建一個person.properties文件
   
2. 然後再我們的代碼裏指定加載person.properties文件

@Component //註冊到bean容器中
@PropertySource(value = "classpath:person.properties")
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 ，下面我們就來試試

1. 新建一個實體類User

@Component //註冊到bean
public class User {

    private String name;
    private int age;
    private String sex;
    //省略有參和無參構造、get/set、toString方法
}    

2. 編輯配置文件 user.properties

name=zs
age=18
sex=男

3. 在User類上使用@Value來進行注入！

@Component //註冊到bean
@PropertySource(value = "classpath:user.properties")
public class User {

    @Value("${name}") //從配置文件中取
    private String name;
    @Value("#{10*2}") //Spring表達式
    private int age;
    @Value("男") //字面量
    private String sex;
    ......
}

4. 測試

@SpringBootTest
class DemoApplicationTests {

	@Autowired
	private User user;
	@Test
	void contextLoads() {
		//打印一下，查看詳細信息
		System.out.println(user);
	}

}

對比小結

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

項目	@ConfigurationProperties	@Value
功能	批量注入配置文件中的屬性	一個個指定
鬆散綁定	支持	不支持
SpEL	不支持	支持
JSR303數據效驗	支持	不支持
複雜類型封裝	支持	不支持

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

結論：
配置yml和配置properties都可以獲取到值，但是強烈推薦yml。
如果只需要配置某個值，可以使用@Value；如果是JavaBean來和配置文件一一映射，可以使用@configurationProperties。