了解一下Java SPI的原理

了解一下Java SPI的原理

1 为何写这篇文章？

近期，本人在学习dubbo相关的知识，可是在dubbo官网中有提到Java的 SPI，这个名词以前未接触过，因此就去看了看，感受仍是有不少地方有使用的，好比jdbc、log相关的技术上均有使用，仍是颇有用处的，就在这里总结一下本身的学习内容！（本文有参考相关资料：好比dubbo官网、相关blog等）

2 SPI是什么？

Java SPI(Service Provider Interface)是JDK内置的一种动态加载扩展点的实现。在ClassPath的META-INF/services目录下放置一个与接口同名的文本文件，文件的内容为接口的实现类，多个实现类用换行符分隔。JDK中使用java.util.ServiceLoader来加载具体的实现。

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

3 自定义一个SPI

3.1 建立工程

建立dubbo-spi的工程，这里展现一下完整的spi示例程序结构：

3.2 建立接口

在包top.flygrk.ishare.spi.service下建立接口： SPIService

package top.flygrk.ishare.spi.service;

/**
 * @Package top.flygrk.ishare.spi.service
 * @Version V1.0
 * @Description: SPIService 接口
 */
public interface SPIService {
    /**
     * 接口方法： say()
     */
    String say();
}
复制代码

3.3 建立实现类： ASPIServiceImpl和BSPIServiceImpl

在包top.flygrk.ishare.spi.service.impl下建立ASPIServiceImpl和BSPIServiceImpl类，均实现SPIservice接口：

• ASPIServiceImpl

package top.flygrk.ishare.spi.service.impl;

import top.flygrk.ishare.spi.service.SPIService;

/**
 * @Package top.flygrk.ishare.spi.service.impl
 * @Version V1.0
 * @Description: SPIService 实现类 ASPIServiceImpl
 */
public class ASPIServiceImpl implements SPIService {
    @Override
    public String say() {
        return "ASPIServiceImpl";
    }
}
复制代码

• BSPIServiceImpl

package top.flygrk.ishare.spi.service.impl;

import top.flygrk.ishare.spi.service.SPIService;

/**
 * @Package top.flygrk.ishare.spi.service.impl
 * @Version V1.0
 * @Description: SPIService 实现类 BSPIServiceImpl
 */
public class BSPIServiceImpl implements SPIService {
    @Override
    public String say() {
        return "BSPIServiceImpl";
    }
}
复制代码

3.4 建立文件top.flygrk.ishare.spi.service.SPIService

在resource目录下，建立META-INF/services目录，并在该目录下建立top.flygrk.ishare.spi.service.SPIService文件（该文件名为接口的全路径，需保持一致），并在该文件中配置两个实现类的全路径：

top.flygrk.ishare.spi.service.impl.ASPIServiceImpl
top.flygrk.ishare.spi.service.impl.BSPIServiceImpl复制代码

3.5 建立测试类TestSPIService

在包top.flygrk.ishare.demo下建立TestSPIService类，用于测试该SPI服务

package top.flygrk.ishare.demo;

import top.flygrk.ishare.spi.service.SPIService;

import java.util.Iterator;
import java.util.ServiceLoader;

/**
 * @Package top.flygrk.ishare.demo
 * @Version V1.0
 * @Description: 测试 SPIService
 */
public class TestSPIService {

    public static void main(String[] args) {
        // ServiceLoader实现了Iterable接口，能够遍历出全部的服务实现者
        ServiceLoader<SPIService> serviceLoaders = ServiceLoader.load(SPIService.class);

        /*
         * 方法1： 迭代器
         */
        Iterator<SPIService> spiServiceIterator = serviceLoaders.iterator();
        while (spiServiceIterator != null && spiServiceIterator.hasNext()) {
            SPIService spiService = spiServiceIterator.next();
            System.out.println(spiService.getClass().getName() + " : " + spiService.say());
        }


        /*
         * 迭代方法2： foreach
         */
//        for (SPIService spiService : serviceLoaders) {
//            System.out.println(spiService.getClass().getName() + " : " + spiService.say());
//        }

    }

}
复制代码

3.6 测试类运行结果

top.flygrk.ishare.spi.service.impl.ASPIServiceImpl : ASPIServiceImpl
top.flygrk.ishare.spi.service.impl.BSPIServiceImpl : BSPIServiceImpl复制代码

4 SPI原理分析

在咱们阅读源码前，咱们先提出如下几个问题，而后咱们再去带着问题去源码中找答案：

• 1) META-INF/services目录下的文件有什么用？为何要用接口的全路径命名？是否能够更改接口名称？里面的内容为何要用实现类的全路径？
• 2） ServiceLoader 是如何获取到SPIService的所有实现的？
• 3） 若是咱们只想取ASPIServiceImpl，并不想去操做BSPIServiceImpl，如何去操做？

4.1 ServiceLoader结构

咱们先看一下ServiceLoader类的结构：

进入ServiceLoader类的源码，咱们能够看到如下定义的一些常量：

各位确定注意到了一点： private static final String PREFIX = "META-INF/services/"; ， 这个PREFIX后面的路径不正是咱们在上述示例中建立和接口保持一致的文件的目录吗？还有services、loader、acc、lookupIterator和providers表达的意思在源码上方的注释中也进行了描述，下面我将各个属性的释义标注一下：

// 配置文件的目录
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;复制代码

4.2 ServiceLoader的加载过程

看完了上面ServiceLoader的结构，下面咱们再来看看ServiceLoader是如何一步步加载的。咱们在TestSPIService类上的main方法第一行打上断点：

而后使用debug的方式调试，进入ServiceLoader的源码，会依次进入如下几个函数：

通过这些步骤以后，serviceLoader内部包含有一个Iterator迭代器，下面咱们来仔细看一下这个迭代器的做用！

4.3 迭代器lookupIterator的操做

在上述4.2步骤加载完成以后，serviceLoader内的lookupIterator的内容以下：

而后使用iterator()方法获取Iterator迭代器时，执行以下的程序：

在通过上述过程以后，咱们拿到了Iterator迭代器，这时咱们看下spiServiceIterator的内容：

是否是很奇怪，仍是只有SPIService，不要忘记了，他内部的迭代器但是懒加载的！咱们继续跟进代码，进入到hasNext()方法。

从上面能够知道，acc一直为null的，因此这时候，他进入了hasNextService()方法：

重头戏来了，咱们能够看到其中的 PREFIX， 这个内容就是咱们配置的文件。再仔细的跟进代码，咱们会进入到parse()方法，该方法用于按照行读取出文件中的内容，并保存到Iterator 中。

故而，再经过 nextName = pending.next(); 执行后，获取到top.flygrk.ishare.spi.service.impl.ASPIServiceImpl，继而进行后续的next()方法操做。

而后进入到nextService()方法：

再nextService()方法里，使用了反射的技术，根据前面从文件中读取到的实现类全路径top.flygrk.ishare.spi.service.impl.ASPIServiceImpl获取到该实现类的对象！走到这里，也就基本上了解了SPI，可是咱们能只获取ASPIServiceImpl，而不去获取BSPIServiceImpl吗？对不起，这里不容许这样，只能经过迭代器遍历出全部的内容！除非人为干预（外层循环比对完成以后退出循环）。接下来的步骤就和前面几乎一致了，这里再也不细述～

5 SPI 优缺点

咱们评价一门思想每每须要从其优缺点的方向进行考虑。SPI一样也是有必定的优缺点存在的，下面咱们来仔细的看下它有哪些优缺点：

5.1 优势

• 解耦：最大的优势也就是解耦了，经过SPI可使第三方服务模块的逻辑与业务代码相分离，而不耦合在一块儿。应用程序能够根据实际业务进行扩展。

5.2 缺点

参考dubbo官方文档

• 须要遍历全部的实现，并实例化，而后咱们在循环中才能找到咱们须要的实现。
• 配置文件中只是简单的列出了全部的扩展实现，而没有给他们命名。致使在程序中很难去准确的引用它们。
• 扩展若是依赖其余的扩展，作不到自动注入和装配
• 不提供相似于Spring的IOC和AOP功能
• 扩展很难和其余的框架集成，好比扩展里面依赖了一个Spring bean，原生的Java SPI不支持

6 SPI案例分析

在咱们经常使用的框架中，有不少都是有使用SPI的方式，其中包括JDBC加载不一样类型数据库的驱动、SLF4J加载不一样提供商的日志实现类、Spring 框架、Dubbo框架。

这里须要注意，dubbo框架的SPI是对原生的Java SPI 进行了扩展的。关于dubbo的SPI咱们将在后面详细讲解。如今，咱们来以JDBC加载的方式来简单的看看其SPI的方式。

咱们先找到mysql的包，其结构以下：

在META-INF/services 目录下，存在 文件 java.sql.Driver，其内容为：

经过这个路径，咱们也能够找到 com.mysql.jdbc.Driver类，它实现了java.sql.Driver接口：

诸如Oracle，一样也有此机制，这里就再也不细述了，请自行验证查看～

Blog:

• 简书： https://www.jianshu.com/u/91378a397ffe
• csdn： https://blog.csdn.net/ZhiyouWu
• 开源中国： https://my.oschina.net/u/3204088
• 掘金： https://juejin.im/user/5b5979efe51d451949094265
• 博客园： https://www.cnblogs.com/zhiyouwu/
• 微信公众号： 源码湾
• 微信： WZY1782357529 (欢迎沟通交流)