理解的Java中SPI机制

文章首发于Hollis公众号
做者 陈彩华
文章转载交流请联系 caison@aliyun.com
复制代码

本文经过探析JDK提供的，在开源项目中比较经常使用的Java SPI机制，但愿给你们在实际开发实践、学习开源项目提供参考。

1 SPI是什么

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

总体机制图以下：

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

系统设计的各个抽象，每每有不少不一样的实现方案，在面向的对象的设计里，通常推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，若是须要替换一种实现，就须要修改代码。为了实如今模块装配的时候能不在程序里动态指明，这就须要一种服务发现机制。 Java SPI就是提供这样的一个机制：为某个接口寻找服务实现的机制。有点相似IOC的思想，就是将装配的控制权移到程序以外，在模块化设计中这个机制尤为重要。因此SPI的核心思想就是解耦。

2 使用场景

归纳地说，适用于：调用者根据实际使用须要，启用、扩展、或者替换框架的实现策略

比较常见的例子：

• 数据库驱动加载接口实现类的加载 JDBC加载不一样类型数据库的驱动
• 日志门面接口实现类加载 SLF4J加载不一样提供商的日志实现类
• Spring Spring中大量使用了SPI,好比：对servlet3.0规范对ServletContainerInitializer的实现、自动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)等
• Dubbo Dubbo中也大量使用SPI的方式实现框架的扩展, 不过它对Java提供的原生SPI作了封装，容许用户扩展实现Filter接口

3 使用介绍

要使用Java SPI，须要遵循以下约定：

• 一、当服务提供者提供了接口的一种具体实现后，在jar包的META-INF/services目录下建立一个以“接口全限定名”为命名的文件，内容为实现类的全限定名；
• 二、接口实现类所在的jar包放在主程序的classpath中；
• 三、主程序经过java.util.ServiceLoder动态装载实现模块，它经过扫描META-INF/services目录下的配置文件找到实现类的全限定名，把类加载到JVM；
• 四、SPI的实现类必须携带一个不带参数的构造方法；

示例代码

步骤1、定义一组接口 (假设是org.foo.demo.IShout)，并写出接口的一个或多个实现，(假设是org.foo.demo.animal.Dog、org.foo.demo.animal.Cat)。

public interface IShout {
    void shout();
}
public class Cat implements IShout {
    @Override
    public void shout() {
        System.out.println("miao miao");
    }
}
public class Dog implements IShout {
    @Override
    public void shout() {
        System.out.println("wang wang");
    }
}
复制代码

步骤2、在 src/main/resources/ 下创建 /META-INF/services 目录， 新增一个以接口命名的文件 (org.foo.demo.IShout文件)，内容是要应用的实现类（这里是org.foo.demo.animal.Dog和org.foo.demo.animal.Cat，每行一个类）。

文件位置

- src
    -main
        -resources
            - META-INF
                - services
                    - org.foo.demo.IShout
复制代码

文件内容

org.foo.demo.animal.Dog
org.foo.demo.animal.Cat
复制代码

步骤3、使用 ServiceLoader 来加载配置文件中指定的实现。

public class SPIMain {
    public static void main(String[] args) {
        ServiceLoader<IShout> shouts = ServiceLoader.load(IShout.class);
        for (IShout s : shouts) {
            s.shout();
        }
    }
}
复制代码

代码输出：

wang wang
miao miao
复制代码

4 原理解析

首先看ServiceLoader类的签名类的成员变量：

public final class ServiceLoader<S> implements Iterable<S>{
private static final String PREFIX = "META-INF/services/";

    // 表明被加载的类或者接口
    private final Class<S> service;

    // 用于定位，加载和实例化providers的类加载器
    private final ClassLoader loader;

    // 建立ServiceLoader时采用的访问控制上下文
    private final AccessControlContext acc;

    // 缓存providers，按实例化的顺序排列
    private LinkedHashMap<String,S> providers = new LinkedHashMap<>();

    // 懒查找迭代器
    private LazyIterator lookupIterator;
  
    ......
}
复制代码

参考具体ServiceLoader具体源码，代码量很少，加上注释一共587行，梳理了一下，实现的流程以下：

• 1 应用程序调用ServiceLoader.load方法 ServiceLoader.load方法内先建立一个新的ServiceLoader，并实例化该类中的成员变量，包括：

  • loader(ClassLoader类型，类加载器)
  • acc(AccessControlContext类型，访问控制器)
  • providers(LinkedHashMap<String,S>类型，用于缓存加载成功的类)
  • lookupIterator(实现迭代器功能)

• 2 应用程序经过迭代器接口获取对象实例 ServiceLoader先判断成员变量providers对象中(LinkedHashMap<String,S>类型)是否有缓存实例对象，若是有缓存，直接返回。 若是没有缓存，执行类的装载，实现以下：

• (1) 读取META-INF/services/下的配置文件，得到全部能被实例化的类的名称，值得注意的是，ServiceLoader能够跨越jar包获取META-INF下的配置文件，具体加载配置的实现代码以下：

try {
            String fullName = PREFIX + service.getName();
            if (loader == null)
                configs = ClassLoader.getSystemResources(fullName);
            else
                configs = loader.getResources(fullName);
        } catch (IOException x) {
            fail(service, "Error locating configuration files", x);
        }
复制代码

• (2) 经过反射方法Class.forName()加载类对象，并用instance()方法将类实例化。
• (3) 把实例化后的类缓存到providers对象中，(LinkedHashMap<String,S>类型） 而后返回实例对象。

5 总结

优势： 使用Java SPI机制的优点是实现解耦，使得第三方服务模块的装配控制的逻辑与调用者的业务代码分离，而不是耦合在一块儿。应用程序能够根据实际业务状况启用框架扩展或替换框架组件。

缺点：

• 虽然ServiceLoader也算是使用的延迟加载，可是基本只能经过遍历所有获取，也就是接口的实现类所有加载并实例化一遍。若是你并不想用某些实现类，它也被加载并实例化了，这就形成了浪费。获取某个实现类的方式不够灵活，只能经过Iterator形式获取，不能根据某个参数来获取对应的实现类。
• 多个并发多线程使用ServiceLoader类的实例是不安全的。

更多精彩，欢迎关注做者公众号【分布式系统架构】

参考

Java核心技术36讲

The Java™ Tutorials

Java Doc

Service Provider Interface: Creating Extensible Java Applications

Service provider interface

Java ServiceLoader使用和解析

Java基础之SPI机制

Java中SPI机制深刻及源码解析

SPI机制简介