SPI 介绍与使用

简介

SPI全称是Service Provider Interface，服务提供方接口，服务通常是指一个接口或者一个抽象类，服务提供方是对这个接口或者抽象类的具体实现，由第三方来实现接口提供具体的服务。SPI提供了一种动态的对应用程序进行扩展的机制，通常用作框架服务的拓展或者可替换的服务组件。

SPI机制

• 在resources/META-INF/services/目录中创建以服务全限定名命名的文件，该文件内容为服务的具体实现类的全限定名，文件中可以写多个服务的具体实现类
• 使用ServiceLoader类动态加载服务的具体实现类
• 服务具体的实现类必须有一个不带参数的构造方法

使用

定义接口或抽象类

public interface MessageService {
    String getMessage();
}
复制代码

实现接口

public class AMessageService implements MessageService {
    @Override
    public String getMessage() {
        return "Hello from module A";
    }
}
复制代码

public class BMessageService implements MessageService {
    @Override
    public String getMessage() {
        return "Welcome from b";
    }
}
复制代码

创建 SPI 描述文件

如下图所示，注意目录结构:

可以使用 google 推出的 auto-service，它可以方便的帮我们生成对应的描述文件，用法很简单

使用 auto-service:

1. 依赖 implementation 'com.google.auto.service:auto-service:1.0-rc3'
2. 在 Service 实现类使用注解 @AutoService

@AutoService(MessageService.class)
public class BMessageService implements MessageService {
    @Override
    public String getMessage() {
        return "Welcome from b";
    }
}
复制代码

调用具体服务

使用ServiceLoader去加载具体服务类，然后遍历具体的实现类，ServiceLoader其实就是去META-INFO/services目录下读取文件内容，然后实例化。

        ServiceLoader<MessageService> serviceServiceLoader = ServiceLoader.load(MessageService.class);
        for (MessageService messageService : serviceServiceLoader) {
            Log.d("auto service", "msg:" + messageService.getMessage());
        }
复制代码

优点

只提供服务接口，具体服务由其他组件实现，接口和具体实现分离，同时能够通过系统的ServiceLoader拿到这些实现类的集合，统一处理。

缺点

• Java中SPI是随jar发布的，每个不同的jar都可以包含一系列的SPI配置，而Android平台上，应用在构建的时候最终会将所有的jar合并，这样很容易造成相同的SPI冲突，常见的问题是DuplicatedZipEntryException异常
• 读取SPI配置信息是在运行时从jar包中读取，由于apk是签过名的，在从jar中读取的时候，签名校验的耗时问题会造成性能损失
• 在运行时通过反射加载类实例，会造成性能损失

总结

在 android 项目中几乎已经见不到 SPI 的使用了，如果想达到组件间通讯同时又减少性能损失，可以使用 APT 在编译时生产成对应的 Service，再通过依赖注入获取到 Service 的实例。不过在 APT 中我们又会使用SPI 技术，所以笔者觉得有必要先讲一下 SPI.

参考 demo