Java-SPI机制详解
Java之SPI机制详解1: SPI机制简介
SPI 全称是 Service Provider Interface，是一种 JDK 内置的动态加载实现扩展点的机制，通过 SPI 技术我们可以动态获取接口的实现类，不用自己来创建。这个不是什么特别的技术，只是 一种设计理念。
2: SPI原理
https://img2023.cnblogs.com/blog/2583137/202304/2583137-20230408114855557-21922410.png
Java SPI 实际上是基于接口的编程＋策略模式＋配置文件组合实现的动态加载机制。
系统设计的各个抽象，往往有很多不同的实现方案，在面向的对象的设计里，一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。
Java SPI就是提供这样的一个机制：为某个接口寻找服务实现的机制。有点类似IOC的思想，就是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要。所以SPI的核心思想就是解耦。
3: 使用场景
调用者根据实际使用需要 启用、扩展、或者替换框架的实现策略
下面是一些使用了该机制的场景
[*]JDBC驱动，加载不同数据库的驱动类
[*]Spring中大量使用了SPI,比如：对servlet3.0规范对ServletContainerInitializer的实现、自动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)等
[*]Dubbo中也大量使用SPI的方式实现框架的扩展, 不过它对Java提供的原生SPI做了封装，允许用户扩展实现Filter接口
[*]Tomcat 加载 META-INF/services下找需要加载的类
[*]SpringBoot项目中 使用@SpringBootApplication注解时，会开始自动配置，而启动配置则会去扫描META-INF/spring.factories下的配置类
4: 源码论证
4.1 应用程序调用ServiceLoader.load方法
ServiceLoader.load方法内先创建一个新的ServiceLoader，并实例化该类中的成员变量
private static final String PREFIX = "META-INF/services/";
private ServiceLoader(Class<S> svc, ClassLoader cl) {
service = Objects.requireNonNull(svc, "Service interface cannot be null");
loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
reload();
}
/**
*
* 在调用该方法之后，迭代器方法的后续调用将延迟地从头开始查找和实例化提供程序，就像新创建的加载程序所做的 那样
*/
public void reload() {
providers.clear(); //清除此加载程序的提供程序缓存，以便重新加载所有提供程序。
lookupIterator = new LazyIterator(service, loader);
}
private class LazyIterator implements Iterator<S>{
Class<S> service;
ClassLoader loader;
Enumeration<URL> configs = null;
Iterator<String> pending = null;
String nextName = null;
private boolean hasNextService() {
if (nextName != null) {
return true;
}
if (configs == null) {
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);
}
}
while ((pending == null) || !pending.hasNext()) {
if (!configs.hasMoreElements()) {
return false;
}
//解析配置文件
pending = parse(service, configs.nextElement());
}
//获取配置文件中内容
nextName = pending.next();
return true;
}
}
/**
*
*通过反射 实例化配置文件中的具体实现类
*/
private S nextService() {
if (!hasNextService())
throw new NoSuchElementException();
String cn = nextName;
nextName = null;
Class<?> c = null;
try {
c = Class.forName(cn, false, loader);
} catch (ClassNotFoundException x) {
fail(service,
"Provider " + cn + " not found");
}
if (!service.isAssignableFrom(c)) {
fail(service,
"Provider " + cn+ " not a subtype");
}
try {
S p = service.cast(c.newInstance());
providers.put(cn, p);
return p;
} catch (Throwable x) {
fail(service,
"Provider " + cn + " could not be instantiated",
x);
}
throw new Error(); // This cannot happen
}5: 实战
步骤1 新建以下类
public interface IService {
/**
* 获取价格
* @return
*/
String getPrice();
/**
* 获取规格信息
* @return
*/
String getSpecifications();
}public class GoodServiceImpl implements IService {
@Override
public String getPrice() {
return "2000.00元";
}
@Override
public String getSpecifications() {
return "200g/件";
}
}public class MedicalServiceImpl implements IService {
@Override
public String getPrice() {
return "3022.12元";
}
@Override
public String getSpecifications() {
return "30粒/盒";
}
}步骤2、在 src/main/resources/ 下建立 /META-INF/services 目录, 新增一个以接口命名的文件 org.example.IService.txt 。内容是要应用的实现类，我这边需要放入的数据如下
org.example.GoodServiceImpl
org.example.MedicalServiceImpl步骤3、使用 ServiceLoader 来加载配置文件中指定的实现。
public class Main {
public static void main(String[] args) {
final ServiceLoader<IService> serviceLoader = ServiceLoader.load(IService.class);
serviceLoader.forEach(service -> {
System.out.println(service.getPrice() + "=" + service.getSpecifications());
});
}
}输出:
2000.00元=200g/件
3022.12元=30粒/盒6: 优缺点
6.1 优点
解耦使得第三方服务模块的装配控制的逻辑与调用者的业务代码分离，而不是耦合在一起，应用程序可以根据实际业务情况启用框架扩展或替换框架组件。相比使用提供接口jar包，供第三方服务模块实现接口的方式，SPI的方式使得源框架，不必关心接口的实现类的路径
6.2 缺点
[*]虽然ServiceLoader也算是使用的延迟加载，但是基本只能通过遍历全部获取，也就是接口的实现类全部加载并实例化一遍。如果你并不想用某些实现类，它也被加载并实例化了，这就造成了浪费。获取某个实现类的方式不够灵活，只能通过Iterator形式获取，不能根据某个参数来获取对应的实现类
[*]多个并发多线程使用ServiceLoader类的实例是不安全的
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！
页:
[1]