YAML 配置文件格式

一、YAML 配置文件格式简介

YAML（YAML Ain’t Markup Language）是一种简洁、直观的数据序列化格式，常用于配置文件。相比于 JSON 或 INI，YAML 更加易读，且支持复杂的数据结构，如嵌套对象和列表。

示例配置文件如下：

server:
  port: 8080
  mode: release

database:
  host: 127.0.0.1
  port: 3306
  user: root
  password: 123456
  name: test_db

log:
  level: info
  file: /var/log/app.log

二、YAML 常见坑点

1. 缩进与空格问题
   YAML 使用空格表示层级关系，不能使用 Tab 键。
   示例：

   server:
    port: 8080  # 正确，两个空格缩进
   

   使用 Tab 会导致解析失败。

2. 冒号后必须留空格

   port:8080  # 错误
   port: 8080 # 正确
   

3. 字符串中包含特殊字符时需加引号

   password: "a:b@123"
   

4. 布尔值与数字自动转换问题
   YAML 会自动识别 true、false、yes、no、on、off 等为布尔类型。
   同时，01 可能被识别为八进制数，应避免此类写法。

5. 中文与编码问题
   若配置文件包含中文，请确保文件编码为 UTF-8（无 BOM）。

三、如何避免 YAML 错误

1. 使用专业编辑器与插件
   推荐使用 VSCode，并安装 redhat.vscode-yaml 插件，可以自动校验缩进与格式。

2. 提供 .example.yaml 模板
   在项目中添加示例配置文件供开发者参考，避免修改原文件时破坏结构。

3. 避免在 YAML 中混合使用不同类型数据
   确保每个字段的数据类型一致，例如日志级别全为字符串，端口号全为整数。