yaml語法學習

關于作者

作者介紹

🍓 博客主頁：作者主頁

🍓 簡介：JAVA領域優質創作者🥇、一名在校大三學生🎓、在校期間參加各種省賽、國賽，斬獲一系列榮譽🏆，

🍓 關注我：關注我學習資料、檔案下載統統都有，每日定時更新文章，勵志做一名JAVA資深程式猿👨?💻，

組態檔

SpringBoot使用一個全域的組態檔，組態檔名稱是固定的

application.properties
- 語法結構：key=value
application.yaml
- 語法結構：key：空格 value

**組態檔的作用：**修改SpringBoot自動配置的默認值，因為SpringBoot在底層都給我們自動配置好了；

比如我們可以在組態檔中修改Tomcat 默認啟動的埠號！測驗一下！

server:
  port: 8081

YAML

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.yaml
撰寫一個物體類 Dog；

package com.sxau.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

import javax.validation.constraints.Email;


@Data//set、get方法
@AllArgsConstructor//lombok注解有參構造
@NoArgsConstructor//lombok注解無參構造
@Component//注冊bean
@Validated
public class Dog {

  @Value("旺財")
  private String lastName;
  @Value("3")
  private Integer age;

}

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

@Component //注冊bean
public class Dog {
   @Value("旺財")
  private String lastName;
  @Value("3")
  private Integer age;
}

在SpringBoot的測驗類下注入狗狗輸出一下；

package com.sxau;

import com.sxau.pojo.Dog;
import com.sxau.pojo.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class Springboot02ConfigApplicationTests {
    @Autowired//必須裝配
    Dog dog;
    
    @Test
    void contextLoads() {
        System.out.println(dog);
    }

}

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

我們在撰寫一個復雜一點的物體類：Person 類

package com.sxau.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;

@Data//set、get方法
@AllArgsConstructor//lombok注解有參構造
@NoArgsConstructor//lombok注解無參構造
@Component
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;
}

我們來使用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這個物件的所有值都寫好了，我們現在來注入到我們的類中！

package com.sxau.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;

@Data
@AllArgsConstructor
@NoArgsConstructor
/*
@ConfigurationProperties作用：
將組態檔中配置的每一個屬性的值，映射到這個組件中；
告訴SpringBoot將本類中的所有屬性和組態檔中相關的配置進行系結
引數 prefix = “person” : 將組態檔中的person下面的所有屬性一一對應
*/
@Component
@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配置注解處理器沒有找到，讓我們看檔案，我們可以查看檔案，找到一個依賴！

注解@ConfigurationProperties(prefix = “person”)

在pom中匯入依賴

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

確認以上配置都OK之后，我們去測驗類中測驗一下：

@SpringBootTest
class Springboot02ConfigApplicationTests {
    @Autowired
    private Person person;
    @Test
    void contextLoads() {
        System.out.println(person);
    }

}

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

Person(name=qinjiang09573531-6959-4dab-9f2e-85d02f1e18b8, age=1645918254, happy=false, birth=Sat Jan 01 00:00:00 CST 2000, maps={k1=v1, k2=v2}, lists=[code, girl, music], dog=Dog(lastName=null, age=1))

如果出現以下全是空值問題：

是因為在Person.java類

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

加載指定的組態檔

**@PropertySource ：**加載指定的組態檔；
@configurationProperties：默認從全域組態檔中獲取值；

我們去在resources目錄下新建一個sxau.properties檔案
```
name=zhangmazi
```

然后在我們的代碼中指定加載sxau.properties檔案

package com.sxau.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
//加載指定組態檔
@PropertySource(value = "classpath:sxau.properties")
public class Person {
    @Value("${name}")
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

再次輸出測驗一下：指定組態檔系結成功！

組態檔占位符

組態檔還可以撰寫占位符生成亂數

person:
  name: qinjiang${random.uuid}
  age: ${random.int}
  happy: false
  birth: 2021/09/22
  maps: { k1: v1,k2: v2 }
  hello: happy
  lists:
    - code
    - girl
    - music
  dog:
    name: ${person.hello:hello}___旺財
    age: 3

回顧properties配置

我們上面采用的yaml方法都是最簡單的方式，開發中最常用的；
也是springboot所推薦的！
那我們來嘮嘮其他的實作方式，道理都是相同的；寫還是那樣寫；組態檔除了yml還有我們之前常用的properties ，我們沒有講，我們來嘮嘮！

【注意】properties組態檔在寫中文的時候，會有亂碼，我們需要去IDEA中設定編碼格式為UTF-8；settings–>Editor–>File Encodings 中配置；

1595468231075

對比小結

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

	@ConfigurationProperties	@Value
功能	批量注入組態檔中的屬性	一個個指定
松散系結	支持	不支持
SpEL	不支持	支持
JSR303資料校驗	支持	不支持
復雜型別封裝	支持	不支持

@ConfigurationProperties只需要寫一次即可， @Value則需要每個欄位都添加
松散系結：這個什么意思呢? 比如我的yml中寫的last-name，這個和lastName是一樣的， - 后面跟著的字母默認是大寫的，這就是松散系結，可以測驗一下
JSR303資料校驗，這個就是我們可以在欄位是增加一層過濾器驗證，可以保證資料的合法性
復雜型別封裝，yml中可以封裝物件，使用value就不支持

結論：

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

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

如果說，我們專門撰寫了一個JavaBean來和組態檔進行一一映射，就直接**@configurationProperties**，不要猶豫！

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/302637.html

標籤：java

上一篇：Java 8 資料過濾，removeIf 和 filter 別用錯了！！

下一篇：Spring Boot入門

全網最詳細的SpringBoot學習-day03