深入浅出剖析SpringBoot中Spring Factories机制

什么是spring.factory？

Spring Boot中有一种非常解耦的扩展机制：SpringFactories。这种扩展机制实际上是仿照Java中的SPI扩展机制来实现的。

什么是SPI机制

这里我就用比较通俗易懂的方式来简单说一下，SPI机制就是不同服务开发商在各自的jar包中提供一个相同名字的配置文件（名字和java定义的通用接口同名）。比如说各个数据库开发商都会在jar包的META-INF/services目录下放一个java.sql.Driver的文件（Driver就是一个接口）。

Java SPI机制

• Java SPI是什么？
  SPI的全名为Service Provider Interface.大多数开发人员可能不熟悉，因为这个是针对厂商或者插件的。
  我们系统里抽象的各个模块，往往有很多不同的实现方案，比如日志模块的方案，xml解析模块、jdbc模块的方案等。
  面向的对象的设计里，我们一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，
  如果需要替换一种实现，就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。
  Java SPI就是提供这样的一个机制：为某个接口寻×××实现的机制。

• Java SPI的约定
  当服务的提供者，提供了服务接口的一种实现之后，在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。
  该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候，就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名，并装载实例化，完成模块的注入。

  • 基于这样一个约定就能很好的找到服务接口的实现类，而不需要再代码里制定。

  • jdk提供服务实现查找的一个工具类：java.util.ServiceLoader 。

SpringBoot中的SPI机制

在Spring中也有一种类似与Java SPI的加载机制。它在META-INF/spring.factories文件中配置接口的实现类名称，然后在程序中读取这些配置文件并实例化。
这种自定义的SPI机制是Spring Boot Starter实现的基础。

Spring Factories实现原理

spring-core包里定义了SpringFactoriesLoader类，这个类实现了检索META-INF/spring.factories文件，并获取指定接口的配置的功能。
在这个类中定义了两个对外的方法：

1、loadFactories

根据接口类获取其实现类的实例，这个方法返回的是对象列表，其源代码：

public static <T> List<T> loadFactories(Class<T> factoryClass, @Nullable ClassLoader classLoader) {    Assert.notNull(factoryClass, "'factoryClass' must not be null");    ClassLoader classLoaderToUse = classLoader;    if (classLoaderToUse == null) {        classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();    }    List<String> factoryNames = loadFactoryNames(factoryClass, classLoaderToUse);    if (logger.isTraceEnabled()) {        logger.trace("Loaded [" + factoryClass.getName() + "] names: " + factoryNames);    }    List<T> result = new ArrayList<>(factoryNames.size());    for (String factoryName : factoryNames) {        result.add(instantiateFactory(factoryName, factoryClass, classLoaderToUse));    }    AnnotationAwareOrderComparator.sort(result);    return result;}

• 先获取ClassLoader

• 调用loadFacotoryNames()方法，获取factoryNames，其源码如下：

public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {    //获取到类名    String factoryClassName = factoryClass.getName();    //在当前ClassLoader下的所有META-INF/spring.factories文件的配置信息的Map中获取指定的factory的值，如果不存在，则返回空列表    return loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());}

• 调用loadSpringFactories方法，获取当前ClassLoader下的所有META-INF/spring.factories文件的配置信息

private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {    //去缓存中获取对应的    MultiValueMap<String, String> result = cache.get(classLoader);    if (result != null)        return result;    try {        //获取当前ClassLoader下的所有包含META-INF/spring.factories文件的URL路径        Enumeration<URL> urls = (classLoader != null ?                classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :                ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));        //初始返回对象        result = new LinkedMultiValueMap<>();        //遍历所有的包含META-INF/spring.factories文件URL集合        while (urls.hasMoreElements()) {            URL url = urls.nextElement();            UrlResource resource = new UrlResource(url);            //转换为Properties对象            Properties properties = PropertiesLoaderUtils.loadProperties(resource);            //遍历META-INF/spring.factories文件中的所有属性            for (Map.Entry<?, ?> entry : properties.entrySet()) {                //如果一个接口希望配置多个实现类，可以使用','进行分割，将当前Key对应的值转换为List                List<String> factoryClassNames = Arrays.asList(StringUtils.commaDelimitedListToStringArray((String) entry.getValue()));                //添加到返回对象中                result.addAll((String) entry.getKey(), factoryClassNames);            }        }        //添加到缓存中        cache.put(classLoader, result);        //返回结果        return result;    }    catch (IOException ex) {        throw new IllegalArgumentException("Unable to load factories from location [" +                FACTORIES_RESOURCE_LOCATION + "]", ex);    }}

我们可以在自己的jar中配置spring.factories文件，不会影响到其它地方的配置，也不会被别人的配置覆盖。
这一点非常有利于后期我们进行自定义扩展。

• 调用instantiateFactory，实例化获取到的对应的Factory对象，其源码：

private static <T> T instantiateFactory(String instanceClassName, Class<T> factoryClass, ClassLoader classLoader) {    try {        //根据类名获取类的实例，这个源码在上一篇中已经剖析过了。        Class<?> instanceClass = ClassUtils.forName(instanceClassName, classLoader);        //isAssignableFrom()是判断instanceClassName的对象是否是FactoryClass的子类或者相同的类，如果是返回true。        if (!factoryClass.isAssignableFrom(instanceClass)) {            //如果实例化的目标类不是Factory类的子类或者不是Factory类，则抛出异常            throw new IllegalArgumentException("Class [" + instanceClassName + "] is not assignable to [" + factoryClass.getName() + "]");        }        //通过java反射机制，实例化目标类        return (T) ReflectionUtils.accessibleConstructor(instanceClass).newInstance();    }    catch (Throwable ex) {        throw new IllegalArgumentException("Unable to instantiate factory class: " + factoryClass.getName(), ex);    }}

从这段代码中我们可以知道，它只支持没有参数的构造方法。

2、loadFactoryNames

根据接口获取其接口类的名称，这个方法返回的是类名的列表，其源代码已经在上面分析过了。

SpringBoot启动时的应用

在SpringBoot启动过程中，创建SpringApplication对象是，有如下两行代码：

setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));

• 使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationContextInitializer

• 使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationListener

Spring Factories机制的应用

在日常工作中，我们可能需要实现一些SDK或者Spring Boot Starter给被人使用，这个使用我们就可以使用Factories机制。
Factories机制可以让SDK或者Starter的使用只需要很少或者不需要进行配置，只需要在服务中引入我们的jar包。

知识点

• Class的isAssignableFrom()解析

public native boolean isAssignableFrom(Class<?> cls);

由方法签名可见是一个本地方法，即C代码编写的。  
其作用：  
有两个Class类型的类象，一个是调用isAssignableFrom方法的类对象（后称对象a），以及方法中作为参数的这个类对象（称之为对象b），这两个对象如果满足以下条件则返回true，否则返回false：

• a对象所对应类信息是b对象所对应的类信息的父类或者是父接口，简单理解即a是b的父类或接口

• a对象所对应类信息与b对象所对应的类信息相同，简单理解即a和b为同一个类或同一个接口

这里我就用比较通俗易懂的方式来简单说一下，SPI机制就是不同服务开发商在各自的jar包中提供一个相同名字的配置文件（名字和java定义的通用接口同名）。比如说各个数据库开发商都会在jar包的META-INF/services目录下放一个java.sql.Driver的文件（Driver就是一个接口）。

mysql的jar包下这个文件是：

com.mysql.jdbc.Driver
com.mysql.fabric.jdbc.FabricMySQLDriver

postgresql的jar包下这个文件是：

org.postgresql.Driver

然后在建立新的数据库连接时只需要执行

Connection conn = DriverManager.getConnection(url,username,password);

DriverManager会通过ServiceLoader自动加载jar包下的对应的java.sql.Driver驱动。

spring的spi机制

在Spring中也有一种类似与Java SPI的加载机制。 它在META-INF/spring.factories文件中配置接口的实现类名称，然后在程序中读取这些配置文件并实例化。 这种自定义的SPI机制是Spring Boot Starter实现的基础。

在日常工作中，我们可能需要实现一些SDK或者Spring Boot Starter给被人使用时， 我们就可以使用Factories机制。Factories机制可以让SDK或者Starter的使用只需要很少或者不需要进行配置，只需要在服务中引入我们的jar包即可。

SPI -> Service Provider Interface, 为某个接口寻找服务实现的机制. 在模块化设计中这个机制尤其重要。
在META-INF/spring.factories文件中配置接口的实现类名称，然后在程序中读取这些配置文件并实例化。

原理

spring-core包里定义了SpringFactoriesLoader类, 这个类实现了检索META-INF/spring.factories文件，并获取指定接口的配置的功能。