Spring中Bean掃描原理詳情

更新時(shí)間：2022年07月05日 15:05:19 作者：??江粒??

這篇文章主要介紹了Spring中Bean掃描原理詳情，文章為榮啊主題展開(kāi)詳細(xì)的內(nèi)容介紹，具有一定的參考價(jià)值，需要的小伙伴可以參考一下

前言

在上一章節(jié)Spring和Mybatis整合的原理詳解中有寫(xiě)到Spring和MyBatis整合時(shí)用到的Bean掃描是Spring本身提供的。這一篇文章就寫(xiě)到Spring是如何實(shí)現(xiàn)Bean掃描的。
不得不說(shuō)Bean掃描是一個(gè)很重要的技術(shù)，在SpringMVC中的Controller掃描，和SpringBoot中的Bean掃描，Component掃描，Configuration掃描，原理我這里猜測(cè)都是由這個(gè)實(shí)現(xiàn)的。

環(huán)境建設(shè)

由于創(chuàng)建包掃描的條件很簡(jiǎn)單，只要在Xml中配置一個(gè)屬性即可。

正式開(kāi)始

在我前面的文章的閱讀基礎(chǔ)，我們直接這里節(jié)省時(shí)間，直接定位到ComponentScanBaeanDefinitionParser類中的parse方法。

@Override
@Nullable
public BeanDefinition parse(Element element, ParserContext parserContext) {
   String basePackage = element.getAttribute(BASE_PACKAGE_ATTRIBUTE);
   basePackage = parserContext.getReaderContext().getEnvironment().resolvePlaceholders(basePackage);
   String[] basePackages = StringUtils.tokenizeToStringArray(basePackage,
         ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
   // Actually scan for bean definitions and register them.
   // 實(shí)際上，掃描bean定義并注冊(cè)它們。
   ClassPathBeanDefinitionScanner scanner = configureScanner(parserContext, element);
   Set<BeanDefinitionHolder> beanDefinitions = scanner.doScan(basePackages);
   registerComponents(parserContext.getReaderContext(), beanDefinitions, element);

   return null;
}

這個(gè)代碼的前半部分比較簡(jiǎn)單，就是可能當(dāng)前傳進(jìn)來(lái)的basePackage可能是多個(gè)，所以這里使用方法去處理這個(gè)字符串。比較重要的代碼在下半部分。

也就是三個(gè)方法：

configureScanner：配置一個(gè)掃描器
doScan：使用掃描器去掃描
registerComponents：注冊(cè)掃描到的BeanDefintion

configureScanner

第一段代碼

boolean useDefaultFilters = true;
if (element.hasAttribute(USE_DEFAULT_FILTERS_ATTRIBUTE)) {
   useDefaultFilters = Boolean.parseBoolean(element.getAttribute(USE_DEFAULT_FILTERS_ATTRIBUTE));
}

這一段聲明了個(gè)變量，默認(rèn)為T(mén)rue，在下方的If中去會(huì)去修改這個(gè)值。由于我們?cè)赼pplicatio.xml中沒(méi)有設(shè)置這個(gè)屬性，這里還是默認(rèn)值。

第二段代碼

// Delegate bean definition registration to scanner class.
// 將 bean 定義注冊(cè)委托給掃描程序類。
ClassPathBeanDefinitionScanner scanner = createScanner(parserContext.getReaderContext(), useDefaultFilters);
scanner.setBeanDefinitionDefaults(parserContext.getDelegate().getBeanDefinitionDefaults());
scanner.setAutowireCandidatePatterns(parserContext.getDelegate().getAutowireCandidatePatterns());

createScanner方法中，就是new了一個(gè)ClassPathBeanDefinitionScanner對(duì)象給返回回來(lái)了。隨后又為該掃描器加入了兩個(gè)屬性。

第三段代碼

if (element.hasAttribute(RESOURCE_PATTERN_ATTRIBUTE)) {
   scanner.setResourcePattern(element.getAttribute(RESOURCE_PATTERN_ATTRIBUTE));
}

這里判斷有無(wú)配置ResourcePattern屬性，有的話設(shè)置。

第四段代碼

try {
   parseBeanNameGenerator(element, scanner);
}
catch (Exception ex) {
    // ...
}

try {
   parseScope(element, scanner);
}
catch (Exception ex) {
    // ...
}

這兩個(gè)方法代碼跟進(jìn)去有個(gè)共性。都是判斷有沒(méi)有配置一個(gè)屬性，然后給sanner設(shè)置屬性，具體看下方代碼截圖。

這里這兩個(gè)方法是干嘛的，我心里想了想，不知道，也不知道在什么地方會(huì)用到，所以這里接著往下看。

parseTypeFilters

protected void parseTypeFilters(Element element, ClassPathBeanDefinitionScanner scanner, ParserContext parserContext) {
   // Parse exclude and include filter elements.
   ClassLoader classLoader = scanner.getResourceLoader().getClassLoader();
   NodeList nodeList = element.getChildNodes();
   for (int i = 0; i &lt; nodeList.getLength(); i++) {
      Node node = nodeList.item(i);
      if (node.getNodeType() == Node.ELEMENT_NODE) {
         String localName = parserContext.getDelegate().getLocalName(node);
         try {
            if (INCLUDE_FILTER_ELEMENT.equals(localName)) {
               TypeFilter typeFilter = createTypeFilter((Element) node, classLoader, parserContext);
               scanner.addIncludeFilter(typeFilter);
            }
            else if (EXCLUDE_FILTER_ELEMENT.equals(localName)) {
               TypeFilter typeFilter = createTypeFilter((Element) node, classLoader, parserContext);
               scanner.addExcludeFilter(typeFilter);
            }
         }
         catch (ClassNotFoundException ex) {
            // ...
         }
         catch (Exception ex) {
            // ...
         }
      }
   }
}

首先看這個(gè)方法名parseTypeFilters，轉(zhuǎn)換類型類型過(guò)濾器。

通過(guò)查看Spring的DTD文件，看到component-scan標(biāo)簽下還有兩個(gè)子標(biāo)簽，想必就是對(duì)應(yīng)上方的代碼中解釋了。

隨后該方法運(yùn)行完后，就把創(chuàng)建好的scanner對(duì)象，給返回回去了。

doScan

protected Set&lt;BeanDefinitionHolder&gt; doScan(String... basePackages) {
   Assert.notEmpty(basePackages, "At least one base package must be specified");
   Set&lt;BeanDefinitionHolder&gt; beanDefinitions = new LinkedHashSet&lt;&gt;();
   for (String basePackage : basePackages) {
      Set&lt;BeanDefinition&gt; candidates = findCandidateComponents(basePackage);
      for (BeanDefinition candidate : candidates) {
         ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);
         candidate.setScope(scopeMetadata.getScopeName());
         String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry);
         if (candidate instanceof AbstractBeanDefinition) {
            postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);
         }
         if (candidate instanceof AnnotatedBeanDefinition) {
            AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);
         }
         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;
}

在第一行代碼中，創(chuàng)建了個(gè)BeanDefinitions的Set，大概是用來(lái)存放結(jié)果的。

隨后根據(jù)basePacage，查找到了所有的候選BeanDefinition，至于獲取的方法我在下方有講到。

隨后遍歷了剛剛獲取到的BeanDefinition。

findCandidateComponents

private Set&lt;BeanDefinition&gt; scanCandidateComponents(String basePackage) {
   Set&lt;BeanDefinition&gt; candidates = new LinkedHashSet&lt;&gt;();
   try {
      String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX +
            resolveBasePackage(basePackage) + '/' + this.resourcePattern;
      Resource[] resources = getResourcePatternResolver().getResources(packageSearchPath);
      // ... 
      for (Resource resource : resources) {
         // ... 暫時(shí)不看
      }
   }
   catch (IOException ex) {
      // ... throw
   }
   return candidates;
}

上面一段代碼，方法一進(jìn)入，創(chuàng)建了一個(gè)set集合，這個(gè)set機(jī)會(huì)也就是方法最后的返回值，后續(xù)的代碼中會(huì)向這個(gè)set去追加屬性。

隨后到了packageSearchPath，這里是通過(guò)拼接字符串的方式最終得到這個(gè)變量，拼接規(guī)則如下：

classpath*: + 轉(zhuǎn)換后的xml路徑 + **/*.class classpath*:org/springframework/study/**/*.class

隨后根據(jù)resourceLoader，可以加載上方路徑下的所有class文件。

隨后進(jìn)入For遍歷環(huán)節(jié)。

For遍歷每一個(gè)資源

當(dāng)前的resource資源也就是讀取到的class文件。

for (Resource resource: resources) {
    try {
        MetadataReader metadataReader = getMetadataReaderFactory().getMetadataReader(resource);
        if (isCandidateComponent(metadataReader)) {
           ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader);
           sbd.setSource(resource);
           if (isCandidateComponent(sbd)) {
              // ... 打印日志
              candidates.add(sbd);
           }
           else {
              // ... 打印日志
           }
        }
        else {
           // ... 打印日志
        }
    }
    catch (FileNotFoundException ex) {
    // ... 打印日志
    }
    catch (Throwable ex) {
    // ... throw
    }
}

進(jìn)入For后，首先獲取metadataReader。這里代碼簡(jiǎn)單追一下。

主要做的是兩件事，一個(gè)new了一個(gè)SimpleMetaDataReader。然后把這個(gè)MetaDataReader放入了緩存中。隨后返回了這個(gè)Reader對(duì)象。

然后就進(jìn)入了第一個(gè)比較關(guān)鍵的方法代碼，isCandidateComponent方法，仔細(xì)一看，這個(gè)方法怎么被調(diào)用了兩次，因?yàn)檫@個(gè)if進(jìn)入后還會(huì)調(diào)用isCandidateComponent方法，然后我看了看入?yún)?，不一致，一個(gè)入?yún)⑹翿eader，一個(gè)入?yún)⑹翨eanDefinition。我們第一個(gè)if中點(diǎn)用的Reader的isCandidateComponent方法。

isCandidateComponent(MetadataReader metadataReader)

protected boolean
isCandidateComponent(MetadataReader metadataReader) throws IOException {
   for (TypeFilter tf : this.excludeFilters) {
      if (tf.match(metadataReader, getMetadataReaderFactory())) {
         return false;
      }
   }
   for (TypeFilter tf : this.includeFilters) {
      if (tf.match(metadataReader, getMetadataReaderFactory())) {
         return isConditionMatch(metadataReader);
      }
   }
   return false;
}

上方的excludeFilters排除的我們不用看，主要是看下方的include

后續(xù)的代碼我就不讀了，大概實(shí)現(xiàn)我猜測(cè)是通過(guò)Reader去讀到類上的注解，看看有沒(méi)有當(dāng)前filter中設(shè)置的注解。有的話返回true。

繼續(xù)后面的邏輯

ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader);
sbd.setSource(resource);
if (isCandidateComponent(sbd)) {
   if (debugEnabled) {
      logger.debug("Identified candidate component class: " + resource);
   }
   candidates.add(sbd);
}

剛剛外層的If為T(mén)rue后，這里會(huì)創(chuàng)建一個(gè)ScannedGenericBeanDefinition，既然是BeanDefinition，那就可以被Spring加載。

后面把創(chuàng)建的BeanDefinition放入了isCandidateComponent方法。

isCandidateComponent(AnnotatedBeanDefintion)

protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
   AnnotationMetadata metadata = beanDefinition.getMetadata();
   return (metadata.isIndependent() &amp;&amp; (metadata.isConcrete() ||
         (metadata.isAbstract() &amp;&amp; metadata.hasAnnotatedMethods(Lookup.class.getName()))));
}

@Override
public boolean isIndependent() {
   // enclosingClassName 為 null
   return (this.enclosingClassName == null || this.independentInnerClass);
}

default boolean isConcrete() {
   return !(isInterface() || isAbstract());
}

到這個(gè)方法基本第一個(gè)判斷就返回了。isIndependent方法中一開(kāi)始看到其中的兩個(gè)單詞我有點(diǎn)懵，enclosingClass和innerClass，可能是我英文不好的緣故或者基礎(chǔ)差吧，百度搜了才知道的。我這里就不講了，有興趣你們可以自己搜索一下。自己搜索的記憶更深刻。只要是普通的Component的時(shí)候，這里為T(mén)rue。

至于下民的isConcrete方法，就是判斷一下當(dāng)前類是不是接口，或者抽象類。很明顯如果是正常的Component，這里是false，隨后取反為T(mén)rue。

繼續(xù)后面的邏輯

if (isCandidateComponent(sbd)) {
   if (debugEnabled) {
      logger.debug("Identified candidate component class: " + resource);
   }
   candidates.add(sbd);
}

當(dāng)把BeanDefinition傳入后返回為T(mén)rue，進(jìn)入If，也就是添加當(dāng)前的BeanDefinition進(jìn)入結(jié)果集，返回結(jié)果集。

doScan 繼續(xù)后面的邏輯

Set&lt;BeanDefinition&gt; candidates = findCandidateComponents(basePackage);
for (BeanDefinition candidate : candidates) {
   ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);
   candidate.setScope(scopeMetadata.getScopeName());
   String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry);
   if (candidate instanceof AbstractBeanDefinition) {
      postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);
   }
   if (candidate instanceof AnnotatedBeanDefinition) {
      AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);
   }
   if (checkCandidate(beanName, candidate)) {
      BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
      definitionHolder =
            AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
      beanDefinitions.add(definitionHolder);
      registerBeanDefinition(definitionHolder, this.registry);
   }
}

把剛剛獲取到BeanDefinition拿出來(lái)遍歷.

第一步獲取MetaData，這個(gè)在剛剛的代碼中有寫(xiě)到。隨后把他的ScopeName賦值給了MetaData。

接下來(lái)有兩個(gè)if是對(duì)這個(gè)BeanDefinition設(shè)置一些參數(shù)的?？梢院?jiǎn)單掃一眼。捕捉一些關(guān)鍵信息即可。

這個(gè)里面設(shè)置一個(gè)屬性，這里記錄一下，后面有用到再看。

這個(gè)里面是針對(duì)類里添加的一些別的注解，來(lái)給BeanDefinition添加一些配置?？吹綆讉€(gè)比較眼熟的，Lazy，Primary，Description這些注解比較眼熟。

doScan 最后一個(gè)IF

if (checkCandidate(beanName, candidate)) {
   BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
   definitionHolder =
         AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
   beanDefinitions.add(definitionHolder);
   registerBeanDefinition(definitionHolder, this.registry);
}

粗略的掃一眼，這里可以看幾個(gè)重要的地方，一個(gè)是進(jìn)入If的條件，注冊(cè)BeanDefinition。
至于applyScopedProxyMode方法，因?yàn)槲覜](méi)的類上沒(méi)有加Scope注解，所以這里都是不會(huì)配置代理。也就是直接返回當(dāng)前傳入的BeanDefinition。

checkCandidate方法

protected boolean checkCandidate(String beanName, BeanDefinition beanDefinition) throws IllegalStateException {
   if (!this.registry.containsBeanDefinition(beanName)) {
      return true;
   }
   BeanDefinition existingDef = this.registry.getBeanDefinition(beanName);
   BeanDefinition originatingDef = existingDef.getOriginatingBeanDefinition();
   if (originatingDef != null) {
      existingDef = originatingDef;
   }
   if (isCompatible(beanDefinition, existingDef)) {
      return false;
   }
   // ... throw Exception.
}

因?yàn)槭峭ㄟ^(guò)Bean掃描進(jìn)入的，也就是BeanDefinitionRegister當(dāng)中是沒(méi)有這個(gè)BeanDefinition的。所以這里直接就返回True，不會(huì)有走到下面的機(jī)會(huì)。
這個(gè)時(shí)候大家可以思考一下，如果走到下面了會(huì)怎么樣。歡迎評(píng)論區(qū)討論。

繼續(xù)代碼邏輯

beanDefinitions.add(definitionHolder);
registerBeanDefinition(definitionHolder, this.registry);

接下來(lái)就去registerBeanDefinition了，然后還把registry傳進(jìn)入了方法，那很明顯了。這里是去注冊(cè)BeanDefinition了。

總結(jié)

由于在這個(gè)環(huán)節(jié)，掃描器把BeanDefinition放進(jìn)Registry，那么在之后的Refresh方法中的finishBeanFactoryInitialization方法就會(huì)把BeanDefinition都實(shí)例化完畢。

到此這篇關(guān)于Spring中Bean掃描原理詳情的文章就介紹到這了,更多相關(guān)Spring Bean掃描原理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

亚洲乱码中文字幕综合,中国熟女仑乱hd,亚洲精品乱拍国产一区二区三区,一本大道卡一卡二卡三乱码全集资源,又粗又黄又硬又爽的免费视频

軟件下載

源碼下載

軟件編程

網(wǎng)絡(luò)編程

在線工具

數(shù)據(jù)庫(kù)

CMS

常用工具

Spring中Bean掃描原理詳情

目錄

前言

環(huán)境建設(shè)

正式開(kāi)始

configureScanner

第一段代碼

第二段代碼

第三段代碼

第四段代碼

parseTypeFilters

doScan

findCandidateComponents

For遍歷每一個(gè)資源

isCandidateComponent(MetadataReader metadataReader)

繼續(xù)后面的邏輯

isCandidateComponent(AnnotatedBeanDefintion)

繼續(xù)后面的邏輯

doScan 繼續(xù)后面的邏輯

doScan 最后一個(gè)IF

checkCandidate方法

繼續(xù)代碼邏輯

總結(jié)

相關(guān)文章

最新評(píng)論

大家感興趣的內(nèi)容

最近更新的內(nèi)容

常用在線小工具