Spring Boot 中 YAML 文件自定义配置的读取与使用

作者:谁偷走了我的奶酪2024.01.17 15:58浏览量:121

简介:介绍如何在 Spring Boot 项目中读取和使用 YAML 文件中的自定义配置,包括字符串、数组、对象和集合的配置方式。

Spring Boot 提供了方便的配置管理功能,其中 YAML(.yml.yaml)文件是常用的配置文件格式。通过 YAML 文件,我们可以轻松地定义和配置应用程序的各种参数。下面将介绍如何在 Spring Boot 项目中读取和使用 YAML 文件中的自定义配置,包括字符串、数组、对象和集合的配置方式。
1. 添加依赖
首先,确保你的 pom.xml 文件中包含了 Spring Boot 的相关依赖。例如:

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter</artifactId>
  4. </dependency>

2. 创建 YAML 文件
src/main/resources 目录下创建一个名为 application.yml 的文件。这是默认的 YAML 配置文件名,你也可以根据需要更改。
3. 配置 YAML 文件
application.yml 文件中,你可以定义各种配置项。下面是一些示例:

  • 字符串配置
    1. myapp:
    2. name: my-app
    3. version: 1.0.0
  • 数组配置
    1. myapp:
    2. colors: [red, blue, green]
  • 对象配置
    1. myapp:
    2. user:
    3. name: John Doe
    4. age: 30
  • 集合配置
    对于 Java 的集合类型(如 ListSet 等),可以使用 YAML 的数组表示法。例如:
    1. myapp:
    2. fruits: [apple, banana, cherry]
    4. 在 Java 代码中读取 YAML 配置
    接下来,你可以在 Java 代码中读取这些配置。首先,创建一个 Java 类,用于存储这些配置:
    1. import org.springframework.boot.context.properties.ConfigurationProperties;
    2. import org.springframework.stereotype.Component;
    3. import java.util.List;
    4. import java.util.Map;
    5. import java.util.Set;