摘要：本文我們重點分析一下Spring框架中的SpringFactoriesLoader類以及META-INF/spring.factories的使用。在詳細分析之前，我們可以思考一個問題？在我們設計一套API供別人呼叫的時候，如果同一個功能的要求特別多，或者同一個介面要面對很複雜的業務場景，這個時候我們該怎麼辦呢？其一：我們可以規範不同的系統呼叫，也就是傳遞一個系統標識；其二：我們在內部編碼的時候可以使用不同的條件判斷語句進行處理；其三：我們可以寫幾個策略類來來應對這個複雜的業務邏輯，比如同一個功能的實現，A實現類與B實現類的邏輯一點也不一樣，但是目標是一樣的，這個時候使用策略類是毋庸置疑的？上述的問題我們是在API層面進行處理的？那萬一有一天讓我們自己設計一套框架，然後讓別人直接使用？我們該如何處理上述的這個問題呢？這個可能就涉及到SPI的一些規範了跟技巧了，比如同一套API可能有很多實現類，這個時候我們該如何內建一系列實現類供框架使用呢？或者讓使用者也可以自定義這些API的實現類，相互之間協作運轉。帶著這些問題我們看一下Spring框架中的SpringFactoriesLoader以及META-INF/spring.factories的使用。

1.1 屬性配置

首先，我們來看一下屬性的配置方式，在傳統的開發模式中（無springboot），屬性檔案的格式無外乎就是兩種，第一種是XML，第二種是key、value形式（properties檔案）。當然springboot引入了yaml方式。這裡我們重點看一下XML以及properties的定義以及獲取方式。

1.1.1 properties方式

1.1.1.1. 單個屬性配置

首先，我們新建一個shareniu-single.factories檔案，該檔案的目錄結構如下圖所示：

shareniu-single.factories的內容如下：

shareniu=http://www.shareniu.com/

1.1.1.2. 多個屬性配置

單個屬性的定義比較簡單，就是key、value形式即可。對於同一個屬性有多個值的定義格式如下：

com.example.demo.ch3.IShareniu=\

com.example.demo.ch3.ShareniuA,\

com.example.demo.ch3.ShareniuB

1.1.1.3. properties讀取工具類

上述的屬性定義完畢之後，我們寫一個工具類進行測試，在這裡我們直接呼叫了PropertiesLoaderUtils類中的方法。例項程式碼如下：

1 public class PropertiesLoaderUtilsTest {

2  public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/shareniu-single.factories";

3  public static void main(String[] args) throws IOException {

4  Properties properties = PropertiesLoaderUtils.loadAllProperties(FACTORIES_RESOURCE_LOCATION,null);

5  System.out.println(properties);

6  }

7 }

上述的程式碼直接呼叫了PropertiesLoaderUtils類中的loadAllProperties方法，PropertiesLoaderUtils的全路徑名稱為：org.springframework.core.io.support.PropertiesLoaderUtils。該類位於spring-core-5.0.0.RC3.jar包中。

執行上面的程式碼，程式的輸出如下：

{shareniu=http://www.shareniu.com/, com.example.demo.ch3.IShareniu=com.example.demo.ch3.ShareniuA,com.example.demo.ch3.ShareniuB}

果真我們自定義的屬性都可以完美的獲取到。

關於PropertiesLoaderUtils.loadAllProperties的核心程式碼如下：

1 public static Properties loadAllProperties(String resourceName, @Nullable ClassLoader classLoader) throws IOException {

2  ClassLoader classLoaderToUse = classLoader;

3  if (classLoaderToUse == null) {

4  classLoaderToUse = ClassUtils.getDefaultClassLoader();

5  }

6  Enumeration<URL> urls = (classLoaderToUse != null ? classLoaderToUse.getResources(resourceName) :

7  ClassLoader.getSystemResources(resourceName));

8  Properties props = new Properties();

9  while (urls.hasMoreElements()) {

10  URL url = urls.nextElement();

11  URLConnection con = url.openConnection();

12  ResourceUtils.useCachesIfNecessary(con);

13  InputStream is = con.getInputStream();

14  try {

15  if (resourceName.endsWith(XML_FILE_EXTENSION)) {

16  props.loadFromXML(is);

17  }

18  else {

19  props.load(is);

20  }

21  }

22  finally {

23  is.close();

24  }

25  }

26  return props;

27  }

loadAllProperties方法，首先會根據類載入器去獲取指定的資源（也就是我們呼叫的時候，傳遞的resourceName引數值）。然後判斷資源的字尾是否為xml，如果字尾是xml則使用xml方式載入資源，否則都是用Properties方式進行資源的載入。

注意：雖然上述的程式碼我們指定的資源名稱是：META-INF/shareniu-single.factories，但是上述的類載入器不僅掃描我們專案的META-INF/shareniu-single.factories，還會掃描當前類載入所載入的jar包中的META-INF/shareniu-single.factories檔案。

1.1.2 xml方式

瞭解了上述程式碼的處理邏輯之後，我們看一下xml方式如何定義，shareniu.xml定義內容如下：

1 <?xml version="1.0" encoding="UTF-8"?>  

2 <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">    

3 <properties>   

4     <comment>shareniu xml配置檔案</comment>  

5     <entry key="username">shareniu</entry>  

6     <entry key="url">http://www.shareniu.com/</entry>   

7 </properties>

執行上述的屬性工具類，控制檯的輸出資訊如下：

{url=http://www.shareniu.com/, username=shareniu}

1.2 SpringFactoriesLoader使用

瞭解了XML以及properties的定義以及獲取方式之後，接下來學習SpringFactoriesLoader類就簡單的多了。

首先，看一下SpringFactoriesLoader類定義的方法如下所示：

1. loadFactoryNames:載入指定的factoryClass並進行例項化。

2. loadSpringFactories：載入指定的factoryClass。

3. instantiateFactory：對指定的factoryClass進行例項化。

    通過上文可知：loadFactoryNames方法內部直接呼叫loadSpringFactories方法，loadSpringFactories方法則會呼叫instantiateFactory方法。

    loadSpringFactories方法內部會載入META-INF/spring.factories檔案，這裡載入的檔案不僅包含專案中的，還包換我們專案環境所依賴的jar包中的META-INF/spring.factories檔案。

1.現在，我們寫一個簡單的測試類，載入spring.factories檔案，例項程式碼如下：

spring.factories檔案的內容如下所示：

com.example.demo.ch3.IShareniu=\

com.example.demo.ch3.ShareniuA,\

com.example.demo.ch3.ShareniuB

   其中：IShareniu為介面，ShareniuA以及ShareniuB實現了IShareniu介面。結構如下圖所示：

2.自定義測試類並呼叫SpringFactoriesLoader類中的相關方法，如下所示：

1 public class DemoApplication {

2  public static void main(String[] args) {

3  List<String> loadFactoryNames = SpringFactoriesLoader.loadFactoryNames(IShareniu.class, null);

4  System.out.println(loadFactoryNames);

5  }

6 }

    自行上述程式碼，程式的輸出資訊如下：

[com.example.demo.ch3.ShareniuA, com.example.demo.ch3.ShareniuB]

通過上述的程式碼可知，我們確實完成了自身專案中META-INF/spring.factories檔案的屬性讀取。

那我們能否能夠通過Spring框架例項化這些類呢？答案是肯定的？例項程式碼如下：

1 List<IShareniu> loadFactories = SpringFactoriesLoader.loadFactories(IShareniu.class, null);

2  System.out.println(loadFactories);

   自行上述程式碼，程式的輸出資訊如下：

[com.example.demo.ch3.ShareniuA[email protected], [email protected]]

loadFactories方法返回的已經是例項化完畢的物件了。

1.3 SpringFactoriesLoader原理

接下來，我們看一下SpringFactoriesLoader類中的loadFactories方法，如下所示：

1 public static <T> List<T> loadFactories(Class<T> factoryClass, @Nullable ClassLoader classLoader) {

2  Assert.notNull(factoryClass, "'factoryClass' must not be null");

3  ClassLoader classLoaderToUse = classLoader;

4  if (classLoaderToUse == null) {

5  classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();

6  }

7  List<String> factoryNames = loadFactoryNames(factoryClass, classLoaderToUse);

8  if (logger.isTraceEnabled()) {

9  logger.trace("Loaded [" + factoryClass.getName() + "] names: " + factoryNames);

10  }

11  List<T> result = new ArrayList<>(factoryNames.size());

12  for (String factoryName : factoryNames) {

13  result.add(instantiateFactory(factoryName, factoryClass, classLoaderToUse));

14  }

15  AnnotationAwareOrderComparator.sort(result);

16  return result;

17  }

loadFactories方法首先獲取類載入器，然後呼叫loadFactoryNames方法獲取所有的制定資源的名稱集合、其次呼叫instantiateFactory方法例項化這些資源類並將其新增到result集合中。最後呼叫AnnotationAwareOrderComparator.sort方法進行集合的排序。

1.3.1 loadFactoryNames方法

loadFactoryNames方法核心程式碼如下：

18 public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";

19 private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {

20  MultiValueMap<String, String> result = cache.get(classLoader);

21  if (result != null)

22  return result;

23  try {

24  Enumeration<URL> urls = (classLoader != null ?

25  classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :

26  ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));

27  result = new LinkedMultiValueMap<>();

28  while (urls.hasMoreElements()) {

29  URL url = urls.nextElement();

30  UrlResource resource = new UrlResource(url);

31  Properties properties = PropertiesLoaderUtils.loadProperties(resource);

32  for (Map.Entry<?, ?> entry : properties.entrySet()) {

33  List<String> factoryClassNames = Arrays.asList(

34  StringUtils.commaDelimitedListToStringArray((String) entry.getValue()));

35  result.addAll((String) entry.getKey(), factoryClassNames);

36  }

37  }

38  cache.put(classLoader, result);

39  return result;

40  }

41  catch (IOException ex) {

42  }

43  }

loadSpringFactories方法直接載入所有的META-INF/spring.factories檔案內容，其內部還是呼叫PropertiesLoaderUtils.loadProperties方法進行處理。該方法前面我們也詳細的演示了，再次不再累贅。

唯一需要了解的是，這個地方使用了快取策略。

1.3.2 instantiateFactory方法

instantiateFactory方法的核心邏輯如下：

1  private static <T> T instantiateFactory(String instanceClassName, Class<T> factoryClass, ClassLoader classLoader) {

2  try {

3         Class<?> instanceClass = ClassUtils.forName(instanceClassName, classLoader);

4  if (!factoryClass.isAssignableFrom(instanceClass)) {

5                throw new IllegalArgumentException(

6  }

7  return (T) ReflectionUtils.accessibleConstructor(instanceClass).newInstance();

8  }

9  catch (Throwable ex) {

10  throw new IllegalArgumentException("Unable to instantiate factory class: " + factoryClass.getName(), ex);

11  }

12  }

直接呼叫了ClassUtils.forName方法，然後呼叫ReflectionUtils.accessibleConstructor方法進行例項物件進行物件的例項化工作，原來這裡直接使用了反射技術進行物件的例項化工作。原來如此。

至此，XML以及properties的定義以及獲取方式，SpringFactoriesLoader類的使用以及原理已經講解完畢。

歡迎關注我的微信公眾號，第一時間獲得部落格更新提醒，以及更多成體系的Java相關原創技術乾貨。 
掃一掃下方二維碼或者長按識別二維碼，即可關注。