Spring Bean的包掃描的實現方法

Posted on by

我們知道，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掃描包內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：