關(guān)于@ComponentScan注解的用法及作用說明

更新時(shí)間：2023年09月22日 09:41:47 作者：葉楓^_^

這篇文章主要介紹了關(guān)于@ComponentScan注解的用法及作用說明,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

@ComponentScan的作用

@ComponentScan(param)

告訴Spring 哪個(gè)packages 的用注解標(biāo)識(shí)的類會(huì)被spring自動(dòng)掃描并且裝入bean容器，param即用來指定掃描包的范圍。

此注解一般和@Configuration注解一起使用

指定Spring掃描注解的package。

如果沒有指定包，那么默認(rèn)會(huì)掃描此配置類所在的package。

注：

@Configuration注解申明當(dāng)前類是一個(gè)配置類，相當(dāng)于xml配置文件。

@ComponentScan和@Configuration一起使用的原因就是基于Spring2.0中的注解配合xml配置文件的實(shí)現(xiàn)一樣，即在xml配置文件配置ComponentScan包掃描屬性。

例如：

如果類中用了@Controller，@Repository，@Service,@Component四大注解標(biāo)識(shí)之一了，那么如果不加上@ComponentScan，Spring就不會(huì)自動(dòng)掃描類上的四大注解中的任何一個(gè)，那么四大注解下的類就不會(huì)被Spring掃描到，更不會(huì)裝入Spring容器中，因此你配置的四大注解就失去了作用。

@ComponentScan注解在使用時(shí)的一些誤解與分析

1.心血來潮寫了幾行代碼，但是卻出現(xiàn)了一個(gè)spring框架的問題，是關(guān)于spring中自動(dòng)注入的問題。

2.我當(dāng)時(shí)找了好久都沒有找到，后來發(fā)現(xiàn)了問題。

3.我的代碼結(jié)構(gòu)是SpringBoot多模塊結(jié)構(gòu)。

4.我有兩個(gè)模塊：mall_admin，mall_common，我的mall_admin和mall_common兩個(gè)模塊共同隸屬于mall_parent父模塊。

5.我的mall_admin模塊里面聲明了mall_common依賴，同時(shí)mall_admin模塊里面寫了運(yùn)行類，mall_common為通用模塊，一般用作調(diào)用使用。

6.我的mall_admin的包結(jié)構(gòu)為cn.xhc.mall.mall_admin.*(*可以為controller，service，service.impl，config，dao等)，同時(shí)我的運(yùn)行類是在cn.xhc.mall.mall_admin包里面。

7.我的mall_common的包結(jié)構(gòu)為cn.xhc.mall.mall_common.*(*可以為config，utils，service，service.impl等)。

8.我在mall_admin里面的service層自動(dòng)注入mall_common里面的service層的類，但是卻報(bào)注入失敗的錯(cuò)誤。

9.我起初找了很久，并且還在啟動(dòng)類上加上了@ComponentScan注解，并標(biāo)記上了包名，但是還是找不到自動(dòng)注入失敗的錯(cuò)誤。

10.我一直以為是我的mall_common模塊里面service層的代碼寫錯(cuò)誤，所以才導(dǎo)致自動(dòng)注入不成功。

11.但是我找了好久，沒有發(fā)現(xiàn)錯(cuò)誤的地方，這令我十分郁悶，我嘗試了許多方法，甚至嘗試使用@Import注解，但是還是沒有成功。

最后我終于發(fā)現(xiàn)了原因，其實(shí)我使用@ComponentScan注解并沒有什么問題，但是我的啟動(dòng)類放在了錯(cuò)誤的包下面，最開始我將我的啟動(dòng)類放在了cn.xhc.mall.mall_admin下面，但是mall_common中的service放在了cn.xhc.mall.mall_common.service包中，所以我掃描不到mall_common中的@Service注解，因?yàn)樽詣?dòng)掃描只會(huì)掃描啟動(dòng)類同級(jí)或者啟動(dòng)類下面的包中的spring注解，所以只能掃描到cn.xhc.mall.mall_admin同級(jí)或者下面的包中的spring注解，而我的mall_common中service是在cn.xhc.mall.mall_common中，所以掃描不到，不能注冊(cè)為spring中的bean對(duì)象，所以不能再mall_admin中的service中自動(dòng)注入mall_common中的service。

最后我將啟動(dòng)類放在cn.xhc.mall包下，并加上@ComponentScan注解，成功解決問題。