SpringBoot啟動(dòng)類的掃描注解的用法及沖突原則
背景
SpringBoot 啟動(dòng)類上,配置掃描包路徑有三種方式,最近看到一個(gè)應(yīng)用上三種注解都用上了,代碼如下:
那么,疑問來了:SpringBoot 中,這三種注解生效優(yōu)先級(jí)如何、第一種和第二種有沒有區(qū)別呢?本文來整理下這三個(gè)注解的注意事項(xiàng)。
SpringBootapplication 注解
這是 SpringBoot 的注解,本質(zhì)是三個(gè) Spring 注解的和
@Configuration
@EnableAutoConfiguration
@ComponentScan
它默認(rèn)掃描啟動(dòng)類所在包及其所有子包,但是不包括第三方的 jar 包的其他目錄,通過?屬性可以重新設(shè)置掃描包路徑。
注意:如果我們需要掃描依賴 jar 包中的注解,而依賴包的路徑跟不包含在 SpringBoot 啟動(dòng)類路徑中的話,我們就要單獨(dú)使用??注解掃描第三方包。同時(shí)必須指定本工程的掃描路徑,因?yàn)橐坏┯羞@個(gè)注解后,它優(yōu)先,默認(rèn)掃描包就失效了。
例如這個(gè)工程:
SpringBoot 啟動(dòng)類的工程目錄為?,引用的第三方公共包?
?的目錄也是?
?,那么第三方 jar 包中的注解天然能直接被掃描到。其他的 jar 包中,如果有注解,就無法掃描到了。
ComponentScan注解
這個(gè)是 Spring 框架的注解,它用來指定組件掃描路徑,如果用這個(gè)注解,它的值必須包含整個(gè)工程中全部需要掃描的路徑。因?yàn)樗鼤?huì)覆蓋??的默認(rèn)掃描路徑,導(dǎo)致其失效。
失效表現(xiàn)有兩種:
第一,如果??只包括一個(gè)值且就是默認(rèn)啟動(dòng)類目錄,
?生效,?
?注解失效,報(bào)錯(cuò):

第二,如果??指定多個(gè)具體子目錄,此時(shí)?
?會(huì)失效,Spring 只會(huì)掃描?
?指定目錄下的注解。如果恰好有目錄外的 Controller 類,很遺憾,這些控制器將無法訪問。
回到開頭那段代碼:
這里指定了??注解后,?
?就失效了。因此,如果?
?的?
?值不包括?
?即啟動(dòng)類所在的包,僅指定了第三方 jar 的目錄,那么這個(gè)工程下任何的注解都無法被掃描到。
MapperScan 注解
這個(gè)是 MyBatis 的注解,會(huì)將指定目錄下所有 DAO 類封裝成 MyBatis 的??類,然后注入 Spring 容器中,不需要額外的注解,就可以完成注入。
啟示錄
SpringBoot 包掃描路徑,兩個(gè)注解的沖突行為,我反復(fù)驗(yàn)證了好久確定了現(xiàn)象,但是沒有找到合理的解釋。這篇文章在草稿箱醞釀了快兩周了,一直擱置著。
今天搜到了一篇文章,說二者同時(shí)使用時(shí),??會(huì)失效,至此 SpringBoot 掃描路徑的疑惑終于消除了。