@EnableConfigurationProperties注解

目录

1.概述

2.测试

2.1 使用 @EnableConfigurationProperties 进行注册

2.2 使用 @Component 注册

3.项目中的使用场景

---

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相关注解：

参考链接：关与 @EnableConfigurationProperties 注解 - 简书