- 本文通过探析JDK提供的,在开源我的项目中比拟罕用的Java SPI机制,心愿给大家在理论开发实际、学习开源我的项目提供参考。
1 SPI是什么
SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩大的API,它能够用来启用框架扩大和替换组件。
整体机制图如下:
Java SPI 实际上是“基于接口的编程+策略模式+配置文件”组合实现的动静加载机制。
零碎设计的各个形象,往往有很多不同的实现计划,在面向的对象的设计里,个别举荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里波及具体的实现类,就违反了可拔插的准则,如果须要替换一种实现,就须要批改代码。为了实现在模块拆卸的时候能不在程序里动静指明,这就须要一种服务发现机制。
Java SPI就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点相似IOC的思维,就是将拆卸的控制权移到程序之外,在模块化设计中这个机制尤其重要。所以SPI的核心思想就是解耦。2 应用场景
概括地说,实用于:调用者依据理论应用须要,启用、扩大、或者替换框架的实现策略
比拟常见的例子:
- 数据库驱动加载接口实现类的加载
JDBC加载不同类型数据库的驱动 - 日志门面接口实现类加载
SLF4J加载不同提供商的日志实现类 - Spring
Spring中大量应用了SPI,比方:对servlet3.0标准对ServletContainerInitializer的实现、主动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)等 - Dubbo
Dubbo中也大量应用SPI的形式实现框架的扩大, 不过它对Java提供的原生SPI做了封装,容许用户扩大实现Filter接口
# 3 应用介绍要应用Java SPI,须要遵循如下约定:- 1、当服务提供者提供了接口的一种具体实现后,在jar包的META-INF/services目录下创立一个以“接口全限定名”为命名的文件,内容为实现类的全限定名;- 2、接口实现类所在的jar包放在主程序的classpath中;- 3、主程序通过java.util.ServiceLoder动静装载实现模块,它通过扫描META-INF/services目录下的配置文件找到实现类的全限定名,把类加载到JVM;- 4、SPI的实现类必须携带一个不带参数的构造方法;## 示例代码**步骤1**、定义一组接口 (假如是org.foo.demo.IShout),并写出接口的一个或多个实现,(假如是org.foo.demo.animal.Dog、org.foo.demo.animal.Cat)。```public interface IShout { void shout();}public class Cat implements IShout { @Override public void shout() { System.out.println("miao miao"); }}public class Dog implements IShout { @Override public void shout() { System.out.println("wang wang"); }}```**步骤2**、在 src/main/resources/ 下建设 /META-INF/services 目录, 新增一个以接口命名的文件 (org.foo.demo.IShout文件),内容是要利用的实现类(这里是org.foo.demo.animal.Dog和org.foo.demo.animal.Cat,每行一个类)。文件地位```- src -main -resources - META-INF - services - org.foo.demo.IShout```文件内容```org.foo.demo.animal.Dogorg.foo.demo.animal.Cat```**步骤3**、应用 ServiceLoader 来加载配置文件中指定的实现。```public class SPIMain { public static void main(String[] args) { ServiceLoader<IShout> shouts = ServiceLoader.load(IShout.class); for (IShout s : shouts) { s.shout(); } }}```代码输入:```wang wangmiao miao```# 4 原理解析首先看ServiceLoader类的签名类的成员变量:```public final class ServiceLoader<S> implements Iterable<S>{private static final String PREFIX = "META-INF/services/"; // 代表被加载的类或者接口 private final Class<S> service; // 用于定位,加载和实例化providers的类加载器 private final ClassLoader loader; // 创立ServiceLoader时采纳的访问控制上下文 private final AccessControlContext acc; // 缓存providers,按实例化的顺序排列 private LinkedHashMap<String,S> providers = new LinkedHashMap<>(); // 懒查找迭代器 private LazyIterator lookupIterator; ......}```参考具体ServiceLoader具体源码,代码量不多,加上正文一共587行,梳理了一下,实现的流程如下:- 1 应用程序调用ServiceLoader.load办法 ServiceLoader.load办法内先创立一个新的ServiceLoader,并实例化该类中的成员变量,包含: - loader(ClassLoader类型,类加载器) - acc(AccessControlContext类型,拜访控制器) - providers(LinkedHashMap<String,S>类型,用于缓存加载胜利的类) - lookupIterator(实现迭代器性能)- 2 应用程序通过迭代器接口获取对象实例 ServiceLoader先判断成员变量providers对象中(LinkedHashMap<String,S>类型)是否有缓存实例对象,如果有缓存,间接返回。 如果没有缓存,执行类的装载,实现如下:- (1) 读取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); }```- (2) 通过反射办法Class.forName()加载类对象,并用instance()办法将类实例化。- (3) 把实例化后的类缓存到providers对象中,(LinkedHashMap<String,S>类型) 而后返回实例对象。# 5 总结**长处**:应用Java SPI机制的劣势是实现解耦,使得第三方服务模块的拆卸管制的逻辑与调用者的业务代码拆散,而不是耦合在一起。应用程序能够依据理论业务状况启用框架扩大或替换框架组件。**毛病**:- 尽管ServiceLoader也算是应用的提早加载,然而根本只能通过遍历全副获取,也就是接口的实现类全副加载并实例化一遍。如果你并不想用某些实现类,它也被加载并实例化了,这就造成了节约。获取某个实现类的形式不够灵便,只能通过Iterator模式获取,不能依据某个参数来获取对应的实现类。- 多个并发多线程应用ServiceLoader类的实例是不平安的。
起源:https://my.oschina.net/1Gk2fd...
欢送关注公众号 【码农开花】一起学习成长
我会始终分享Java干货,也会分享收费的学习材料课程和面试宝典
回复:【计算机】【设计模式】【面试】有惊喜哦