深入理解Java SPI机制

这是我参与11月更文挑战的第6天，活动详情查看：2021最后一次更文挑战

前言

我们使用的一些开源组件，比如说dubbo， shardingJDBC 等，都提供了一些可扩展的接口API, 比如前面我们介绍的shardingJDBC中自定义主键的生成策略就是实现JavaSPI中扩展的API。

SPI介绍

SPI全称Service Provider Interface，是Java提供的一套用来被第三方实现或者扩展的API，它可以用来启用框架扩展和替换组件。

Java SPI 实际上是“基于接口的编程＋策略模式＋配置文件”组合实现的动态加载机制。

常用开源框架SPI机制的使用

适用场景，调用者根据实际使用需要，启用、扩展、或者替换框架的实现策略

• 数据库驱动加载接口实现类的加载
  JDBC加载不同类型数据库的驱动

• 日志门面接口实现类加载
  SLF4J加载不同提供商的日志实现类

• Spring
  Spring中大量使用了SPI,比如：对servlet3.0规范对ServletContainerInitializer的实现、自动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)等

• Dubbo
  Dubbo中也大量使用SPI的方式实现框架的扩展, 不过它对Java提供的原生SPI做了封装，允许用户扩展实现Filter接口

• ShardingJDBC 自定义主键生成策略。

实现一个JavaSPI案例

以ShardingJDBC 提供的自定义主键的SPI机制为例说明一下 ， ShardingJDBC 提供了两种分布式主键的策略， 雪花算法和UUID， 我们也可以SPI的扩展机制自定义主键的生成策略。

@Data
public class MyShardingKeyGenerator implements ShardingKeyGenerator {

    private AtomicLong atomicLong = new AtomicLong(0);
    private Properties properties = new Properties();

    @Override
    public Comparable<?> generateKey() {
        // 单机版本的，分布式的可以用Redis自增等等
        return atomicLong.incrementAndGet();
    }

    @Override
    public String getType() {

        //声明类型
        return "MyAtomicLong";
    }

}

在resources目录下新建META-INF文件夹，再新建services文件夹，然后新建文件的名字为org.apache.shardingsphere.spi.keygen.ShardingKeyGenerator，打开文件，复制自定义主键类全路径到文件中保存。

SPI 实现原理源码分析

ServiceLoader基本的数据结构

public final class ServiceLoader<S>
    implements Iterable<S>
{

    private static final String PREFIX = "META-INF/services/";

    // The class or interface representing the service being loaded
    private final Class<S> service;

    // The class loader used to locate, load, and instantiate providers
    private final ClassLoader loader;

    // The access control context taken when the ServiceLoader is created
    private final AccessControlContext acc;

    // Cached providers, in instantiation order
    private LinkedHashMap<String,S> providers = new LinkedHashMap<>();

    // The current lazy-lookup iterator
    private LazyIterator lookupIterator;

    /**
     * Clear this loader's provider cache so that all providers will be
     * reloaded.
     *
     * <p> After invoking this method, subsequent invocations of the {@link
     * #iterator() iterator} method will lazily look up and instantiate
     * providers from scratch, just as is done by a newly-created loader.
     *
     * <p> This method is intended for use in situations in which new providers
     * can be installed into a running Java virtual machine.
     */
    public void reload() {
        providers.clear();
        lookupIterator = new LazyIterator(service, loader);
    }

    // 构造方法
    private ServiceLoader(Class<S> svc, ClassLoader cl) {
        service = Objects.requireNonNull(svc, "Service interface cannot be null");
        loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
        acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
        reload();
    }
   ......