學習如何正確編寫Spring Boot項目中的YAML配置文件

2024-03-11

3317

了解YAML基本格式首先需要知道，YAML其實是YAML Ain't Markup Language的縮寫，這兩個后綴（.yml和.yaml）是等價的，類似于jpg和jpeg的關系。 1. 普通

了解YAML基本格式

首先需要知道，YAML其實是YAML Ain't Markup Language的縮寫，這兩個后綴（.yml和.yaml）是等價的，類似于jpg和jpeg的關系。

1. 普通數據類型格式是key: value，注意冒號后是有空格的；YAML格式中冒號后不能直接接value，必須要有一個空格。

2. 對象數據類型格式是，例如：

student:
    name: xiaoming
    age: 13

需要注意的是，縮進多少沒關系，關鍵是要一致以區分層級關系。

3. 字符串集合類型的格式是，例如：

students:
    - xiaoming
    - xiaohong
    - daming

注意短杠后面需要有空格來進行分割。

4. 對象集合類型的格式是，例如：

persons:
    - name: xiaoming
      age: 13
    - name: xiaohong
      age: 12

一個短杠表示一個對象，注意name和age第一個字母要對齊。

5. Map類型的配置，例如：

names:
    name1: xiaoming
    name2: xiaohong

6. 還有一種寫法是不用換行來分隔，俗稱單行配置，用類似JSON的形式來分隔。不過由于可讀性會變差，一般不推薦使用。這里以對象集合的寫法來展示一下：

people: [{name: xiaoming, age: 13}, {name: xiaohong, age: 12}]

在編寫Spring Boot項目的YAML配置文件時，不僅要掌握基本格式，還可以通過一些技巧來更加靈活地配置。

1. 使用環境變量：在YAML文件中可以引用系統環境變量，例如：

spring:
    datasource:
        url: ${DB_URL}

這樣可以使配置文件更具通用性。

2. 多環境配置：可以通過Spring Boot Profiles功能實現針對不同環境的配置，例如application-dev.yml、application-prod.yml等。

3. 引入外部配置：除了自定義的YAML文件，還可以引入外部的properties文件作為配置源。

在編寫YAML配置文件時，可能會出現一些常見的錯誤，需要特別注意避免：

1. 縮進錯誤：YAML文件的層級關系完全依賴于縮進，因此縮進錯誤會導致配置解析錯誤。

2. 冒號與空格：冒號后必須有一個空格來區分鍵值對，否則會被解析為一個字符串。

3. 特殊字符處理：特殊字符如冒號、連字符等需要適當轉義或使用引號包裹。

4. 鍵名重復：在同一層級下鍵名不能重復，否則會導致配置覆蓋或解析錯誤。

5. 單引號與雙引號：在字符串數值中，單引號和雙引號的使用會影響數值的解析方式，需要根據需求選擇合適的引號。

正確編寫YAML配置文件對于Spring Boot項目的啟動和運行至關重要，通過掌握基本格式、靈活運用和避免常見錯誤，可以提高配置文件的可讀性和穩定性，從而更好地管理和維護項目。