详解SpringBoot读取Yml配置文件的3种方法

下面我将为您详细讲解“详解SpringBoot读取Yml配置文件的3种方法”的完整攻略。

一、前言

在 Spring Boot 中我们经常会使用 application.yml 或 application.properties 进行配置，这是一种非常方便的方式。在本文中，我们将详细讲解如何在 Spring Boot 中读取 Yml 配置文件，并且提供三种不同的读取方式。

二、使用 @Value 读取 Yml 配置

在 Spring Boot 中使用 @Value 注解可以很方便地获取 Yml 配置文件的值。

示例代码如下：

@Component
public class MyComponent {
    @Value("${my-config.name}")
    private String name;

    @Value("${my-config.age}")
    private Integer age;

    public void print() {
        System.out.println("My name is " + name + ", and my age is " + age);
    }
}

在上述代码中，我们通过 @Value 注解获取了 my-config.name 和 my-config.age 两个配置项的值，分别是 String 类型和 Integer 类型。这样我们就可以很方便地使用这些值进行业务逻辑处理。

三、使用 ConfigurationProperties 读取 Yml 配置

在实际的开发中，我们可能需要读取 Yml 配置文件中的一组值，一般情况下，使用 @Value 注解是无法满足我们的要求的。这时候，我们可以使用 ConfigurationProperties 注解。

示例代码如下：

@ConfigurationProperties(prefix = "person")
@Component
public class PersonProperties {
    private String name;
    private Integer age;
    private List<String> hobbies;

    // 省略 getter 和 setter 方法
}

在上述代码中，我们使用 @ConfigurationProperties 注解指定了配置项的前缀为 person，然后通过定义一个与配置项相对应的 PersonProperties 类，将配置项映射到该类的属性中。这样，我们就可以很方便地使用这些值进行业务逻辑处理。

四、使用 Environment 读取 Yml 配置

除了使用 @Value 和 ConfigurationProperties 注解读取 Yml 配置文件的值之外，我们也可以通过 Environment 接口进行读取。

示例代码如下：

@Component
public class MyComponent {
    @Autowired
    private Environment environment;

    public void print() {
        String name = environment.getProperty("my-config.name");
        Integer age = environment.getProperty("my-config.age", Integer.class);
        System.out.println("My name is " + name + ", and my age is " + age);
    }
}

在上述代码中，我们通过 @Autowired 注解将 Environment 接口注入到 MyComponent 中，然后使用 getProperty 方法获取配置项的值。其中，第二个参数用于指定获取的值的类型。

五、总结

在本文中，我们介绍了 Spring Boot 中读取 Yml 配置文件的三种方式：使用 @Value 注解、使用 ConfigurationProperties 注解和使用 Environment 接口。这些方式均能很好地满足我们对 Yml 配置文件的需求，读者可以根据实际需求选择适合自己的方式。