2. 程式人生 > 實用技巧 >yaml配置檔案與注入

yaml配置檔案與注入

阿新 • • 發佈：2020-08-22

一、yaml語法學習

1. 配置檔案

SpringBoot使用一個全域性的配置檔案 ， 配置檔名稱是固定的

  • application.properties

    • 語法結構 ：key=value

  • application.yml

    • 語法結構 ：key：空格 value

配置檔案的作用 ：修改SpringBoot自動配置的預設值，因為SpringBoot在底層已經自動配置好了。如我們可以在配置檔案中修改Tomcat 預設啟動的埠號

server.port=8081

2. 什麼是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

3. yaml語法

說明：語法要求嚴格

1、空格不能省略

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

3、屬性和值的大小寫敏感

配置普通資料

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

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

語法： key: value

k: v

注意：

  • value之前有一個空格

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

    比如 ：name: "Hello \n Springboot" 輸出 ：Hello 換行 Springboot

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

    比如 ：name: ‘Hello \n Springboot’ 輸出 ：Hello \n Springboot

配置物件、Map（鍵值對）資料

#物件、Map格式
key: 
	key1: value1
	key2: value2
	
#行內寫法
	key: {key1: value1,key2: value2}

示例程式碼：

  • person:
  name: java
  age: 18

#或者
person: {name: haohao,age: 31}

配置陣列（List、Set）資料

用-值表示陣列中的一個元素，注意value與資料之間的 - 之間存在一個空格

#語法：
key: 
	- value1
	- value2
	
#行內寫法
	key: [value1,value2]

二、注入配置檔案

yaml檔案強大的地方在於可以給實體類直接注入匹配值

1. 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()方法  
}

③ 試著用@Value給bean注入屬性值

@Component //註冊bean
public class Dog {
    @Value("旺財")
    private String name;
    @Value("1")
    private Integer age;
}

④ 在SpringBoot的測試類下注入並輸出

@SpringBootTest
class DemoApplicationTests {

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

    @Test
    public void contextLoads() {
        System.out.println(dog); //列印看下狗狗物件
    }

}

結果成功輸出，@Value注入成功

Dog{name='旺財', age=1}

⑤ 再編寫一個複雜點的實體類

@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

⑦ 把物件的所有值都寫好後，注入到類中

/*
@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配置註解處理器沒有找到

Not Found

The requested URL /spring-boot/docs/2.3.3.RELEASE/reference/html/configuration-metadata.html was not found on this server.

檢視文件(在網址中更改版本獲得，如回到2.1.9)，找到一個依賴

<!-- 匯入配置檔案處理器，配置檔案進行繫結就會有提示，需要重啟 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

⑨ 確認以上配置都完成後，去測試類中測試

@SpringBootTest
class DemoApplicationTests {

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

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

}

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

2. 載入指定配置檔案

@PropertySource ：載入指定的配置檔案；
@configurationProperties：預設從全域性配置檔案中獲取值

  1. 在resources目錄下新建一個person.properties檔案
name=hello
  1. 在程式碼中指定載入person.properties檔案
@PropertySource(value = "classpath:person.properties")
@Component //註冊bean
public class Person {
    @Value("${name}")
    private String name;
    ......
}
  1. 再次輸出測試，指定配置檔案繫結成功

配置檔案佔位符

配置檔案還可以編寫佔位符生成隨機數

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方法都是最簡單的方式，也是開發中最常用的、pringboot所推薦的

接下來看看其他的實現方式，原理都是相同的，寫還是那樣寫

配置檔案除了yml還有之前常用的properties

【注意】properties配置檔案在寫中文的時候會有亂碼 ， 需要去IDEA中設定編碼格式為UTF-8：settings-->FileEncodings 中配置

測試步驟

  1. 新建一個實體類User
@Component //註冊bean
public class User {
    private String name;
    private int age;
    private String sex;
}
  1. 編輯配置檔案 user.properties
user1.name=Hello
user1.age=18
user1.sex=男
  1. 在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;
}
  1. Springboot測試
SpringBootTest
class DemoApplicationTests {

    @Autowired
    User user;

    @Test
    public void contextLoads() {
        System.out.println(user);
    }

}

結果正常輸出

對比小結

@Value使用起來並不友好！我們需要為每個屬性單獨註解賦值比較麻煩

  1. @ConfigurationProperties只需要寫一次即可 ， @Value則需要每個欄位都新增
  2. 鬆散繫結：這個什麼意思呢? 比如yml中寫的last-name，這個和lastName是一樣的， - 後面跟著的字母預設是大寫的。這就是鬆散繫結
  3. JSR303資料校驗 ，可以在欄位是增加一層過濾器驗證 ， 保證資料的合法性
  4. 複雜型別封裝，yml中可以封裝物件 ， 使用value就不支援

結論：

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

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

  3. 如果專門編寫了一個JavaBean來和配置檔案進行一一對映，就直接使用@configurationProperties

JSR303資料校驗

Springboot中可以用@validated來校驗資料，如果資料異常則會統一丟擲異常，方便異常中心統一處理。這裡來寫個註解讓name只能支援Email格式

@Component //註冊bean
@ConfigurationProperties(prefix = "person")
@Validated //資料校驗
public class Person {
    @Email(message="郵箱格式錯誤") //name必須是郵箱格式
    private String name;
}

執行結果：default message [不是一個合法的電子郵件地址]

使用資料校驗，可以保證資料的正確性； 下面列出一些常見的使用

@NotNull(message="名字不能為空")
private String userName;
@Max(value=120,message="年齡最大不能查過120")
private int age;
@Email(message="郵箱格式錯誤")
private String email;

空檢查
@Null 驗證物件是否為null
@NotNull 驗證物件是否不為null, 無法查檢長度為0的字串
@NotBlank 檢查約束字串是不是Null還有被Trim的長度是否大於0,只對字串,且會去掉前後空
格.
@NotEmpty 檢查約束元素是否為NULL或者是EMPTY.
Booelan檢查
@AssertTrue 驗證 Boolean 物件是否為 true
@AssertFalse 驗證 Boolean 物件是否為 false
長度檢查
@Size(min=, max=) 驗證物件（Array,Collection,Map,String）長度是否在給定的範圍之內
@Length(min=, max=) string is between min and max included.
日期檢查
@Past 驗證 Date 和 Calendar 物件是否在當前時間之前
@Future 驗證 Date 和 Calendar 物件是否在當前時間之後
@Pattern 驗證 String 物件是否符合正則表示式的規則
.......等等
除此以外，我們還可以自定義一些資料校驗規則

三、多環境切換

profile是Spring對不同環境提供不同配置功能的支援，可以通過啟用不同的環境版本，實現快速切換環境

多配置檔案

在主配置檔案編寫的時候，檔名可以是 application-{profile}.properties/yml , 用來指定多個環境版本。例如：application-test.properties 代表測試環境配置 application-dev.properties 代表開發環境配置
但是Springboot並不會直接啟動這些配置檔案，它預設使用application.properties主配置檔案。但可以通過配置來選擇需要啟用的環境

#比如在配置檔案中指定使用dev環境，我們可以通過設定不同的埠號進行測試；
#我們啟動SpringBoot，就可以看到已經切換到dev下的配置了；
spring.profiles.active=dev

yml的多文件塊

和properties配置檔案中一樣，但使用yml去實現不需要建立多個配置檔案，更加方便

server:
	port: 8081
#選擇要啟用那個環境塊
spring:
	profiles:
		active: prod
---
server:
	port: 8083
spring:
	profiles: dev #配置環境的名稱
	
---
server:
	port: 8084
spring:
	profiles: prod #配置環境的名稱

注意：如果yml和properties同時都配置了埠，並且沒有啟用其他環境 ， 預設會使用properties配置檔案的

配置檔案載入位置

外部載入配置檔案的方式很多，一般選擇最常用的即可，在開發的資原始檔中進行配置

springboot 啟動會掃描以下位置的application.properties或者application.yml檔案作為Spring boot的預設配置檔案

優先順序1：專案路徑下的config資料夾配置檔案
優先順序2：專案路徑下配置檔案
優先順序3：資源路徑下的config資料夾配置檔案
優先順序4：資源路徑下配置檔案

優先順序由高到底，高優先順序的配置會覆蓋低優先順序的配置；
SpringBoot會從這四個位置全部載入主配置檔案；互補配置

相關推薦

yaml配置檔案與注入

一、yaml語法學習 1. 配置檔案 SpringBoot使用一個全域性的配置檔案 ， 配置檔名稱是固定的

基於Python和PyYAML讀取yaml配置檔案資料

一、首先我們需要安裝 PyYAML 第三方庫 直接使用 pip install PyYAML 就可以（這裡我之前是裝過的，所以提示我PyYAML已經在這個目錄下了，是5.1.2版本的）

使用python檢查yaml配置檔案是否符合要求

我就廢話不多說了，大家還是直接看程式碼吧！ # coding=utf-8 import logging import yaml

Python yaml配置檔案

yaml檔案介紹 yaml是一個專門用來寫配置檔案的語言。 yaml檔案規則 區分大小寫 使用縮排表示層級關係

SpringBoot02--將application.yaml配置檔案中的屬性和元件中的屬性進行繫結

1、在resource下建立一個application.yaml檔案 person: name: zhangsan age: 20 birth: 1998/02/01 list:

@ConfigurationProperties註解將配置檔案值注入到Java Bean

轉自：https://blog.csdn.net/lzb348110175/article/details/105139372 1.yml 配置檔案值注入 2.properties 配置檔案值注入

【Flutter 實戰】pubspec.yaml 配置檔案詳解

老孟導讀：pubspec.yaml 檔案是 Flutter 中非常重要的配置檔案，下面就讓我們看看裡面各個配置的含義。

檔案格式和副檔名不匹配.檔案可能已損壞_spring boot 學習筆記5（application.yaml 配置檔案）

技術標籤：檔案格式和副檔名不匹配.檔案可能已損壞 YAML檔案格式是Spring Boot支援的一種JSON超集檔案格式，相較於傳統的Properties配置檔案，

springboot自定義yaml配置檔案

Spring Boot的預設不支援yaml檔案，需要自定義一個factory import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;

QT: QSettings讀配置檔案與c讀配置檔案

技術標籤：QT基礎到高階c++基礎到高階c基礎到高階 #include <QSettings > //建立配置檔案

SOCKS5轉PPTP VTWORAY配置檔案與IPTables配置檔案

VTWOray { \"log\": { \"access\": \"/var/log/vTWOray/access.log\", \"loglevel\": \"warning\" }, \"inbounds\": [{

Yaml 配置檔案解析Map-SnakeYAML

技術標籤：java學習筆記ymljavaSnakeYamlyml 如何使用SnakeYAML來讀取YAML（YML為其簡寫）配置檔案；讀取後，裝載成Map，而Map如何儲存的配置檔案的資料。

python pyyaml操作yaml配置檔案

在測試工作中，可以使用yaml編寫測試用例，執行測試用例時直接獲取yaml中的用例資料進行測試（如：介面自動化測試）

Springboot配置檔案與配置類的屬性對映方式

一、使用註解@Value對映 我們可以通過@Value註解將配置檔案中的值對映到一個Spring管理的Bean的欄位上

properties,xml,yaml配置檔案解析

讀取幾種配置檔案 java中，常見幾種配置檔案有：.properties,.xml,.yml，spring專案中對這些型別的配置檔案通常有現成可用的封裝，下面用手動解析的方式來操作這些型別配置檔案；

Python讀取YAML配置檔案【簡易版】

自動化測試過程中，引數配置可以放在YMAL檔案管理，以list或者dict資料格式存放參數，Python指令碼能夠方便讀取YAML檔案內容。

springboot學習二 配置檔案與自動配置

2.1、idea建立的maven專案結構 \".gitignore\": 用git做版本控制時 用這個檔案控制那些檔案或資料夾 不被提交（不用git的話可刪除 沒影響）

Deployment.yaml配置檔案剖析

Deployment.yaml 配置檔案剖析 apiVersion: extensions/v1beta1 # 指定api的版本,此值必須在kubectl api-versions中,以“組/版本”的格式

Golang實現yaml配置檔案的載入

配置檔案載入 yaml檔案 yaml中一部分程式碼 # catering Global Configuration # jwt configuration

WCF配置檔案與檔案下載之坎坷路

題外話：本以為我會WCF了，精通WCF了，畢竟剛做過一個WCF的專案，不就是寫寫契約介面，然後實現介面，改下配置。最後用控制檯或者服務釋出一下，不就能用了。不就是簡單ABC嗎？不是So Easy嗎？做第二個專案的時候我