springboot——@EnableConfigurationProperties使用与分析

一、前言

用springboot开发的过程中,我们会用到@ConfigurationProperties注解,主要是用来把properties或者yml配置文件转化为bean来使用的,而@EnableConfigurationProperties注解的作用是@ConfigurationProperties注解生效。
如果只配置@ConfigurationProperties注解,在IOC容器中是获取不到properties配置文件转化的bean的,当然在@ConfigurationProperties加入注解的类上加@Component也可以使交于springboot管理。

二、举个栗子

第一步:创建一个类TestConfigurationProperties

@ConfigurationProperties(prefix = "properties")
public class TestConfigurationProperties {
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

注意:得加上set和get方法
第二步:创建TestAutoConfiguration类

@Configuration
@EnableConfigurationProperties(TestConfigurationProperties.class)
public class TestAutoConfiguration {

    private TestConfigurationProperties testConfigurationProperties;

    public TestAutoConfiguration(TestConfigurationProperties testConfigurationProperties) {
        this.testConfigurationProperties = testConfigurationProperties;
    }

    @Bean
    public User user(){
        User user = new User();
        user.setName(testConfigurationProperties.getName());
        return user;
    }
}

注意:得创建一个有参构造方法
第三步:配置文件加入属性

properties.name=test

第四步:跑一下,打印出User这个类

@RestController
@RequestMapping("/api/test")
@Slf4j
public class TestController {
    @Autowired
    TestConfigurationProperties testConfigurationProperties;

    @Autowired
    User user;

    @RequestMapping(value = "/testConfigurationProperties")
    public String testConfigurationProperties() {
        log.info("test testConfigurationProperties.............{}", testConfigurationProperties.getName());
        log.info("user:{}", user);
        return "SUCCESS";
    }
}

控制台输出:

2019-04-21/16:11:36.638||||||||^_^|[http-nio-8088-exec-1] INFO  com.stone.zplxjj.controller.TestController 37 - test testConfigurationProperties.............test
2019-04-21/16:11:36.639||||||||^_^|[http-nio-8088-exec-1] INFO  com.stone.zplxjj.controller.TestController 38 - user:User(id=null, name=test)

三、@EnableConfigurationProperties是怎么加载的

通过查看@EnableConfigurationProperties的注解:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(EnableConfigurationPropertiesImportSelector.class)
public @interface EnableConfigurationProperties {

    /**
     * Convenient way to quickly register {@link ConfigurationProperties} annotated beans
     * with Spring. Standard Spring Beans will also be scanned regardless of this value.
     * @return {@link ConfigurationProperties} annotated beans to register
     */
    Class<?>[] value() default {};

}

通过分析自动配置可以知道,肯定是这个类EnableConfigurationPropertiesImportSelector起的作用:

private static final String[] IMPORTS = {
            ConfigurationPropertiesBeanRegistrar.class.getName(),
            ConfigurationPropertiesBindingPostProcessorRegistrar.class.getName() };

    @Override
    public String[] selectImports(AnnotationMetadata metadata) {
        return IMPORTS;
    }

selectImports方法返回了这两个类:ConfigurationPropertiesBeanRegistrar和ConfigurationPropertiesBindingPostProcessorRegistrar,是何时加载的,我们只需要看这个类ConfigurationPropertiesBeanRegistrar即可:

public static class ConfigurationPropertiesBeanRegistrar
            implements ImportBeanDefinitionRegistrar {

        @Override
        public void registerBeanDefinitions(AnnotationMetadata metadata,
                BeanDefinitionRegistry registry) {
            getTypes(metadata).forEach((type) -> register(registry,
                    (ConfigurableListableBeanFactory) registry, type));
        }
        //找到加入这个注解@EnableConfigurationProperties里面的value值,其实就是类class
        private List<Class<?>> getTypes(AnnotationMetadata metadata) {
            MultiValueMap<String, Object> attributes = metadata
                    .getAllAnnotationAttributes(
                            EnableConfigurationProperties.class.getName(), false);
            return collectClasses((attributes != null) ? attributes.get("value")
                    : Collections.emptyList());
        }

        private List<Class<?>> collectClasses(List<?> values) {
            return values.stream().flatMap((value) -> Arrays.stream((Object[]) value))
                    .map((o) -> (Class<?>) o).filter((type) -> void.class != type)
                    .collect(Collectors.toList());
        }
      //注册方法:根据找到的类名name和type,将加入注解@ConfigurationProperties的类加入spring容器里面
        private void register(BeanDefinitionRegistry registry,
                ConfigurableListableBeanFactory beanFactory, Class<?> type) {
            String name = getName(type);
            if (!containsBeanDefinition(beanFactory, name)) {
                registerBeanDefinition(registry, name, type);
            }
        }
    //找到加入注解@ConfigurationProperties的类的名称,加入一定格式的拼接
        private String getName(Class<?> type) {
            ConfigurationProperties annotation = AnnotationUtils.findAnnotation(type,
                    ConfigurationProperties.class);
            String prefix = (annotation != null) ? annotation.prefix() : "";
            return (StringUtils.hasText(prefix) ? prefix + "-" + type.getName()
                    : type.getName());
        }

        private boolean containsBeanDefinition(
                ConfigurableListableBeanFactory beanFactory, String name) {
            if (beanFactory.containsBeanDefinition(name)) {
                return true;
            }
            BeanFactory parent = beanFactory.getParentBeanFactory();
            if (parent instanceof ConfigurableListableBeanFactory) {
                return containsBeanDefinition((ConfigurableListableBeanFactory) parent,
                        name);
            }
            return false;
        }

        private void registerBeanDefinition(BeanDefinitionRegistry registry, String name,
                Class<?> type) {
            assertHasAnnotation(type);
            GenericBeanDefinition definition = new GenericBeanDefinition();
            definition.setBeanClass(type);
            registry.registerBeanDefinition(name, definition);
        }

        private void assertHasAnnotation(Class<?> type) {
            Assert.notNull(
                    AnnotationUtils.findAnnotation(type, ConfigurationProperties.class),
                    () -> "No " + ConfigurationProperties.class.getSimpleName()
                            + " annotation found on  '" + type.getName() + "'.");
        }

    }

四、结语

另外还有这个类:ConfigurationPropertiesBindingPostProcessorRegistrar,刚刚没有分析,看了下源码,其实他做的事情就是将配置文件当中的属性值赋予到加了@ConfigurationProperties的注解的类的属性上,具体就不分析了,有兴趣自己可以阅读,入口知道了,就简单了

### Spring Boot 中 `@ConfigurationProperties` 加载配置文件时赋值失败的原因分析 当遇到 `@ConfigurationProperties` 注入属性为空的情况,通常有以下几个原因: #### 1. 缺少必要的注解组合 如果仅使用 `@ConfigurationProperties` 而未配合其他必要注解,则可能导致属性无法正常注入。为了使自定义配置类生效,除了 `@ConfigurationProperties` 外还需要加上 `@Component` 或者通过 `@EnableConfigurationProperties` 来显式注册这些 Bean。 对于这种情况,在不希望直接标注组件的情况下可以采用如下方式来解决问题[^2]: ```java @SpringBootApplication @EnableConfigurationProperties(UserProperties.class) // 明确指出需要启用哪个配置类 public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` #### 2. 配置前缀设置错误 确保在使用 `@ConfigurationProperties` 时指定了正确的 prefix 参数值,并且此前缀 application.properties 或 application.yml 文件中的键名相匹配。例如: ```java @ConfigurationProperties(prefix = "user") public class UserProperties { private String name; // getter and setter methods... } ``` 对应的配置应为: ```properties user.name=John Doe ``` #### 3. 使用不当的数据类型转换器 有时即使配置正确也可能因为数据类型的自动转换失败而导致某些字段未能成功初始化。此时可以通过实现自定义的 Converter 接口或者利用现有的 SpEL 表达式来进行更复杂的映射逻辑处理。 #### 4. 版本兼容性问题 不同版本之间可能存在 API 变化或行为差异,因此建议查看当前使用的 spring-boot-starter-parent 和相关依赖库的具体版本号是否一致并保持最新状态。 #### 5. 应用上下文刷新顺序影响 由于 Spring 容器启动过程中会经历多个阶段,部分情况下可能会因加载时机不对而造成配置解析异常。可通过调整 bean 初始化顺序等方式尝试修复此类问题。 针对上述提到的方法之一——即确保所有带有 `@ConfigurationProperties` 的类都被适当扫描到并作为 Spring 上下文中的一部分被管理起来这一点尤为重要。这不仅有助于简化代码结构设计同时也提高了系统的可维护性和扩展能力。 另外值得注意的是,虽然 properties 是最基础也是默认支持的一种外部化配置形式[^1],但在实际开发中 YAML 格式的配置文件因其层次化的特性往往更加直观易懂;不过无论选用哪种格式都需遵循相应的语法规则以保证其有效性。 最后提醒一点,若仍然存在读取不到预期配置项的情形,请仔细核对 pom.xml 中关于 spring-boot-dependencies 的引入情况以及是否存在重复声明相同功能模块的现象[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值