springBoot中的@ConfigurationProperties注解

提示：与@Value功能上有所区别

---

前言

在Spring Boot中，@ConfigurationProperties注解主要用于将外部配置文件（如application.properties或application.yml）中的属性绑定到Java Bean上。这个特性极大地简化了配置管理，使得应用程序的配置更加灵活和可维护。下面是对@ConfigurationProperties注解的详细说明：

---

1. 注解用途

• 自动绑定配置：允许Spring自动将配置文件中的键值对映射到Bean的属性上，减少了手动读取配置的工作。
• 类型安全：绑定过程会进行类型检查，确保配置值与Java Bean属性类型匹配，增加了安全性。

2. 基本使用

要使用@ConfigurationProperties，首先需要定义一个Java类，该类将持有配置文件中的属性。然后，在类或方法级别使用此注解，并指定配置前缀。

代码如下（示例）：

@Component
@ConfigurationProperties(prefix = "app.datasource")
public class DataSourceConfig {
    private String url;
    private String username;
    private String password;
    private Map<String, String> url;
    private String appKey;
    private String appSecret;
    private String version;
    // Getter and Setter methods...
}

在这个例子中，prefix="app.datasource"指定了配置前缀，Spring Boot会查找以app.datasource开头的配置项，并尝试将它们映射到DataSourceConfig类的相应属性上。

3.启用配置

为了让Spring Boot识别并加载这个配置类，你需要在配置类上添加@Component注解，并确保至少有一个配置类被@EnableConfigurationProperties或使用@SpringBootApplication注解的类扫描到。另外，也可以通过配置类的方式自动装配，如下所示：

在主类上启用

@SpringBootApplication
@EnableConfigurationProperties({DataSourceConfig.class})
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

或者，如果你的应用使用了Spring Boot 2.4及以上版本，你可以直接在配置类上使用@Configuration注解，而不需要@EnableConfigurationProperties。

注：Spring Boot 2.4以上版本@SpringBootApplication注解中的@SpringBootConfiguration以包含@Configuration注解。
配置类示例

@Configuration
@ConfigurationProperties(prefix = "app.datasource")
public class DataSourceConfig {
    // properties...
}

---

4.外部化配置

• 支持.properties和.yml格式的配置文件。
• 可以通过spring.config.location属性指定配置文件的位置。

5. 验证

为了确保配置的正确性，可以使用JSR-303/JSR-380注解（如@NotNull, @Min,@Max等）进行属性验证。此外，还需要在项目中引入一个JSR-303实现（如Hibernate Validator）。

6.重载默认值

除了外部配置文件，还可以在类中定义默认值，作为外部配置不存在时的备选。

---

总结

@ConfigurationProperties是Spring Boot中用于简化配置管理的强大工具，它促进了配置的集中管理，增强了应用的灵活性和可维护性。通过合理的配置前缀、类型安全的绑定机制以及可选的验证功能，开发者可以轻松地管理应用程序的各种配置需求。