YAML 配置文件語法

SpringBoot 使用 application.properties 或 application.yml 文件作爲全局配置文件(文件名是固定的),用於修改 SpringBoot 自動配置的默認值,本篇主要整理 yml 配置文件的語法。

一、YAML簡介

YAML(YAML Ain’t Markup Language)
​ YAML A Markup Language:是一個標記語言
​ YAML isn’t Markup Language:不是一個標記語言;

標記語言:
​ YAML:以數據爲中心,比json、xml等更適合做配置文件;
​ YAML:配置例子
與以前的xml文件相比,yml 配置文件的語法更簡潔,省去了許多開始結束標籤,但是 yml 配置文件對空格的要求比較嚴格,同一縮進下的內容認爲是同一層級的屬性,此外,配置值時冒號後面必須要加一個空格。

server:
  port: 8081

​ XML:

<server>
	<port>8081</port>
</server>

二、YAML語法:

1、基本語法

k:(空格)v:表示一對鍵值對(空格必須有);

空格的縮進來控制層級關係;只要是左對齊的一列數據,都是同一個層級的

server:
    port: 8081
    path: /hello

屬性和值也是大小寫敏感;

2、值的寫法

(1)字面量:普通的值(數字,字符串,布爾)

​ k: v:字面直接來寫;

​ 字符串默認不用加上單引號或者雙引號;

​ “”:雙引號;不會轉義字符串裏面的特殊字符;特殊字符會作爲本身想表示的意思

​ name: “zhangsan \n lisi”:輸出;zhangsan 換行 lisi

​ ‘’:單引號;會轉義特殊字符,特殊字符最終只是一個普通的字符串數據

​ name: ‘zhangsan \n lisi’:輸出;zhangsan \n lisi

(2)對象、Map(屬性和值)(鍵值對):

​ k: v:在下一行來寫對象的屬性和值的關係;注意縮進

​ 對象還是k: v的方式

friends:
		lastName: zhangsan
		age: 20

行內寫法:

friends: {lastName: zhangsan,age: 18}

(3)集合(List、Set):

用 - (空格) 值 ,表示數組中的一個元素

pets:
 - cat
 - dog
 - pig

行內寫法

pets: [cat,dog,pig]

3、用yml配置文件爲 javaBean 注入值

配置文件

person:
    lastName: hello
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: 12}
    lists:
      - lisi
      - zhaoliu
    dog:
      name: 小狗
      age: 12

javaBean:

/**
 * 將配置文件中配置的每一個屬性的值,映射到這個組件中
 * @ConfigurationProperties:告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定;
 *      prefix = "person":配置文件中person下面的所有屬性進行一一映射
 *
 *@Component: 將類掃描到容器中,只有這個組件是容器中的組件,才能用容器提供的@ConfigurationProperties功能;
 *
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

4、yml配置文件中進行配置時,沒有自動提示的解決方法:

pom.xml 中添加依賴:配置文件處理器,以後編寫 yml 配置文件就有提示了

<!--導入配置文件處理器,配置文件進行綁定就會有提示-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration-processor</artifactId>
			<optional>true</optional>
		</dependency>
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章