Java SPI

SPI是什么

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

整体机制图如下：

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

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

使用场景

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

比较常见的例子：

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

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

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

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

使用介绍

要使用Java SPI，需要遵循如下约定：
1、当服务提供者提供了接口的一种具体实现后，在jar包的META-INF/services目录下创建一个以“接口全限定名”为命名的文件，内容为实现类的全限定名；
2、接口实现类所在的jar包放在主程序的classpath中；
3、主程序通过java.util.ServiceLoder动态装载实现模块，它通过扫描META-INF/services目录下的配置文件找到实现类的全限定名，把类加载到JVM；
4、SPI的实现类必须携带一个不带参数的构造方法；

Java SPI 示例代码

定义一组接口 (假设是com.scy.spi.IEat)，并写出接口的一个或多个实现，(假设是Dog、Cat)。

IEat.java

public interface IEat {
    void eat();
}

Cat.java

import com.scy.spi.IEat;
import com.scy.spi.food.Ifood;
import org.springframework.beans.factory.annotation.Autowired;

public class Cat implements IEat {
    @Override
    public void eat() {
        System.out.println("cat eat");
    }
}

Dog.java

import com.scy.spi.IEat;
import com.scy.spi.food.Ifood;
import org.springframework.beans.factory.annotation.Autowired;

public class Dog implements IEat {
    @Override
    public void eat() {
        System.out.println("dog eat");
    }
}

配置文件

在 src\main\resources\META-INF\services\ 文件夹下添加文件 com.scy.spi.IEat 文件，以接口的全限定名命名。

内容是要应用的实现类（这里是com.scy.spi.animal.Dog和com.scy.spi.animal.Cat，每行一个类）。

com.scy.spi.animal.Dog
com.scy.spi.animal.Cat

TestMain

import com.scy.spi.IEat;
import sun.misc.Service;

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

public class TestMain {
    public static void main(String[] args) {
        // 方式1：通过 Service.providers 获取实现类的实例
        Iterator<IEat> providers = Service.providers(IEat.class);
        while (providers.hasNext()) {
            IEat iEat = providers.next();
            iEat.eat();
        }

        // 方式2：通过 ServiceLoader.load 获取
        ServiceLoader<IEat> iEats = ServiceLoader.load(IEat.class);
        for (IEat s : iEats) {
            s.eat();
        }

    }
}

参考链接：

参考博文中还包含了原理解析，内容非常详细。
https://www.jianshu.com/p/46b42f7f593c

Spring SPI 示例代码

Spring SPI类似于Java SPI，使用SpringFactoriesLoader代替ServiceLoader，META-INF/spring.factories代替META-INF/services，实现步骤不同，但原理相同，都是反射机制。

spring.factories 配置文件

com.scy.spi.IEat=\
com.scy.spi.animal.Dog,\
com.scy.spi.animal.Cat

Test.java

import com.scy.spi.IEat;
import org.springframework.core.io.support.SpringFactoriesLoader;

import java.util.List;

public class Test {
    public static void main(String[] args) {
        List<IEat> iEats = SpringFactoriesLoader.loadFactories(IEat.class, null);
        iEats.forEach(iEat -> {
            iEat.eat();
        });
    }
}