ChatGPT：@EnableConfigurationProperties 和 @ConfigurationProperties注解

原创已于 2024-07-21 14:08:05 修改 · 763 阅读

20 ·

本内容遵循CC 4.0 BY-SA版权协议

GEO检测

收录于

编程之路

于 2024-07-21 14:07:44 首次发布

ChatGPT：@EnableConfigurationProperties 和 @ConfigurationProperties注解

@EnableConfigurationProperties(ServiceProperties.class) @ConfigurationProperties(prefix = “cestc”) 这两个注解的关系

@EnableConfigurationProperties 和 @ConfigurationProperties 是 Spring Boot 中用于外部化配置的两个注解，它们通常一起使用来简化配置的管理。

`@ConfigurationProperties`

@ConfigurationProperties 注解用于将外部配置（例如，application.properties 或 application.yml 文件中的配置）绑定到一个 Java Bean 上。这个注解通常会加在一个类上，并通过指定一个前缀来绑定相关的配置属性。

例如：

@ConfigurationProperties(prefix = "cestc")
public class ServiceProperties {
    private String url;
    private int timeout;
    
    // getters and setters
}

在上面的例子中，ServiceProperties 类会将配置文件中以 cestc 开头的属性（例如，cestc.url 和 cestc.timeout）映射到类的属性中。

`@EnableConfigurationProperties`

@EnableConfigurationProperties 注解通常加在一个配置类上，用于启用对使用 @ConfigurationProperties 注解的 bean 的支持。它可以在任何 @Configuration 类中使用，以确保 @ConfigurationProperties 注解的类被 Spring Boot 扫描和注册为 Spring 容器中的 bean。

例如：

@Configuration
@EnableConfigurationProperties(ServiceProperties.class)
public class AppConfig {
    // other configuration
}

在这个例子中，AppConfig 类通过 @EnableConfigurationProperties 注解启用了 ServiceProperties 配置类的支持，这样 Spring Boot 会自动扫描和加载 ServiceProperties 中的配置。

总结

@ConfigurationProperties：用于定义一个 Java Bean，该 Bean 的属性会从外部配置文件中绑定。
@EnableConfigurationProperties：用于启用和注册 @ConfigurationProperties 注解的配置类，使其成为 Spring 容器中的一个 bean。

它们的关系是：@EnableConfigurationProperties 启用 @ConfigurationProperties，使得 Spring Boot 能够扫描并将配置属性绑定到指定的 Java Bean 上。

@ConfigurationProperties 实现这个注解的类，需要有get set方法吗

是的，实现 @ConfigurationProperties 注解的类通常需要有 getter 和 setter 方法。这些方法用于在 Spring Boot 启动时将配置文件中的属性值绑定到该类的字段上。

示例

假设你的配置文件（例如 application.yml）中有如下内容：

cestc:
  url: http://example.com
  timeout: 5000

你可以创建一个类，并使用 @ConfigurationProperties 注解来绑定这些属性：

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

@Component
@ConfigurationProperties(prefix = "cestc")
public class ServiceProperties {

    private String url;
    private int timeout;

    // Getter and Setter for url
    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    // Getter and Setter for timeout
    public int getTimeout() {
        return timeout;
    }

    public void setTimeout(int timeout) {
        this.timeout = timeout;
    }
}

作用

Getter 方法：Spring Boot 使用 getter 方法读取配置文件中的属性值。
Setter 方法：Spring Boot 使用 setter 方法将配置文件中的属性值设置到对应的字段上。

例外情况

如果你使用的是 Lombok 库，你可以通过 Lombok 注解自动生成这些 getter 和 setter 方法，从而简化代码。例如：

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

@Component
@ConfigurationProperties(prefix = "cestc")
@Data
public class ServiceProperties {
    private String url;
    private int timeout;
}