Spring Bean的包掃描的實(shí)現(xiàn)方法
我們知道,Spring
可以通過(guò)包掃描將使用@Component
注解定義的Bean
定義到容器中。今天就來(lái)探究下他實(shí)現(xiàn)的原理。
首先,找到@Component注解的處理類
注解的定義,一般都需要配套的對(duì)注解的處理才能完成注解所代表的功能。所以我們通過(guò)@Component
注解的用到的地方,來(lái)查找可能的處理邏輯;
我們先進(jìn)入Spring
的項(xiàng)目,在IDEA
里面用Ctrl
和鼠標(biāo)左鍵點(diǎn)擊Component
注解的名稱,IDEA
會(huì)顯示出使用到這個(gè)類的位置,我們從彈出的列表中找到一個(gè)名稱像的類,去看類上面的注釋說(shuō)明,如圖:
我們點(diǎn)進(jìn)類中,可以看到第一行就說(shuō)了這個(gè)類是為了從classpath
里面找到定義的Bean
:
分析具體方法
一般Spring
的類都是經(jīng)過(guò)設(shè)計(jì)的,職責(zé)清晰。所以一般都是有簡(jiǎn)單直接的接口暴露,我們打開(kāi)類的公開(kāi)API
可以看到有個(gè)很直接的方法就叫做掃描,看看注釋說(shuō)“從指定的包中掃描Bean”,那就是它了。
然后,我們?yōu)榱舜_認(rèn),實(shí)現(xiàn)確實(shí)是通過(guò)這個(gè)方法,可以啟動(dòng)程序,打個(gè)斷點(diǎn)看看是否經(jīng)過(guò)這里(但是這這里,沒(méi)有調(diào)用scan()
方法,而是更深一層的doScan
方法,也確實(shí)費(fèi)解)。
我們進(jìn)入doScan()
方法看看實(shí)現(xiàn):
protected Set<BeanDefinitionHolder> doScan(String... basePackages) { Assert.notEmpty(basePackages, "At least one base package must be specified"); Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<>(); // 可以指定多個(gè)basePackage,這里就對(duì)每個(gè)都處理 for (String basePackage : basePackages) { // 這個(gè)方法是真正的查找候選Bean的地方 Set<BeanDefinition> candidates = findCandidateComponents(basePackage); // 對(duì)于每個(gè)查找出的候選Bean,進(jìn)行處理 for (BeanDefinition candidate : candidates) { // 解析@Scope的元數(shù)據(jù) ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate); candidate.setScope(scopeMetadata.getScopeName()); // 為候選的Bean生成一個(gè)名稱 String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry); // 應(yīng)用后置處理器 if (candidate instanceof AbstractBeanDefinition) { postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName); } // // 處理一些其它通用的注解的元數(shù)據(jù) if (candidate instanceof AnnotatedBeanDefinition) { AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate); } // 校驗(yàn)通過(guò)后,注冊(cè)到 BeanFactory if (checkCandidate(beanName, candidate)) { BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName); definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry); beanDefinitions.add(definitionHolder); registerBeanDefinition(definitionHolder, this.registry); } } } return beanDefinitions; }
從方法中我們可以明顯的看到,核心代碼還在findCandidateComponents
方法里面,我們進(jìn)入這個(gè)方法后再通過(guò)調(diào)試一直找到核心代碼scanCandidateComponents
。如下圖,第一處是找到指定包路徑所代表的classpath
中的資源對(duì)象, 但是這里只是找到了包下面有什么,但是還不知道包下面的類是不是一個(gè)候選的Bean
(可以看到將DTO
類也掃描到了)。如下:
正常思路,拿到了有哪些資源就該進(jìn)一步去篩選,看看這些資源有哪些是真正的Bean
的定義類。
現(xiàn)在我們還不清楚的是,Spring
通過(guò)什么方式知道一個(gè)類是否是真正的Bean
的。我們繼續(xù)調(diào)試,到上圖的430行debug
進(jìn)去看看,可以走到org.springframework.core.type.classreading.SimpleMetadataReader
這個(gè)類的構(gòu)造器中,如下:
SimpleMetadataReader(Resource resource, @Nullable ClassLoader classLoader) throws IOException { // 通過(guò)流讀取資源的內(nèi)容,現(xiàn)在這個(gè)資源可以認(rèn)為是我們的類 InputStream is = new BufferedInputStream(resource.getInputStream()); ClassReader classReader; try { // 這個(gè)Reader的構(gòu)造器中就將流讀取完畢了 classReader = new ClassReader(is); } catch (IllegalArgumentException ex) { // 通過(guò)這個(gè)異常的信息,可以推測(cè)出,其實(shí)這里是通過(guò)ASM讀取Class文件的定義了 throw new NestedIOException("ASM ClassReader failed to parse class file - " + "probably due to a new Java class file version that isn't supported yet: " + resource, ex); } finally { is.close(); } // 這里根據(jù)命名可以推測(cè)是訪問(wèn)者模式來(lái)暴露注解的元數(shù)據(jù) AnnotationMetadataReadingVisitor visitor = new AnnotationMetadataReadingVisitor(classLoader); // 這個(gè)accpect方法也是訪問(wèn)者模式中的典型方法,在這里面,是數(shù)據(jù)的解析邏輯 classReader.accept(visitor, ClassReader.SKIP_DEBUG); this.annotationMetadata = visitor; // (since AnnotationMetadataReadingVisitor extends ClassMetadataReadingVisitor) this.classMetadata = visitor; this.resource = resource; }
我們?cè)谶M(jìn)入classReader.accept
方法,這里面可以看到reader
對(duì)于Class
文件的的按字節(jié)解析。
例如,下面讀取的類聲明,類注解都是包掃描需要的類元數(shù)據(jù):
拿到這些元數(shù)據(jù)之后,就按照包掃描的過(guò)濾器就過(guò)濾出真正需要的類,作為候選的Bean
獲取到元數(shù)據(jù)之后,就可以按部就班對(duì)Bean
進(jìn)行注冊(cè)、初始化等一系列邏輯啦~
總結(jié)
- 包掃描是通過(guò)讀取包對(duì)應(yīng)的類路徑下的
class
文件后,對(duì)class
文件進(jìn)行解析元數(shù)據(jù)的方式,確定了Bean
的定義的; - 本地
IDEA
的啟動(dòng)方式可能和Jar
包方式尋找資源的方式略有不同,但是思路是一致的,都是按照第一點(diǎn)查找;
到此這篇關(guān)于Spring Bean的包掃描的實(shí)現(xiàn)方法的文章就介紹到這了,更多相關(guān)Spring Bean掃描包內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
eclipse實(shí)現(xiàn)DSA數(shù)字簽名
這篇文章主要為大家詳細(xì)介紹了eclipse實(shí)現(xiàn)DSA數(shù)字簽名算法,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2020-06-06springboot3生成本地文件url的實(shí)現(xiàn)示例
本文主要介紹了springboot3生成本地文件url的實(shí)現(xiàn)示例,從而提供一種高效的文件管理方式,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2024-01-01java后端如何實(shí)現(xiàn)防止接口重復(fù)提交
這篇文章主要介紹了java后端如何實(shí)現(xiàn)防止接口重復(fù)提交問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-05-05Spring MVC溫故而知新系列教程之請(qǐng)求映射RequestMapping注解
這篇文章主要介紹了Spring MVC溫故而知新系列教程之請(qǐng)求映射RequestMapping注解的相關(guān)知識(shí),文中給大家介紹了RequestMapping注解提供的幾個(gè)屬性及注解說(shuō)明,感興趣的朋友跟隨腳本之家小編一起學(xué)習(xí)吧2018-05-05Exception in thread main java.lang.NoClassDefFoundError錯(cuò)誤解決方
這篇文章主要介紹了Exception in thread main java.lang.NoClassDefFoundError錯(cuò)誤解決方法,需要的朋友可以參考下2016-08-08servlet實(shí)現(xiàn)文件下載的步驟及說(shuō)明詳解
這篇文章主要為大家詳細(xì)介紹了servlet實(shí)現(xiàn)文件下載的步驟及說(shuō)明,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-09-09