@ConfigurationProperties

@ConfigurationProperties 是 Spring Framework 中用于将配置文件中的属性映射到 Java 对象的注解。它通常用于简化配置管理，特别是在处理大量配置属性时。

用法示例

1. 添加依赖：
   确保你的项目中包含了 Spring Boot 的依赖。

2. 创建配置类：
   创建一个 Java 类，并使用 @ConfigurationProperties 注解标记它。

   import org.springframework.boot.context.properties.ConfigurationProperties;
   import org.springframework.stereotype.Component;
   
   @Component
   @ConfigurationProperties(prefix = "app")
   public class AppProperties {
       private String name;
       private String version;
   
       // Getters and Setters
       public String getName() {
           return name;
       }
   
       public void setName(String name) {
           this.name = name;
       }
   
       public String getVersion() {
           return version;
       }
   
       public void setVersion(String version) {
           this.version = version;
       }
   }
   

3. 配置文件：
   在 application.properties 或 application.yml 文件中定义属性。

   app.name=My Application
   app.version=1.0.0
   

4. 使用配置类：
   在你的服务或控制器中注入这个配置类。

   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.RestController;
   
   @RestController
   public class AppController {
   
       @Autowired
       private AppProperties appProperties;
   
       @GetMapping("/info")
       public String getInfo() {
           return "Name: " + appProperties.getName() + ", Version: " + appProperties.getVersion();
       }
   }
   

关键点

• 前缀：prefix 属性用于指定配置属性的前缀。
• 类型安全：通过使用 Java 类型，Spring 会自动进行类型转换。
• 支持嵌套属性：可以创建嵌套的配置类来处理复杂的配置结构。

@ConfigurationProperties 可以在不加 @Component 的情况下使用，但需要额外的配置。以下是两种常见的方式：

1. 使用 @EnableConfigurationProperties

如果你不想将配置类标记为 @Component，可以在你的主应用类或任何配置类上使用 @EnableConfigurationProperties 注解来启用它。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

@SpringBootApplication
@EnableConfigurationProperties(AppProperties.class) // 启用 AppProperties
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

2. 使用 Java 配置类

你也可以在一个 Java 配置类中定义 @Bean，将配置类作为 Spring Bean 注册。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.boot.context.properties.ConfigurationProperties;

@Configuration
public class AppConfig {

    @Bean
    @ConfigurationProperties(prefix = "app")
    public AppProperties appProperties() {
        return new AppProperties();
    }
}

总结

• 不加 @Component：可以通过 @EnableConfigurationProperties 或在配置类中定义 @Bean 来使用。
• 灵活性：这种方式提供了更大的灵活性，特别是在需要对配置类进行更复杂的管理时。

无论哪种方式，最终都能实现将配置文件中的属性映射到 Java 对象。