Spring开发实践（六）

@EnableConfigurationProperties注解的用法

@EnableConfigurationProperties 是 Spring Boot 中的一个注解，用于启用对 @ConfigurationProperties 注解的支持。它通常用于将配置属性绑定到一个 Java Bean 上。以下是它的用法和示例：

1. 创建配置属性类

首先，创建一个 Java 类，用于存储配置属性。这个类需要使用 @ConfigurationProperties 注解，并且通常还需要 @Component 注解（或者在 Spring Boot 2.2 及以上版本中，可以省略 @Component 注解，直接使用 @EnableConfigurationProperties 注解来注册这个类）。

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;
    }
}

2. 启用配置属性

在你的配置类（通常是主应用程序类）中使用 @EnableConfigurationProperties 注解来启用配置属性支持。

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

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

3. 在配置文件中定义属性

在 application.properties 或 application.yml 文件中定义属性：

# application.properties
app.name=MyApp
app.version=1.0.0

或者：

# application.yml
app:
  name: MyApp
  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 MyController {

    private final AppProperties appProperties;

    @Autowired
    public MyController(AppProperties appProperties) {
        this.appProperties = appProperties;
    }

    @GetMapping("/info")
    public String getAppInfo() {
        return "App Name: " + appProperties.getName() + ", Version: " + appProperties.getVersion();
    }
}

总结

• @ConfigurationProperties 注解用于将配置文件中的属性映射到 Java 类。
• @EnableConfigurationProperties 注解用于启用对 @ConfigurationProperties 注解的支持。
• 配置属性类可以通过 @Component 注解注册为 Spring Bean，或者通过 @EnableConfigurationProperties 注解进行注册。
• 在配置文件中定义属性，并在需要的地方注入和使用这些属性。

在 @EnableConfigurationProperties 注解中，如果不指定具体的配置属性类（例如 AppProperties.class），那么这个注解将不会启用任何特定的配置属性类。这意味着 Spring Boot 将不会自动扫描和注册任何使用 @ConfigurationProperties 注解的类。

具体影响

1. 配置属性类不会被注册：如果你没有在 @EnableConfigurationProperties 中指定具体的类，那么即使你定义了带有 @ConfigurationProperties 注解的类，这些类也不会被 Spring 容器管理和注册为 Bean。

2. 无法自动绑定配置属性：由于配置属性类没有被注册，Spring Boot 将无法将配置文件中的属性自动绑定到这些类上。

示例

假设你有一个配置属性类 AppProperties：

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

@ConfigurationProperties(prefix = "app")
public class AppProperties {
    private String name;
    private String version;

    // getters and setters
}

如果你在主应用程序类中使用 @EnableConfigurationProperties 注解，但没有指定 AppProperties.class：

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

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

在这种情况下，AppProperties 类将不会被注册为 Spring Bean，配置文件中的属性也不会被绑定到 AppProperties 类。

解决方法

为了确保配置属性类被正确注册和绑定，你需要在 @EnableConfigurationProperties 注解中指定具体的类：

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

总结

• 不指定具体类：配置属性类不会被注册，配置文件中的属性不会被绑定。
• 指定具体类：配置属性类会被注册，配置文件中的属性会被自动绑定到这些类上。

为了确保配置属性类能够正常工作，建议在 @EnableConfigurationProperties 注解中指定具体的配置属性类。

如果你不想在 @EnableConfigurationProperties 注解中指定具体的配置属性类，可以使用 @ConfigurationPropertiesScan 注解来自动扫描和注册所有带有 @ConfigurationProperties 注解的类。

使用 @ConfigurationPropertiesScan

@ConfigurationPropertiesScan 是 Spring Boot 2.2 引入的一个注解，它可以自动扫描指定包及其子包中的所有 @ConfigurationProperties 类，并将它们注册为 Spring Bean。

示例

你可以在主应用程序类中使用 @ConfigurationPropertiesScan 注解，而不需要在 @EnableConfigurationProperties 中指定具体的类：

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

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