spring.factories配置文件的工厂模式

在springboot的各个依赖包下，我们经常看到META-INF/spring.factories这个文件。spring.factories文件的内容基本上都是这样的格式：

 # Initializers
 org.springframework.context.ApplicationContextInitializer=\
 org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\
 org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener

我们看到，这个文件配置了一个key:value格式的数据

1）key是：org.springframework.context.ApplicationContextInitializer

2）value是：org.springframework.context.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,org.springframework.context.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener

key声明的是一个接口，value则是这个接口对应的实现类，如果有多个则以","符号分割。

简单来说，spring.factories文件包含了一些接口相对应的实现类的配置，我们通过这些配置就可以知道接口有哪些可选的实现类，并通过反射获取对应的实例对象。就像是简单工厂模式一样，也因此spring将这个文件定义为spring.factories这个名字。

代码实例

下面以ApplicationContextInitializer接口为示例，我们看看springboot是怎么使用spring.factories的。

首先会用classLoader加载类路径下的所有spring.factories的配置内容，loadSpringFactories方法将返回一个key=接口名，value=实现类集合的Map结构

 private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
     // 先试着取缓存
     MultiValueMap<String, String> result = cache.get(classLoader);
     if (result != null) {
         return result;
     }
 
     try {
         // 获取所有spring.factories的URL
         Enumeration<URL> urls = (classLoader != null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) : ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
         result = new LinkedMultiValueMap<>();
         // 遍历URL
         while (urls.hasMoreElements()) {
             URL url = urls.nextElement();
             UrlResource resource = new UrlResource(url);
             // 加载每个URL中的properties配置
             Properties properties = PropertiesLoaderUtils.loadProperties(resource);
             // 遍历每个配置
             for (Map.Entry<?, ?> entry : properties.entrySet()) {
                 String factoryClassName = ((String) entry.getKey()).trim();
                 // 将实现类的配置按照","符号分割开
                 for (String factoryName : StringUtils.commaDelimitedListToStringArray((String) entry.getValue())) {
                     // 逐个添加到接口对应的集合当中
                     result.add(factoryClassName, factoryName.trim());
                 }
             }
         }
         // 加入缓存
         cache.put(classLoader, result);
         return result;
     } catch (IOException ex) {
         // ...
     }
 }

有了以上这个Map结构，就可以轻松拿到对应接口的实现类集合了，如：

 public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
     String factoryClassName = factoryClass.getName();
     return loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
 }

这里的factoryClass是接口，通过getName()方法获取全限定名，然后根据该全限定名从Map结构中get出对应的实现类全限定名的集合。

到这里我们得到了一个实现类的集合，要获取实现类具体的实例对象只需要通过反射得到实例对象即可，如：

 private <T> List<T> createSpringFactoriesInstances(Class<T> type, Class<?>[] parameterTypes,
             ClassLoader classLoader, Object[] args, Set<String> names) {
     List<T> instances = new ArrayList<>(names.size());
     // 遍历实例对象的全限定名
     for (String name : names) {
         try {
             // 加载该类
             Class<?> instanceClass = ClassUtils.forName(name, classLoader);
             // 断言是否为该接口的实现类
             Assert.isAssignable(type, instanceClass);
             // 获取构造方法
             Constructor<?> constructor = instanceClass.getDeclaredConstructor(parameterTypes);
             // 实例化该类
             T instance = (T) BeanUtils.instantiateClass(constructor, args);
             // 添加到结果集当中
             instances.add(instance);
         }
         catch (Throwable ex) {
             throw new IllegalArgumentException("Cannot instantiate " + type + " : " + name, ex);
         }
     }
     return instances;
 }

总结

spring.factories就像是工厂一样配置了大量的接口对应的实现类，我们通过这些配置 + 反射处理就可以拿到相应的实现类。这种类似于插件式的设计方式，只要引入对应的jar包，那么对应的spring.factories就会被扫描到，对应的实现类也就会被实例化，如果不需要的时候，直接把jar包移除即可。