Spring Boot 如何正确读取配置文件属性

Spring Boot 通过@ConfigurationProperties注解实现了属性注入功能，可以方便的读取配置文件中的属性值。下面将详细讲解如何正确读取配置文件属性的完整攻略。

1. 定义@ConfigurationProperties类

首先，我们需要在Spring Boot应用程序中定义一个带有@ConfigurationProperties注解的类。该类用于映射配置文件中的属性值。

示例类定义如下：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "example")
public class ExampleProperties {

    private String name;
    private String description;
    private String url;

    // 省略setter和getter方法
}

该类使用了@Component注解，使得Spring Boot应用程序自动扫描并将其注入到IoC容器中。另外，@ConfigurationProperties注解定义了属性值的前缀为example，表示该类只会映射以example为前缀的属性值。

2. 配置application.properties

接下来，我们需要在Spring Boot应用程序的classpath路径下创建一个application.properties文件，并将需要读取的属性值配置在其中。

示例文件配置如下：

example.name=example project
example.description=example project description
example.url=https://www.example.com

3. 使用@ConfigurationProperties读取属性值

完成以上两个步骤后，我们就可以在Spring Boot应用程序中使用ExampleProperties类的实例来读取配置文件中的属性值了。

示例代码如下：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ExampleController {

    @Autowired
    private ExampleProperties properties;

    @GetMapping("/example")
    public String getExample() {
        return properties.getName() + ": " + properties.getDescription() + " (" + properties.getUrl() + ")";
    }
}

上述代码会将ExampleProperties的实例自动注入到IoC容器中，并将其通过@Autowired注解注入到ExampleController中。在ExampleController的getExample方法中，我们调用了ExampleProperties的三个getter方法，分别获取了name、description、url三个属性的值，并返回一个字符串表示这些属性的值。

4. 其他示例

除了上述方式之外，@ConfigurationProperties注解还支持其它形式的属性注入。例如，我们可以通过设置ignoreUnknownFields和ignoreInvalidFields来忽略未知的和无效的属性值。下面给出一个示例：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "example", ignoreUnknownFields = false, ignoreInvalidFields = true)
public class ExampleProperties {

    private String name;
    private String description;
    private String url;

    // 省略setter和getter方法
}

在这个示例中，我们将ignoreUnknownFields设置为false，表示当配置文件中存在未知的属性时，会抛出异常。另外，我们将ignoreInvalidFields设置为true，表示当配置文件中的属性值无效时，会忽略该属性。这种情况下，我们可以在应用程序启动时得到一些有用的警告信息，帮助我们解决配置文件中存在的问题。

再比如，我们可以通过设置@Value注解来读取某个具体的属性值。下面给出一个示例：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class ExampleComponent {

    @Value("${example.name}")
    private String name;

    public String getName() {
        return name;
    }
}

在这个示例中，我们使用@Value注解来读取名字为example.name的属性值，并将其注入到ExampleComponent的name字段中。这种方式适合读取单个属性值的情况。同时也可以使用@ConfigurationProperties注解来读取属性值，它更适合读取多个属性值的情况。

阅读剩余 56%