Spring Bean的包掃描的實現方法
我們知道,Spring
可以通過包掃描將使用@Component
註解定義的Bean
定義到容器中。今天就來探究下他實現的原理。
首先,找到@Component註解的處理類
註解的定義,一般都需要配套的對註解的處理才能完成註解所代表的功能。所以我們通過@Component
註解的用到的地方,來查詢可能的處理邏輯;
我們先進入Spring
的專案,在IDEA
裡面用Ctrl
和滑鼠左鍵點選Component
註解的名稱,IDEA
會顯示出使用到這個類的位置,我們從彈出的列表中找到一個名稱像的類,去看類上面的註釋說明,如圖:
我們點進類中,可以看到第一行就說了這個類是為了從classpath
裡面找到定義的Bean
分析具體方法
一般Spring
的類都是經過設計的,職責清晰。所以一般都是有簡單直接的介面暴露,我們開啟類的公開API
可以看到有個很直接的方法就叫做掃描,看看註釋說“從指定的包中掃描Bean”,那就是它了。
然後,我們為了確認,實現確實是通過這個方法,可以啟動程式,打個斷點看看是否經過這裡(但是這這裡,沒有呼叫scan()
方法,而是更深一層的doScan
方法,也確實費解)。
我們進入doScan()
方法看看實現:
protected Set<BeanDefinitionHolder> doScan(String... basePackages) { Assert.notEmpty(basePackages,"At least one base package must be specified"); Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<>(); // 可以指定多個basePackage,這裡就對每個都處理 for (String basePackage : basePackages) { // 這個方法是真正的查詢候選Bean的地方 Set<BeanDefinition> candidates = findCandidateComponents(basePackage); // 對於每個查找出的候選Bean,進行處理 for (BeanDefinition candidate : candidates) { // 解析@Scope的元資料 ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate); candidate.setScope(scopeMetadata.getScopeName()); // 為候選的Bean生成一個名稱 String beanName = this.beanNameGenerator.generateBeanName(candidate,this.registry); // 應用後置處理器 if (candidate instanceof AbstractBeanDefinition) { postProcessBeanDefinition((AbstractBeanDefinition) candidate,beanName); } // // 處理一些其它通用的註解的元資料 if (candidate instanceof AnnotatedBeanDefinition) { AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate); } // 校驗通過後,註冊到 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
方法裡面,我們進入這個方法後再通過除錯一直找到核心程式碼scanCandidateComponents
。如下圖,第一處是找到指定包路徑所代表的classpath
中的資源物件,但是這裡只是找到了包下面有什麼,但是還不知道包下面的類是不是一個候選的Bean
(可以看到將DTO
類也掃描到了)。如下:
正常思路,拿到了有哪些資源就該進一步去篩選,看看這些資源有哪些是真正的Bean
的定義類。
現在我們還不清楚的是,Spring
通過什麼方式知道一個類是否是真正的Bean
的。我們繼續除錯,到上圖的430行debug
進去看看,可以走到org.springframework.core.type.classreading.SimpleMetadataReader
SimpleMetadataReader(Resource resource,@Nullable ClassLoader classLoader) throws IOException { // 通過流讀取資源的內容,現在這個資源可以認為是我們的類 InputStream is = new BufferedInputStream(resource.getInputStream()); ClassReader classReader; try { // 這個Reader的構造器中就將流讀取完畢了 classReader = new ClassReader(is); } catch (IllegalArgumentException ex) { // 通過這個異常的資訊,可以推測出,其實這裡是通過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(); } // 這裡根據命名可以推測是訪問者模式來暴露註解的元資料 AnnotationMetadataReadingVisitor visitor = new AnnotationMetadataReadingVisitor(classLoader); // 這個accpect方法也是訪問者模式中的典型方法,在這裡面,是資料的解析邏輯 classReader.accept(visitor,ClassReader.SKIP_DEBUG); this.annotationMetadata = visitor; // (since AnnotationMetadataReadingVisitor extends ClassMetadataReadingVisitor) this.classMetadata = visitor; this.resource = resource; }
我們在進入classReader.accept
方法,這裡面可以看到reader
對於Class
檔案的的按位元組解析。
例如,下面讀取的類宣告,類註解都是包掃描需要的類元資料:
拿到這些元資料之後,就按照包掃描的過濾器就過濾出真正需要的類,作為候選的Bean
獲取到元資料之後,就可以按部就班對Bean
進行註冊、初始化等一系列邏輯啦~
總結
- 包掃描是通過讀取包對應的類路徑下的
class
檔案後,對class
檔案進行解析元資料的方式,確定了Bean
的定義的; - 本地
IDEA
的啟動方式可能和Jar
包方式尋找資源的方式略有不同,但是思路是一致的,都是按照第一點查詢;
到此這篇關於Spring Bean的包掃描的實現方法的文章就介紹到這了,更多相關Spring Bean掃描包內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!