詳解SpringBoot啟動類的掃描注解的用法及沖突原則
背景
SpringBoot 啟動類上,配置掃描包路徑有三種方式,最近看到一個應(yīng)用上三種注解都用上了,代碼如下:
@SpringBootApplication(scanBasePackages ={'a','b'})@ComponentScan(basePackages = {'a','b','c'})@MapperScan({'XXX'})public class XXApplication extends SpringBootServletInitializer }
那么,疑問來了:SpringBoot 中,這三種注解生效優(yōu)先級如何、第一種和第二種有沒有區(qū)別呢?本文來整理下這三個注解的注意事項(xiàng)。
SpringBootApplication 注解
這是 SpringBoot 的注解,本質(zhì)是三個 Spring 注解的和
@Configuration @EnableAutoConfiguration @ComponentScan它默認(rèn)掃描啟動類所在包及其所有子包, 但是不包括第三方的 jar 包的其他目錄 ,通過 scanBasePackages 屬性可以重新設(shè)置掃描包路徑。
注意:如果我們需要掃描依賴 jar 包中的注解,而依賴包的路徑跟不包含在 SpringBoot 啟動類路徑中的話,我們就要單獨(dú)使用 @ComponentScan 注解掃描第三方包。同時必須指定本工程的掃描路徑, 因?yàn)橐坏┯羞@個注解后,它優(yōu)先,默認(rèn)掃描包就失效了 。
例如這個工程:
SpringBoot 啟動類的工程目錄為 cn.com.a.b ,引用的第三方公共包 xxx.common.jar 的目錄也是 cn.com.a.b ,那么第三方 jar 包中的注解天然能直接被掃描到。其他的 jar 包中,如果有注解,就無法掃描到了。
ComponentScan注解
這個是 Spring 框架的注解,它用來指定組件掃描路徑,如果用這個注解,它的值必須包含整個工程中全部需要掃描的路徑。因?yàn)樗鼤采w SpringBootApplication 的默認(rèn)掃描路徑,導(dǎo)致其失效。
失效表現(xiàn)有兩種:
第一,如果 ComponentScan 只包括一個值且就是默認(rèn)啟動類目錄, SpringBootApplication 生效, ComponentScan 注解失效,報錯:
第二,如果 ComponentScan 指定多個具體子目錄,此時 SpringBootApplication 會失效,Spring 只會掃描 ComponentScan 指定目錄下的注解。如果恰好有目錄外的 Controller 類,很遺憾,這些控制器將無法訪問。
回到開頭那段代碼:
@SpringBootApplication(scanBasePackages ={})@ComponentScan(basePackages = {})
這里指定了 ComponentScan 注解后, scanBasePackages 就失效了。因此,如果 ComponentScan 的 basePackages 值不包括 cn.com.a.b 即啟動類所在的包,僅指定了第三方 jar 的目錄,那么 這個工程下任何的注解都無法被掃描到 。
MapperScan 注解
這個是 MyBatis 的注解,會將指定目錄下所有 DAO 類封裝成 MyBatis 的 BaseMapper 類,然后注入 Spring 容器中, 不需要額外的注解 ,就可以完成注入。
啟示錄
SpringBoot 包掃描路徑,兩個注解的沖突行為,我反復(fù)驗(yàn)證了好久確定了現(xiàn)象,但是沒有找到合理的解釋。這篇文章在草稿箱醞釀了快兩周了,一直擱置著。
今天搜到了一篇文章,說二者同時使用時, SpringBootApplication 會失效,至此 SpringBoot 掃描路徑的疑惑終于消除了。
到此這篇關(guān)于詳解SpringBoot啟動類的掃描注解的用法及沖突原則的文章就介紹到這了,更多相關(guān)SpringBoot啟動類掃描注解內(nèi)容請搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)!
相關(guān)文章:
1. JSP之表單提交get和post的區(qū)別詳解及實(shí)例2. 利用FastReport傳遞圖片參數(shù)在報表上展示簽名信息的實(shí)現(xiàn)方法3. jsp cookie+session實(shí)現(xiàn)簡易自動登錄4. 利用ajax+php實(shí)現(xiàn)商品價格計算5. Spring MVC+ajax進(jìn)行信息驗(yàn)證的方法6. chat.asp聊天程序的編寫方法7. Ajax請求超時與網(wǎng)絡(luò)異常處理圖文詳解8. PHP循環(huán)與分支知識點(diǎn)梳理9. JSP+Servlet實(shí)現(xiàn)文件上傳到服務(wù)器功能10. jsp實(shí)現(xiàn)textarea中的文字保存換行空格存到數(shù)據(jù)庫的方法
