Java的SPI是什么

Java 中区分 API 和 SPI，通俗的讲：API 和 SPI 都是相对的概念，他们的差别只在语义上，API 直接被应用开发人员使用，SPI 被框架扩展人员使用

• API Application Programming Interface
  • 大多数情况下，都是实现方来制定接口并完成对接口的不同实现，调用方仅仅依赖却无权选择不同实现。
• SPI Service Provider Interface

  • 而如果是调用方来制定接口，实现方来针对接口来实现不同的实现。调用方来选择自己需要的实现方。

  • SPI ，是一种服务发现机制。SPI 的本质是将接口实现类的全限定名配置在文件中，并由服务加载器读取配置文件，加载实现类。这样可以在运行时，动态为接口替换实现类。正因此特性，我们可以很容易的通过 SPI 机制为我们的程序提供拓展功能。SPI 机制在第三方框架中也有所应用，比如 Dubbo 就是通过 SPI 机制加载所有的组件。不过，Dubbo 并未使用 Java 原生的 SPI 机制，而是对其进行了增强，使其能够更好的满足需求。

Dubbo 的扩展点加载从 JDK 标准的 SPI (Service Provider Interface) 扩展点发现机制加强而来。

• Dubbo 改进了 JDK 标准的 SPI 的以下问题：（提高了性能，增加了功能）

  • JDK 标准的 SPI 会一次性实例化扩展点所有实现，如果有扩展实现初始化很耗时，但如果没用上也加载，会很浪费资源。
  • 如果扩展点加载失败，连扩展点的名称都拿不到了。比如：JDK 标准的 ScriptEngine，通过 getName() 获取脚本类型的名称，但如果 RubyScriptEngine 因为所依赖的 jruby.jar 不存在，导致 RubyScriptEngine 类加载失败，这个失败原因被吃掉了，和 ruby 对应不起来，当用户执行 ruby 脚本时，会报不支持 ruby，而不是真正失败的原因。
  • 增加了对扩展点 IoC 和 AOP 的支持，一个扩展点可以直接 setter 注入其它扩展点。

定义一个SPI

1. 定义一组接口 (假设是spring.SpringDao.IShout)，并写出接口的一个或多个实现。
2. 在 src/main/resources/ 下建立 /META-INF/services 目录， 新增一个以接口命名的文件 (spring.SpringDao.IShout文件)，内容是要应用的实现类，实现类的包名+类名，每个类一行。
3. 使用 ServiceLoader 来加载配置文件中指定的实现。

实现原理

1. 应用程序调用ServiceLoader.load方法
   ServiceLoader.load方法内先创建一个新的ServiceLoader，并实例化该类中的成员变量，包括：
   loader(ClassLoader类型，类加载器)
   acc(AccessControlContext类型，访问控制器)
   providers(LinkedHashMap类型，用于缓存加载成功的类)
   lookupIterator(实现迭代器功能)

2. 应用程序通过迭代器接口获取对象实例
   ServiceLoader先判断成员变量providers对象中(LinkedHashMap类型)是否有缓存实例对象，如果有缓存，直接返回。 如果没有缓存，执行类的装载：
   读取META-INF/services/下的配置文件，获得所有能被实例化的类的名称
   通过反射方法Class.forName()加载类对象，并用instance()方法将类实例化
   把实例化后的类缓存到providers对象中(LinkedHashMap类型）
   然后返回实例对象。

项目结构如下图

resources下面的文件命名和上面的包名必须一致。

调用方自定义接口，让别人去实现。

package spring.SpringDao;

public interface IShout {
    void shout();
}

下面定义两个实现：Dog 和 Cat

package spring.SpringDao;

public class Dog implements IShout {
    @Override
    public void shout() {
        System.out.println("wang wang");
    }
}

package spring.SpringDao;

public class Cat implements IShout {
    @Override
    public void shout() {
        System.out.println("miao miao");
    }
}

spring.SpringDao.IShout文件

spring.SpringDao.Cat
spring.SpringDao.Dog

再定义一个主类测试。

package spring.SpringDao;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import java.util.ServiceLoader;

public class SPIMain {
    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext();
        ServiceLoader<IShout> shouts = ServiceLoader.load(IShout.class);
        for (IShout s : shouts) {
            s.shout();
        }
    }
}

测试结果如下