詳解Spring的autowire-candidate設計

Posted on by

Xml配置文件中的default-autowire-candidates屬性

有的同學對這個配置可能不熟悉或者說都不知道這個配置的存在，那首先我們看下default-autowire-candidates這個配置是放在何處的：

<beans xmlns="http://www.springframework.org/schema/beans"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:context="http://www.springframework.org/schema/context"
      xmlns:aop="http://www.springframework.org/schema/aop"
      xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
         default-autowire-candidates="service*">

    <bean id="serviceA" class="org.wonder.frame.xmlConfig.SetterBean$ServiceA" autowire-candidate="false"/>
    <bean id="serviceB" class="org.wonder.frame.xmlConfig.SetterBean$ServiceB"  />
    <bean id="setterBean" class="org.wonder.frame.xmlConfig.SetterBean" autowire="byType" />
</beans>

在idea中我們可以點開 default-autowire-candidates這個屬性所在的spring-beans.xsd就能看到官方對這個屬性的註釋：

A default bean name pattern for identifying autowire candidates: e.g. “Service”, “data”, “Service”, “dataService”. Also accepts a comma-separated list of patterns: e.g. “Service,*Dao”. See the documentation for the ‘autowire-candidate’ attribute of the ‘bean’ element for the semantic details of autowire candidate beans.

簡單翻譯下也就是說這個屬性可以標示配置文件中的所有Bean默認能否成為自動註入候選者的名稱匹配模式，比如 “Service”, “data”, “Service”, “dataService”.也支持以逗號分隔的字符串模式列表：”Service,Dao”. 比如上面配置文件中配置的service\就匹配瞭serviceA,serviceB兩個Bean.但是Spring的設計規定serviceA自身配置的autowire-candidate為false會覆蓋default-autowire-candidates配置，所以serviceA是不會成為自動註入的候選者。

匹配邏輯算法

我們深入到源碼中看下Spring是如何根據這個匹配模式來與自身bean名稱來匹配的

String autowireCandidate = ele.getAttribute(AUTOWIRE_CANDIDATE_ATTRIBUTE);
if ("".equals(autowireCandidate) || DEFAULT_VALUE.equals(autowireCandidate)) {
   String candidatePattern = this.defaults.getAutowireCandidates();
   if (candidatePattern != null) {
      String[] patterns = StringUtils.commaDelimitedListToStringArray(candidatePattern);
      bd.setAutowireCandidate(PatternMatchUtils.simpleMatch(patterns, beanName));
   }
}
else {
   bd.setAutowireCandidate(TRUE_VALUE.equals(autowireCandidate));
}

很清楚，在bean本身配置autowire-candidate為空或者默認的情況下，Spring會把default-autowire-candidates字符串轉換成數組，然後依賴PatternMatchUtils類的simpleMatch方法來驗證當前bean的名稱是否匹配，成功與否都會賦值給當前bean的autowireCandidate屬性。其實最主要的還是PatternMatchUtils.simpleMatch方法

PatternMatchUtils.simpleMatch

public static boolean simpleMatch(@Nullable String pattern, @Nullable String str) {
   //pattern 匹配模式為空 或者待匹配字符串為空就返回false
   if (pattern == null || str == null) {
      return false;
   }
   //找到第一個* 在匹配模式字符串中的的索引
   int firstIndex = pattern.indexOf('*');
   if (firstIndex == -1) {
      //索引為空的情況下就代表 模式字符串要和待匹配字符串相等。
      return pattern.equals(str);
   }
   //*在第一位
   if (firstIndex == 0) {
      //*在第一位 且匹配模式字符串長度為1 那就直接返回true ，比如 *
      if (pattern.length() == 1) {
         return true;
      }
      //找到下一個*的起始位置
      int nextIndex = pattern.indexOf('*', firstIndex + 1);
      if (nextIndex == -1) {
         //如果沒有*瞭，就判斷 待匹配的字符串是否是以pattern結尾的。
         //比如*service   Aservice就滿足這種情況
         return str.endsWith(pattern.substring(1));
      }
      //截取第一個* 和之後一個* 之間的字符串
      String part = pattern.substring(1, nextIndex);
      if (part.isEmpty()) {
         return simpleMatch(pattern.substring(nextIndex), str);
      }
      //str 是指待匹配的字符
      int partIndex = str.indexOf(part);
      while (partIndex != -1) {
         if (simpleMatch(pattern.substring(nextIndex), str.substring(partIndex + part.length()))) {
            return true;
         }
         //從partIndex+1 開始計算part的索引
         partIndex = str.indexOf(part, partIndex + 1);
      }
      return false;
   }
   //待匹配字符串的長度比 第一個*的索引 大或者相等的情況下
   //截取模式字符串 0 到 第一個*號之間的字符串 ，截取 待匹配字符串 0 到 第一個*號之間的字符串 對比
   //如果相等 ，再截取 模式字符串  第一個*號之後的字符串 和 待匹配 字符串  第一個*號之後的字符串 去做匹配
   return (str.length() >= firstIndex &&
         pattern.substring(0, firstIndex).equals(str.substring(0, firstIndex)) &&
         simpleMatch(pattern.substring(firstIndex), str.substring(firstIndex)));
}

這個Utils類的工具函數實現的字符串模糊匹配算法在我們日常開發中對字符串的操作方面也會有或多或少的幫助。

總結

Spring中的很多設計細節總是給我們很多驚喜，從中我們也可以很多小技巧，給我們日常開發會帶來不少啟發。

以上就是詳解Spring的autowire-candidate設計的詳細內容，更多關於Spring的autowire-candidate設計的資料請關註WalkonNet其它相關文章！

推薦閱讀：