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。
这里需要引入接口定义项目和两个接口实现项目。
如下所示:
<dependencies>
<dependency>
<groupId>org.example</groupId>
<artifactId>spi-interface</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.example</groupId>
<artifactId>spi-impl1</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.example</groupId>
<artifactId>spi-impl2</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>
如下所示:
package com.jd.spi;
import java.util.Iterator;
import java.util.ServiceLoader
;
public class SPITest {
public static void main(String[] args) {
ServiceLoader<Person> loader = ServiceLoader.load(Person.class);
for(Iterator<Person> 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<S>
implements Iterable<S>
{
private static final String PREFIX = "META-INF/services/";
// The class or interface representing the service being loaded
private final Class<S> 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<String,S> providers = new LinkedHashMap<>();
// The current lazy-lookup iterator
private LazyIterator lookupIterator;
这个PREFIX属性、providers属性和lookupIterator属性将在后续的代码中使用到,我们发现PREFIX属性就是示例中说的META-INF/services路径。
示例中,我们会获取serviceLoader的遍历器iterator,其方法如下所示:
public Iterator<S> iterator() {
return new Iterator<S>() {
Iterator<Map.Entry<String,S>> 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<S> action = new PrivilegedAction<S>() {
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
方法,如下所示:
本文系作者在时代Java发表,未经许可,不得转载。
如有侵权,请联系nowjava@qq.com删除。