詳解SpringBoot啟動類的掃描注解的用法及沖突原則

背景

SpringBoot 啟動類上，配置掃描包路徑有三種方式，最近看到一個應用上三種注解都用上了，代碼如下：

@SpringBootApplication(scanBasePackages ={'a','b'})@ComponentScan(basePackages = {'a','b','c'})@MapperScan({'XXX'})public class XXApplication extends SpringBootServletInitializer }

那么，疑問來了：SpringBoot 中，這三種注解生效優先級如何、第一種和第二種有沒有區別呢？本文來整理下這三個注解的注意事項。

SpringBootApplication 注解

這是 SpringBoot 的注解，本質是三個 Spring 注解的和

它默認掃描啟動類所在包及其所有子包， 但是不包括第三方的 jar 包的其他目錄 ，通過 scanBasePackages 屬性可以重新設置掃描包路徑。

注意：如果我們需要掃描依賴 jar 包中的注解，而依賴包的路徑跟不包含在 SpringBoot 啟動類路徑中的話，我們就要單獨使用 @ComponentScan 注解掃描第三方包。同時必須指定本工程的掃描路徑， 因為一旦有這個注解后，它優先，默認掃描包就失效了 。

例如這個工程：

SpringBoot 啟動類的工程目錄為 cn.com.a.b ，引用的第三方公共包 xxx.common.jar 的目錄也是 cn.com.a.b ，那么第三方 jar 包中的注解天然能直接被掃描到。其他的 jar 包中，如果有注解，就無法掃描到了。

ComponentScan注解

這個是 Spring 框架的注解，它用來指定組件掃描路徑，如果用這個注解，它的值必須包含整個工程中全部需要掃描的路徑。因為它會覆蓋 SpringBootApplication 的默認掃描路徑，導致其失效。

失效表現有兩種：

第一，如果 ComponentScan 只包括一個值且就是默認啟動類目錄， 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 包掃描路徑，兩個注解的沖突行為，我反復驗證了好久確定了現象，但是沒有找到合理的解釋。這篇文章在草稿箱醞釀了快兩周了，一直擱置著。

今天搜到了一篇文章，說二者同時使用時， SpringBootApplication 會失效，至此 SpringBoot 掃描路徑的疑惑終于消除了。

到此這篇關于詳解SpringBoot啟動類的掃描注解的用法及沖突原則的文章就介紹到這了,更多相關SpringBoot啟動類掃描注解內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網！