SpringBoot中的@EnableConfigurationProperties注解详细解析

更新时间：2024年01月31日 08:51:19 作者：你的小伙伴啊

这篇文章主要介绍了SpringBoot中的@EnableConfigurationProperties注解详细解析,如果一个配置类只配置@ConfigurationProperties注解,而没有使用@Component或者实现了@Component的其他注解,那么在IOC容器中是获取不到properties 配置文件转化的bean,需要的朋友可以参考下

1.概述

@EnableConfigurationProperties注解的作用是：使使用 @ConfigurationProperties 注解的类生效。

如果一个配置类只配置@ConfigurationProperties注解，而没有使用@Component或者实现了@Component的其他注解，那么在IOC容器中是获取不到properties 配置文件转化的bean。说白了 @EnableConfigurationProperties 相当于把使用 @ConfigurationProperties 的类进行了一次注入。

简单点说@EnableConfigurationProperties的功能类似于@Component。

2.测试

2.1 使用 @EnableConfigurationProperties 进行注册

@ConfigurationProperties(prefix = "service.properties")
public class HelloServiceProperties {
    private static final String SERVICE_NAME = "test-service";
    private String msg = SERVICE_NAME;
       set/get
}
@Configuration
@EnableConfigurationProperties(HelloServiceProperties.class)
@ConditionalOnClass(HelloService.class)
@ConditionalOnProperty(prefix = "hello", value = "enable", matchIfMissing = true)
public class HelloServiceAutoConfiguration {
}
@RestController
public class ConfigurationPropertiesController {
    @Autowired
    private HelloServiceProperties helloServiceProperties;
    @RequestMapping("/getObjectProperties")
    public Object getObjectProperties () {
        System.out.println(helloServiceProperties.getMsg());
        return myConfigTest.getProperties();
    }
}

配置文件application.properties

service.properties.name=my-test-name
service.properties.ip=192.168.1.1
service.user=kayle
service.port=8080

一切正常，但是 HelloServiceAutoConfiguration 头部不使用 @EnableConfigurationProperties，测访问报错。

2.2 使用 @Component 注册

不使用 @EnableConfigurationProperties 进行注册，使用 @Component 注册

@ConfigurationProperties(prefix = "service.properties")
@Component
public class HelloServiceProperties {
    private static final String SERVICE_NAME = "test-service";
    private String msg = SERVICE_NAME;
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

Controller 不变，一切正常，如果注释掉 @Component 测启动报错。由此证明，两种方式都是将被 @ConfigurationProperties 修饰的类，加载到 Spring Env 中。

3.项目中的使用场景

如下，在配置类NacosConfigAutoConfiguration的头上加注解@EnableConfigurationProperties(NacosConfigProperties.class)，

而在NacosConfigProperties配置类本身并没有实现了@Component相关的注解，也就是说运行项目时，不会直接把NacosConfigProperties配置类注入到Spring 容器中，而是在执行NacosConfigAutoConfiguration这个配置类时才会去把NacosConfigProperties类注入到spring

如下，NacosConfigProperties类本身并没有@Component相关注解：

到此这篇关于SpringBoot中的@EnableConfigurationProperties注解详细解析的文章就介绍到这了,更多相关@EnableConfigurationProperties注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

java 实现迷宫回溯算法示例详解
这篇文章主要介绍了java 实现迷宫回溯算法示例详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-07-07
2021年最新Redis面试题汇总(2)
在程序员面试过程中redis相关的知识是常被问到的话题。这篇文章主要介绍了几道Redis面试题，整理一下分享给大家，感兴趣的小伙伴们可以参考一下
2021-07-07
如何基于sqlite实现kafka延时消息详解
这篇文章主要给大家介绍了关于如何基于sqlite实现kafka延时消息的相关资料,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2022-01-01
SpringBoot集成Mybatis实现对多数据源访问原理
本文主要分析讨论在SpringBoot应用中我们该如何配置SqlSessionFactoryBean对象,进而实现对多个不同的数据源的操纵,文章通过代码示例介绍的非常详细,需要的朋友可以参考下
2023-11-11
Java多线程之读写锁分离设计模式
这篇文章主要介绍了Java多线程读写锁分离设计模式，主要利用Java到吗完成read read 并行化、read write 不允许、write write 不允许几项任务,需要的朋友可以参考一下
2021-10-10
ToStringBuilder类的一些心得
ToStringBuilder类的一些心得,需要的朋友可以参考一下
2013-02-02
Java实现Huffman编码的示例代码
Huffman编码是一种编码方式,本文主要介绍了Java实现Huffman编码的示例代码,具有一定的参考价值,感兴趣的可以了解一下
2023-08-08
Java的MyBatis+Spring框架中使用数据访问对象DAO模式的方法
Data Access Object数据访问对象模式在Java操作数据库部分的程序设计中经常被使用到,这里我们就来看一下Java的MyBatis+Spring框架中使用数据访问对象DAO模式的方法:
2016-06-06
java制作复制文件工具代码分享
如果目标位置没有同名文件，则直接拷贝过去；如果目标位置已有同名文件，则比对文件的最后修改日期，来进行覆盖或者忽略。程序会在可以在复制过程中自动创建目录，并生成log文件，创建了哪些目录、文件，覆盖了哪些文件、跳过了哪些文件，文件的时间、位置等信息都一目了然
2014-01-01
深入了解Java中的反射机制(reflect)
Java的反射机制允许我们对一个类的加载、实例化、调用方法、操作属性的时期改为在运行期进行，这大大提高了代码的灵活度,本文就来简单讲讲反射机制的具体使用方法吧
2023-05-05