参考:
https://www.jianshu.com/p/46b42f7f593c
https://blog.csdn.net/noaman_wgs/article/details/102529022
介绍
SPI全称Service Provider Interface(服务提供接口),是专门被第三方实现或者扩展的API,可以用来启用框架扩展和替换组件,提供了为某个接口寻找对应服务类的机制。
Java SPI 实际上是基于接口的编程+策略模式+配置文件组合实现的动态加载机制。
系统设计的各个抽象,往往有很多不同的实现方案,在面向的对象的设计里,一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。
Java SPI就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。所以SPI的核心思想就是解耦。
使用方法
使用Java SPI,需要遵循如下方法:
- 当服务提供者提供了接口的一种具体实现后,在jar包的META-INF/services目录下创建一个以“接口全限定名”为命名的文件,内容为实现类的全限定名;
- 接口实现类所在的jar包放在主程序的classpath中;
- 主程序通过 java.util.ServiceLoder 动态装载实现模块,它通过扫描META-INF/services目录下的配置文件找到实现类的全限定名,把类加载到JVM;
- SPI的实现类必须携带一个不带参数的构造方法。
开发示例
首先创建一个Java工程,在其中编写一个接简单的接口。
public interface IAnimal {
void speak();
}
然后编写它的两个实现类。
public class Cat implements IAnimal {
public void speak() {
System.out.println("Hello, I'm Cat");
}
}
public class Dog implements IAnimal {
public void speak() {
System.out.println("Hello, I'm Dog");
}
}
在项目的 src/main/resources/ 目录下建立 /META-INF/services 目录, 新增一个以接口命名的文件 (org.wyk.demo.animal.IAnimal文件),其中的内容是要应用的实现类(这里是org.wyk.demo.animal.Dog和org.wyk.demo.animal.Cat,每行一个类,当然你也可以只写一个)。
org.wyk.demo.animal.Dog
org.wyk.demo.animal.Cat
这样,我们就可以在代码中使用 ServiceLoader 来加载配置文件中指定的实现。
public class App {
public static void main(String[] args) {
ServiceLoader<IAnimal> animals = ServiceLoader.load(IAnimal.class);
for(IAnimal animal : animals) {
animal.speak();
}
}
}
输出结果如下:
Hello, I'm Dog
Hello, I'm Cat
应用场景
SPI 在 Java 中有很多应用,这里介绍几个典型的应用场景:
- JDBC加载不同类型数据库驱动。
- 日志门面实现不同日志的加载。
- Dubbo 框架中SPI机制,不过 Dubbo 没有使用原生的ServiceLoader,实现了自己的SPI机制。这样做是因为Java SPI机制会加载所有接口实现类并且全部实例化,有些可能是用不到的,所以这造成了资源的浪费。另外当有较多扩展时,SPI加载起来会有一定的耗时,且某个扩展加载失败会导致剩下的均无法加载。
后续有时间的话可以学习下 Dubbo的 SPI 机制。
原理解析
根据 ServiceLoader 的代码分析下 SPI 原理。
ServiceLoader 中包含如下字段:
public final class ServiceLoader<S>
implements Iterable<S>
{
// 扫描目录
private static final String PREFIX = "META-INF/services/";
// 需要加载的类或接口
private final Class<S> service;
// 用于定位、加载、实例化实现的类加载器
private final ClassLoader loader;
// 创建 ServiceLoader时采用的访问控制上下文
private final AccessControlContext acc;
// 缓存提供的实现类,按实例化的顺序
private LinkedHashMap<String,S> providers = new LinkedHashMap<>();
// 延迟查找迭代器
private LazyIterator lookupIterator;
...
}
ServiceLoader 加载配置的流程如下:
- 读取META-INF/services/下的配置文件,获得所有能被实例化的类的名称,值得注意的是,ServiceLoader 可以跨越jar包获取META-INF下的配置文件,具体加载配置的实现代码如下:
try {
String fullName = PREFIX + service.getName();
if (loader == null)
configs = ClassLoader.getSystemResources(fullName);
else
configs = loader.getResources(fullName);
} catch (IOException x) {
fail(service, "Error locating configuration files", x);
}
-
通过反射方法Class.forName()加载类对象,并用instance()方法将类实例化。
-
把实例化后的类缓存到providers对象中,
然后返回实例对象。
总结
SPI的优点和缺点如下:
-
优点:解耦。使服务模块和调用者业务代码分离,而不是耦合在一起。应用程序可以根据实际业务情况启用框架或者替换框架中组件。
-
缺点:
- ServiceLoader用的是延迟加载,会遍历所有接口的实现类并且全部加载实例化。如果某些类不想使用也会被加载实例化,造成了浪费。可以参考Dubbo SPI机制进行优化。
- 多个并发多线程使用ServiceLoader类的实例是不安全的。
网友评论