SPI(Service Provider Interface)机制在 Java 中是在Java 6中引入的。在Java 6之前,SPI机制并不是Java的标准特性,但它是一种常见的设计模式和实践。
使用
SPI(Service Provider Interface)机制中的接口(或抽象类)通常需要包含在主项目中。接口定义了扩展点,而实现类可以分散在不同的模块或插件中。主项目通过接口来定义需要扩展的功能,并使用SPI机制来动态加载和使用不同模块或插件中的实现类。
示例
// 主程序添加接口或者抽象类
public interface MyService {
void doSomething();
}
// 主项目加载方式
ServiceLoader<MyService> serviceLoader = ServiceLoader.load(MyService.class);
for (MyService myService : serviceLoader){
myService.doSomething();
// 将接口的实现类通过jar方式加如,jar放在classPath 如果是单个class文件可以放在resources下面
public class MyServiceImpl1 implements MyService {
@Override
public void doSomething() {
System.out.println("MyServiceImpl1 is doing something.");
}
}
public class MyServiceImpl2 implements MyService {
@Override
public void doSomething() {
System.out.println("MyServiceImpl2 is doing something.");
}
}
// SPI 配置文件放在META-INF/services 下面格式
META-INF/services/com.example.MyService
文件的后缀对于SPI机制并不重要,SPI机制主要关注配置文件中的内容,即实现类的全限定名
com.example.MyServiceImpl1
com.example.MyServiceImpl2
总结
1、主项目中的接口:在主项目中定义扩展点接口或抽象类,它表示需要扩展的功能。
2、实现类的单独JAR文件:将扩展实现类打包成单独的 JAR 文件,每个 JAR 文件包含了实现接口的具体实现类。
3、META-INF/services 配置文件:在每个实现类的 JAR 文件的 META-INF/services 目录下创建一个配置文件,以接口的全限定名为文件名,内容为实现类的全限定名。