快捷導(dǎo)航

詳解@ConfigurationProperties如何裝載到Spring容器中

更新時間：2023年07月30日 08:22:36 作者：JAVA旭陽

這篇文章主要為大家詳細介紹了@ConfigurationProperties該如何裝載到Spring容器中，文中的示例代碼講解詳細，需要的小伙伴可以參考一下

問題描述

最近項目中遇到了一個Spring中@ConfigurationProperties注解的問題，如下：

1.定義了一個注解了@ConfigurationProperties的User Bean。

@ConfigurationProperties(prefix?=?"my.user")
@Component
@Data
public?class?User?{
????private?String?userName;
}

2.通過@Autowired使用UserBean，沒有問題。

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

3.但是，有個同事修改了下變量名為user1，自信的以為沒有問題，就提交測試了，然后直接報錯了。

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

報錯如下圖所示：

這是怎么一回事呢，修改個變量名都能報錯？

原因分析

根據(jù)報錯信息不難分析出來主要原因在于User類在Spring容器中兩個Bean對象，bean name分別是“user”和“my.user-com.alvinlkk.bean.User”。

使用@Autwired裝配，實際上不只是根據(jù)類型裝配，如果匹配到同類型有多個Bean對象，默認會去找和變量名“user”同名的Bean，所以不會報錯。如果修改變量名改成user1, 它就匹配到兩個Bean對象，然后用bean name=user1無法找到合適的，自然就報錯了。

那么為什么會出現(xiàn)兩個Bean呢？

1.因為使用@Component注解，創(chuàng)建了一個名稱為“user”的Bean。

2.使用了@EnableConfigurationProperties注解創(chuàng)建了名稱為my.user-com.alvinlkk.bean.User的Bean。

最佳實踐

使用@ConfigurationProperties注解的Bean的時候，建議通過使用@EnableConfigurationProperties創(chuàng)建Bean。

源碼解析

刨根問底，我們繼續(xù)從Spring源碼層面深入了解下這個問題的產(chǎn)生的根源。Spring創(chuàng)建Bean的過程其實很簡單，大致分兩個步驟：

創(chuàng)建Bean的定義信息BeanDefinition，包含Bean的類型，名稱等信息，注冊到Bean定義工廠中。
根據(jù)Bean定義工廠中的Bean定義信息，創(chuàng)建出Bean實例。

上面的兩個過程中在通常在SpringBoot啟動的過程中就完成，SpringBoot啟動的時候，會調(diào)用容器的refresh(), 其中在invokeBeanFactoryPostProcessors(beanFactory)方法中創(chuàng)建并注冊BeanDefinition, 在finishBeanFactoryInitialization()方法中創(chuàng)建Bean實例對象。

創(chuàng)建注冊BeanDefinition

@Component注解

被Compoent注解的的類會被Spring中的ConfigurationClassPostProcessor類處理，創(chuàng)建出對應(yīng)的BeanDefinition，然后注冊到BeanDefinitionRegistry中，具體流程如下圖所示。

被@Component注解的類User會被掃描到，生成一個名字是user的BeanDefinition，然后注冊到BeanDefitionRegistry中，如下圖所示：

@EnableConfigurationProperties注解

注解@EnableConfigurationProperties源碼中import了EnableConfigurationPropertiesRegistrar類，那么它是在什么階段創(chuàng)建出BeanDefinition呢？

最終配置了@EnableConfigurationProperties(User.class)中被獲取，創(chuàng)建出name為my.user-com.alvinlkk.bean.User的BeanDefinition，如下圖所示。

而且@Component的順序是優(yōu)先于@EnableConfigurationProperties的。

創(chuàng)建Bean對象

現(xiàn)在BeanDefinitionBean定義信息已經(jīng)有了，Spring就可以根據(jù)這些信息創(chuàng)建出Bean對象實例了，這一個過程是在finishBeanFactoryInitialization()方法中進行的，我們這里重點關(guān)注下@Autowird方法是如何進行裝配的。