@ConfigurationProperties该如何装载到Spring容器中呢？

素颜马尾好姑娘i 2023-10-14 09:49 120阅读 0赞

## 问题描述 ##

最近项目中遇到了一个`Spring`中`@ConfigurationProperties`注解的问题，如下：

1.定义了一个注解了@ConfigurationProperties的User Bean。

java复制代码@ConfigurationProperties(prefix = "my.user")
    @Component
    @Data
    public class User {
    
        private String userName;
    }

2.通过@Autowired使用UserBean，没有问题。

java复制代码@RestController
    @RequestMapping("/config")
    @EnableConfigurationProperties(User.class)
    public class UserConfigController {
    
        @Autowired
        private User user;
    
        @GetMapping("/username1")
        public String username1() {
            return user.getUserName();
        }
    }

![format_png][]

![get_code_YTk4YTI4ZjBkZWZiNjNmMzk5YWJlM2MwNjA3ZDAxZDIsMTY5MDY4MjM2ODk1OA][]

3.但是，有个同事修改了下变量名为user1，自信的以为没有问题，就提交测试了，然后直接报错了。

java复制代码@RestController
    @RequestMapping("/config")
    @EnableConfigurationProperties(User.class)
    public class UserConfigController {
    
        @Autowired
        private User user1;
    
        @GetMapping("/username2")
        public String username2() {
            return user1.getUserName();
        }
    }

报错如下图所示：

![format_png 1][]

这是怎么一回事呢，修改个变量名都能报错？

## 原因分析 ##

根据报错信息不难分析出来主要原因在于`User`类在`Spring`容器中两个`Bean`对象，`bean name`分别是“`user`”和“`my.user-com.alvinlkk.bean.User`”。

使用`@Autwired`装配，实际上不只是根据类型装配，如果匹配到同类型有多个Bean对象，默认会去找和变量名“`user`”同名的`Bean`，所以不会报错。如果修改变量名改成`user1`, 它就匹配到两个Bean对象，然后用`bean name=user1`无法找到合适的，自然就报错了。

那么为什么会出现两个Bean呢？

1.  因为使用`@Component`注解，创建了一个名称为“`user`”的Bean。

![format_png 2][]

1.  使用了`@EnableConfigurationProperties`注解创建了名称为`my.user-com.alvinlkk.bean.User`的Bean。

![format_png 3][]

**最佳实践**

使用`@ConfigurationProperties`注解的Bean的时候，建议通过使用`@EnableConfigurationProperties`创建Bean。

## 源码解析 ##

刨根问底，我们继续从Spring源码层面深入了解下这个问题的产生的根源。Spring创建Bean的过程其实很简单，大致分两个步骤：

1.  创建Bean的定义信息`BeanDefinition`，包含Bean的类型，名称等信息，注册到Bean定义工厂中。
2.  根据Bean定义工厂中的Bean定义信息，创建出Bean实例。

上面的两个过程中在通常在SpringBoot启动的过程中就完成，SpringBoot启动的时候，会调用容器的`refresh()`, 其中在`invokeBeanFactoryPostProcessors(beanFactory)`方法中创建并注册`BeanDefinition`, 在`finishBeanFactoryInitialization()`方法中创建Bean实例对象。

![format_png 4][]

### 创建注册BeanDefinition ###

1.  `@Component`**注解**

被`Compoent`注解的的类会被Spring中的`ConfigurationClassPostProcessor`类处理，创建出对应的`BeanDefinition`，然后注册到`BeanDefinitionRegistry`中，具体流程如下图所示。

![format_png 5][]

被`@Component`注解的类User会被扫描到，生成一个名字是`user`的`BeanDefinition`，然后注册到BeanDefitionRegistry中，如下图所示：

![format_png 6][]

1.  `@EnableConfigurationProperties`**注解**

注解`@EnableConfigurationProperties`源码中`import`了`EnableConfigurationPropertiesRegistrar`类，那么它是在什么阶段创建出`BeanDefinition`呢？

![format_png 7][]

最终配置了`@EnableConfigurationProperties(User.class)`中被获取，创建出name为`my.user-com.alvinlkk.bean.User`的`BeanDefinition`，如下图所示。

![format_png 8][]

而且`@Component`的顺序是优先于`@EnableConfigurationProperties`的。

### 创建Bean对象 ###

现在`BeanDefinition`Bean定义信息已经有了，Spring就可以根据这些信息创建出Bean对象实例了，这一个过程是在`finishBeanFactoryInitialization()`方法中进行的，我们这里重点关注下`@Autowird`方法是如何进行装配的。

1.  `AbstractApplicationContext#refresh()`: 初始化容器
2.  `AbstractApplicationContext#finishBeanFactoryInitialization()`: 初始化Bean入口
3.  `DefaultListableBeanFactory#preInstantiateSingletons()`：预先初始化单例Bean
4.  `DefaultListableBeanFactory#getBean()`: 调用`getBean()`创建Bean实例
5.  `AbstractBeanFactory#doGetBean()`：`getBean()`最终调用的方法
6.  `AbstractAutowireCapableBeanFactory#createBean()`: 创建Bean实例入口
7.  `DefaultListableBeanFactory#determineAutowireCandidate()`：选择使用哪个候选的Bean

![format_png 9][]

根据类型匹配到Bean有多个的情况，会调用`determineAutowireCandidate()`方法进一步去根据name匹配bean。

## 总结 ##

所以对于配置注解`ConfigurationProperties`的类不要使用使用`@Component`注解让Spring管理，更推荐的做法是使用`@EnableConfigurationProperties`注解进行装载。

[format_png]: https://img-blog.csdnimg.cn/img_convert/987b39dcd7c2a9e5b6dc3700aca5bf80.webp?x-oss-process=image/format,png
[get_code_YTk4YTI4ZjBkZWZiNjNmMzk5YWJlM2MwNjA3ZDAxZDIsMTY5MDY4MjM2ODk1OA]: https://mp.toutiao.com/mp/agw/article_material/open_image/get?code=YTk4YTI4ZjBkZWZiNjNmMzk5YWJlM2MwNjA3ZDAxZDIsMTY5MDY4MjM2ODk1OA==
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/e057e259751f57d9985a85b77c4393ca.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/870eaeed16e33b3fa852ab0988a49b81.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/669f14b5d01b51aa4c54e9011ae274fe.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/ca97126e16fae1acc1e0cc16f1a8b3cf.webp?x-oss-process=image/format,png
[format_png 5]: https://img-blog.csdnimg.cn/img_convert/571ca87f254c251f119438f1eb5231d7.webp?x-oss-process=image/format,png
[format_png 6]: https://img-blog.csdnimg.cn/img_convert/3aee72eabd28ac147db59d8d79775f3d.webp?x-oss-process=image/format,png
[format_png 7]: https://img-blog.csdnimg.cn/img_convert/7ac2a77d39fd6ae2764b78a4fd04b08f.webp?x-oss-process=image/format,png
[format_png 8]: https://img-blog.csdnimg.cn/img_convert/4178d95bfc6fed4adbb3413dd09a03eb.webp?x-oss-process=image/format,png
[format_png 9]: https://img-blog.csdnimg.cn/img_convert/f3a44d0f8013a952f7ebf8c566c85197.webp?x-oss-process=image/format,png