个人语雀文档:JAVA SPI机制
什么是SPI
SPI 全称:Service Provider Interface,为某个接口寻找服务实现的机制
SPI规范
● 当服务的提供者提供了一种接口的实现之后,需要在classpath下的META-INF/services/目录里创建一个以服务接口命名的文件,这个文件里的内容就是这个接口的具体的实现类。
● 当其他的程序需要这个服务的时候,就可以通过查找这个jar包(一般都是以jar包做依赖)的META-INF/services/中的配置文件,配置文件中有接口的具体实现类名,可以根据这个类名进行加载实例化,就可以使用该服务了。
● JDK中查找服务的实现的工具类是:java.util.ServiceLoader。
SPI 的不足
- 不能按需加载,需要遍历所有的实现,并实例化,然后在循环中才能找到我们需要的实现。如果不想用某些实现类,或者某些类实例化很耗时,它也被载入并实例化了,这就造成了浪费。
- 获取某个实现类的方式不够灵活,只能通过 Iterator 形式获取,不能根据某个参数来获取对应的实现类。(Spring 的BeanFactory,ApplicationContext 就要高级一些了。)
- 多个并发多线程使用 ServiceLoader 类的实例是不安全的。
SPI使用示例
使用步骤
5. 定义接口 PhoneService
6. 定义接口的两个实现类 HuaWeiService 和 XiaoMiService
7. 约定配置:新建 META-INF/services 目录。目录下新建文件,文件名为 PhoneService 接口的全限定名
a. 目录约定:META-INF/services
b. 文件名约定:接口的全限定名
8. 文件内容:接口的实现类的全限定名
org.example.service.Impl.HuaWeiService
org.example.service.Impl.XiaoMiService
- 通过 ServiceLoader 加载实现类并调用服务
package org.example;
import org.example.service.PhoneService;
import java.util.ServiceLoader;
public class Application {
public static void main(String[] args) {
ServiceLoader<PhoneService> loader = ServiceLoader.load(PhoneService.class);
for (PhoneService provider : loader) {
System.out.println(provider.getName());
}
}
}
项目demo
github仓库地址:springboot-learn