@ConfigurationPropertiesScan

2024-01-10 22:00:31 阅读：34 来源： 互联网

标签：

@ConfigurationPropertiesScan 是 Spring Boot 2.2 版本引入的一个注解，用于自动扫描并注册被 @ConfigurationProperties 注解标注的类。

@ConfigurationProperties 是 Spring Boot 提供的一个注解，用于绑定配置文件中的属性到 Java 类中的字段或方法参数。通过使用 @ConfigurationProperties，可以方便地将配置文件的属性值注入到应用程序中，用于配置各种组件或功能。

而 @ConfigurationPropertiesScan 则用于自动扫描并注册带有 @ConfigurationProperties 注解的类，以便在应用程序中使用配置文件中的属性值。

使用方式如下：

在 Spring Boot 启动类上添加 @ConfigurationPropertiesScan 注解，指定要扫描的包路径。

@ConfigurationPropertiesScan("com.example.config")
@SpringBootApplication
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}

Java

在带有 @ConfigurationProperties 注解的类上添加 @Component 或其他适当的 Spring 注解。

@Component
@ConfigurationProperties("myapp")
public class MyAppProperties {
    private String property1;
    private int property2;

    // 省略 getter 和 setter

    // 可选：自定义校验规则
    @Validated
    public void validate() {
        // 校验逻辑
    }
}

Java

在上述示例中，@ConfigurationPropertiesScan("com.example.config") 指定了要扫描的包路径，在该包下的类如果标注了 @ConfigurationProperties 注解，则会自动注册为 Spring Bean，在需要的地方进行注入并使用。

此外，还可以通过 @EnableConfigurationProperties({MyAppProperties.class}) 注解明确指定要启用的配置属性类。

通过 @ConfigurationPropertiesScan 配合 @ConfigurationProperties 注解，可以方便地将配置文件中的属性值注入到应用程序中，简化了配置属性的读取和使用的过程。

标签：
来源：

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

@ConfigurationPropertiesScan