前言
在现代应用开发中，YAML 文件因其简洁和结构化的语法特点，逐渐成为配置文件的主流选择之一。尤其是在 Spring Boot 等框架中，YAML 常被用来替代传统的 .properties 文件作为配置文件，以其直观的层级结构和良好的可读性，方便开发者管理复杂的配置项。本文将详细介绍如何使用 YAML 文件编写属性文件，讨论其键值格式、层级关系表示方式，最后介绍两种配置信息获取方式，包括 @Value 注解和 @ConfigurationProperties 注解，并深入探讨其在实际项目中的应用。
1. YAML 文件的基本格式
YAML 文件的全称是 “YAML Ain’t Markup Language”，其语法与 JSON 类似，但去除了大括号、逗号等符号，通过缩进和冒号表达层级关系和键值对。YAML 采用简洁的格式，通过空格和缩进来标识数据的层级和关联，便于人类读取和编辑。我们来看 YAML 文件的几种主要格式和语法要求。
1.1 键值对格式
YAML 文件的每一行由键值对组成，键和值之间使用冒号 : 分隔，冒号后要有一个空格。例如：
server:
port: 8080
在这个例子中，server 是顶级键，而 port 是 server 的子键，表示应用服务的端口号。这种方式使得文件结构更加清晰，避免了因符号而造成的误解。
1.2 缩进与层级关系
YAML 使用空格缩进表示层级关系，通常建议使用两个空格为一层级，而不推荐使用 Tab 键。YAML 对缩进非常敏感，不同层级的键需要严格按照空格对齐。例如：
database:
url: jdbc:mysql://localhost:3306/mydb
username: root
password: pass123
在这个示例中，database 是顶级键，url、username 和 password 是其子键。各层级之间应保持一致的缩进，否则 YAML 解析器会报错。
1.3 对齐与格式规范
在同一层级的键应当对齐，确保代码的可读性。良好的 YAML 文件格式不仅能帮助开发人员快速定位配置项，还能减少团队协作中的沟通成本。对于复杂的配置项，建议分层次地列出所有键名，并保持一致的缩进格式。
2. YAML 文件的常见应用场景
YAML 文件不仅适用于应用配置文件，还常用于数据序列化、环境变量管理等场景。在 Spring Boot 应用中，application.yml 文件经常用于配置应用的端口、数据库连接、日志级别等内容。以下是一些常见的 YAML 配置示例。
2.1 服务配置
例如，在配置应用服务器的端口和上下文路径时，可以使用如下的 YAML 配置：
server:
port: 8080
servlet:
context-path: /myapp
在这个配置中，server 是顶层键，用于配置服务器的相关信息，port 和 servlet 是其子键，context-path 表示应用的上下文路径。
2.2 数据库配置
在应用中配置数据库连接时，可以将数据库相关的信息结构化为多层级的键值对，清晰明了：
database:
driverClassName: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mydb
username: root
password: pass123
通过这样的分层结构，可以轻松管理数据库连接所需的不同信息，并在同一文件中直观地了解配置内容。
3. 获取 YAML 文件中的配置信息
在 Spring Boot 中，有多种方法可以从 YAML 文件中获取配置信息。最常见的两种方法是 @Value 注解和 @ConfigurationProperties 注解。以下是对这两种方法的详细介绍和使用示例。
3.1 使用 @Value 注解获取配置
@Value 注解用于将配置文件中的值注入到 Spring Bean 中。通过该注解，可以直接在代码中读取指定的配置项。语法如下：
@Value("${server.port}")
private int serverPort;
在这里，@Value("${server.port}") 将 server.port 的值注入到 serverPort 变量中。值得注意的是，@Value 注解中的键名需要与 YAML 文件中的键名完全一致，否则将导致解析错误。
@Value 注解适合用在需要单一配置值的场景。例如，应用程序的端口号、数据库连接信息等。在这些场景下，@Value 注解可以直接将配置信息注入到相关的变量中，使得代码简洁直观。
3.2 使用 @ConfigurationProperties 注解获取配置
@ConfigurationProperties 注解用于将一组配置项注入到一个类中，尤其适用于配置项较多的场景。@ConfigurationProperties 支持前缀过滤，因此非常适合管理带有相同前缀的多项配置。定义格式如下：
@ConfigurationProperties(prefix = "database")
public class DatabaseProperties {
private String url;
private String username;
private String password;
// getter和setter方法省略
}
在 YAML 文件中，可以配置以下内容：
database:
url: jdbc:mysql://localhost:3306/mydb
username: root
password: pass123
Spring 会自动将 database 前缀的配置项映射到 DatabaseProperties 类的对应字段中。这样可以简化代码的维护，使得代码结构更加清晰和模块化。
@ConfigurationProperties 适用于复杂配置的场景，例如数据库连接配置、文件存储配置、邮件服务器配置等。在这些场景中，使用 @ConfigurationProperties 可以将同类配置信息集中到一个类中，便于管理和维护。
4. YAML 文件编写的最佳实践
在实际开发中，合理使用 YAML 文件可以提高配置的可读性和灵活性。以下是一些 YAML 文件编写的最佳实践。
4.1 合理组织层级结构
在书写 YAML 文件时，应根据实际需求合理设计层级结构，将相关的配置项归纳到同一个顶层键下。例如，将数据库相关的配置放入 database 顶层键下，将服务配置放入 server 键下。这样便于查看和管理，提高文件的整洁性和可读性。
4.2 避免使用 Tab 键
YAML 文件对空格敏感，使用 Tab 键容易导致缩进错误，建议统一使用两个空格缩进，避免因缩进问题而引发解析错误。
4.3 使用注释解释关键配置
在配置较多或配置项较复杂的 YAML 文件中，可以适当使用注释解释关键配置项，以便在未来维护和更新时更加直观。YAML 中的注释以 # 开头，例如：
server:
port: 8080 # 应用服务端口
结语
YAML 文件以其简洁、直观的格式，逐渐成为应用开发中的配置文件首选。通过本文的介绍，我们学习了 YAML 文件的基本格式、常见应用场景以及在 Spring Boot 中的配置信息获取方式。通过 @Value 注解和 @ConfigurationProperties 注解，可以有效地将配置文件中的内容注入到代码中，提升开发效率。希望本文的内容能帮助您更好地理解和应用 YAML 配置文件，为开发工作增色添彩。
