摘要:SPI(Service Provicer Interface)是Java语言提供的一种接口发现机制,用来实现接口和接口实现的解耦。简单来说,就是系统只需要定义接口规范以及可以发现接口实现的机制,而不需要实现接口。
SPI(Service Provicer Interface)是Java语言提供的一种接口发现机制,用来实现接口和接口实现的解耦。简单来说,就是系统只需要定义接口规范以及可以发现接口实现的机制,而不需要实现接口。
SPI机制在Java中应用广泛。例如:JDBC中的数据库连接驱动使用SPI机制,只定义了数据库连接接口的规范,而具体实现由各大数据库厂商实现,不同数据库的实现不同,我们常用的mysql的驱动也实现了其接口规范,通过这种方式,JDBC数据库连接可以适配不同的数据库。
SPI机制在各种框架中也有应用,例如:springboot的自动装配中查找spring.factories文件的步骤就是应用了SPI机制;dubbo也对Java的SPI机制进行扩展,实现了自己的SPI机制。
我们刚才在介绍中说过了,SPI机制需要定义接口规范,这里我们以一个简单的接口案例来说明。
首先我们需要创建四个工程:
•spi-interface,这里定义SPI的接口类:Person
•spi-impl1,这里定义接口的第一个实现类:Teacher
•spi-impl2,这里定义接口的第二个实现类:Student
•spi-test,这里通过SPI机制加载所有实现类进行测试
接口如下所示:
package com.jd.spi;public interface Person { String favorite;}接口如下所示:
package com.jd.spi;public class Teacher implements Person { public String favorite { return "老师喜欢给学生上课"; }}如下图所示,在项目的resources文件夹下创建两个文件夹META-INF/services,然后在文件夹下面创建名称为com.jd.spi.Person的文件,其文件的内容为当前项目的接口实现类com.jd.spi.Teacher。
接口如下所示:
package com.jd.spi;public class Student implements Person { public String favorite { return "学生喜欢努力学习"; }}如下图所示,在项目的resources文件夹下创建两个文件夹META-INF/services,然后在文件夹下面创建名称为com.jd.spi.Person的文件,其文件的内容为当前项目的接口实现类com.jd.spi.Student。
这里需要引入接口定义项目和两个接口实现项目。
如下所示:
org.example spi-interface 1.0-SNAPSHOT org.example spi-impl1 1.0-SNAPSHOT org.example spi-impl2 1.0-SNAPSHOT如下所示:
package com.jd.spi;import java.util.Iterator;import java.util.ServiceLoader;public class SPITest { public static void main(String args) { ServiceLoader loader = ServiceLoader.load(Person.class); for(Iterator it = loader.iterator; it.hasNext;){ Person person = it.next; System.out.println(person.favorite);; } }}运行测试类,其结果如下所示:
我们发现,Java的SPI机制获取了所有Person类的实现类,并执行其对应的favorite方法。
其核心机制就是ServiceLoader类的load方法,下面我们将从源码来分析其原理。
首先我们先看下ServiceLoader的核心属性:
public final class ServiceLoader implements Iterable{ private static final String PREFIX = "META-INF/services/"; // The class or interface representing the service being loaded private final Class service; // The class loader used to locate, load, and instantiate providers private final ClassLoader loader; // The access control context taken when the ServiceLoader is created private final AccessControlContext acc; // Cached providers, in instantiation order private LinkedHashMap providers = new LinkedHashMap; // The current lazy-lookup iterator private LazyIterator lookupIterator;这个PREFIX属性、providers属性和lookupIterator属性将在后续的代码中使用到,我们发现PREFIX属性就是示例中说的META-INF/services路径。
示例中,我们会获取serviceLoader的遍历器iterator,其方法如下所示:
public Iterator iterator { return new Iterator { Iterator> knownProviders = providers.entrySet.iterator; public boolean hasNext { if (knownProviders.hasNext) return true; return lookupIterator.hasNext; } public S next { if (knownProviders.hasNext) return knownProviders.next.getValue; return lookupIterator.next; } public void remove { throw new UnsupportedOperationException; } }; }然后需要执行遍历器的next方法获取元素,其next方法执行的是lookupIterator.next。
接下来我们来看下lookupIterator的next方法:
public S next { if (acc == null) { return nextService; } else { PrivilegedAction action = new PrivilegedAction { public S run { return nextService; } }; return AccessController.doPrivileged(action, acc); } }其执行的是nextService方法,如下所示:
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 }nextService方法首先执行hasNextService方法,如下所示:
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; }这个方法会执行String fullName = PREFIX + service.getName,而PREFIX就是我们前面刚才说的非常重要的属性,其值为META-INF/services/,service就是接口类,其最终的fullName指的就是META-INF/services文件夹下的名称为com.jd.spi.Person的文件。
接着会执行configs = loader.getResources(fullName)方法,这个方法这里不做详细描述,其主要功能就是获取类路径下所有相对路径为fullName的所有文件的URL对象。
然后会执行pending = parse(service, configs.nextElement)方法,这个方法这里也不详细描述,其主要功能是读取文件,将文件内容变成字符串,然后nextName就被赋值为当前文件的内容,即实现类的接口全限定名。
因此,执行hasNextService方法后,nextName被赋值为一个实现类的全限定名。
我们继续看上面的nextService方法,其最终会执行c = Class.forName(cn, false, loader)方法,这个方法很明显就是通过反射实例化一个对象。通过一系列操作,最终返回了对应实现类的对象。
我们将其总结为以下几个步骤:
1.创建ServiceLoader对象
2.创建迭代器lookupIterator
3.通过迭代器的hasNextService方法读取类路径下META-INF/services目录的所有名称为接口全限定名的文件,将其内容存入configs对象中
4.从configs对象中获取实现类的全限定名,然后通过反射实例化对象
从上述流程,我们也可以总结实现SPI的几点重要信息:
1.实现工程必须在类路径下的META-INF/services目录下创建接口全限定名的文件,其文件内容必须是接口实现类的全限定名
2.实现类必须有一个无参构造方法,因为SPI默认是使用无参构造方法实例化对象的
本文首先概述了Java的SPI机制,随后阐述了其基本使用方法,最后深入探讨了其实现原理。SPI在Java语言体系中具有广泛应用,能够有效地实现系统解耦,众多框架基于此机制进行了拓展和优化,从而实现了更为强大的SPI机制。掌握SPI的使用技巧可以帮助我们设计出更为灵活的系统,而深入理解其原理则有助于提升我们的技术水平。
来源:京东云开发者