JAVA的SPI机制

167 阅读3分钟

JAVA的SPI机制是什么?

SPI(Service Provider Interface): ,“服务提供者接口”,是指在 服务使用方 角度提出的“接口要求”,是对“服务提供方”提出的约定,简单说就是:“我需要这样的服务,现在你们来满足”。

是不是看起来很高深的样子.其实特别简单 我们先来一个例子,大家更容易理解什么是JAVA的SPI机制:

首先我们提供了一个订单处理的接口


/**
 * @Author: lty
 * @Date: 2021/1/22 14:24
 * 订单的处理接口
 */
public interface OrderHandlerService {
    String  handler(String orderid);
}

两个实现类


public class PddOrderHandler implements OrderHandlerService
{
    @Override
    public String handler(String orderid) {
        System.out.println("Pdd handler execute");
        return "Pdd handler execute";
    }
}


public class TaobaoOrderHandler implements OrderHandlerService
{
    @Override
    public String handler(String orderid) {
        System.out.println("taobao handler execute");
        return "taobao handler execute";
    }
}

类图关系:


1. 通过直接调用实现类的方式

平常在开发过程中 我们实例一个对象是通过new 的方式

public static void main(String[] args) {
        OrderHandlerService pddOrderHandler = new PddOrderHandler();
        pddOrderHandler.handler("000000001");
}
        
//Pdd handler execute

2. 通过SPI 提供实现类的方式

通过ServiceLoader.load()方法获取实现类

public static void main(String[] args) {
        //使用spi
        ServiceLoader<OrderHandlerService> services = ServiceLoader.load(OrderHandlerService.class);
        services.forEach(orderHandlerService -> {
            orderHandlerService.handler("000001");
        });
        
        //Pdd handler execute
        //taobao handler execute
 }

注意:

通过SPI方式 我们需要提供一个特别的文件:

文件位于 /resources/META-INF/services

文件名为 com.xxx. 即接口的全限定名称

内容为两个实现类的全限定名称:

com.liangtengyu.service.Impl.PddOrderHandler
com.liangtengyu.service.Impl.TaobaoOrderHandler

具体的底层实现可以分离出来 实现外部加载,也可以将每组实现和SPI配置文件打包成不同的jar,在具体使用时根据需要使用不同的jar即可。

在源码中

ServiceLoader类定义了一个前缀 private static final String PREFIX = "META-INF/services/"

用来约定上述指定的位置,基于约定的配置读取会从这里查找,如果我们引入了第三方的jar包,如果jar中的META-INF/service有OrderHandlerService的实现,也会被读取,并且实例化里面的类。

SPI的应用

这里我们以JDBC为例子

mysql-connector-java:5.1.32 包的 META-INF/services/ 目录下有个 java.sql.Driver

文件,内容为:

com.mysql.jdbc.Driver
com.mysql.fabric.jdbc.FabricMySQLDriver

在SqlLite中 也有同样的文件.

它们都是用来加载实现了java.sql.Driver接口实现类的位置

//内容为
org.sqlite.JDBC

其它的应用:

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

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

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

...

总结

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

缺点:虽然ServiceLoader也算是使用的延迟加载,但是基本只能通过遍历全部获取,也就是接口的实现类全部加载并实例化一遍。如果你并不想用某些实现类,它也被加载并实例化了,这就造成了浪费。获取某个实现类,的方式不够灵活,多个并发多线程使用ServiceLoader类的实例是不安全的。