SPI简介
SPI,Service Provider Interface,主要是被框架的开发人员使用,比如java.sql.Driver
接口,其他不同厂商可以针对同一接口做出不同的实现,mysql和postgresql都有不同的实现提供给用户,而Java的SPI机制可以为某个接口寻找服务实现。
当服务的提供者提供了一种接口的实现之后,需要在classpath下的META-INF/services/目录里创建一个以服务接口命名的文件,这个文件里的内容就是这个接口的具体的实现类。当其他的程序需要这个服务的时候,就可以通过查找这个jar包(一般都是以jar包做依赖)的META-INF/services/中的配置文件,配置文件中有接口的具体实现类名,可以根据这个类名进行加载实例化,就可以使用该服务了。JDK中查找服务的实现的工具类是:java.util.ServiceLoader
。
SPI可以认为是一个规范,按照此规范实施,就能被服务正确识别自定义的功能。
Dubbo,
如何使用SPI
使用SPI的大致流程如下:
- 有关组织或者公司定义标准。
- 具体厂商或者框架开发者实现。
- 程序猿使用。
详细来讲,就是:
标准制定者的工作:
- 使用
ServiceLoader.load(Class class);
动态加载Service接口的实现类。
具体实施者的工作:
- 在META-INF/services/目录中创建以Service接口全限定名命名的文件,该文件内容为Service接口具体实现类的全限定名,文件编码必须为UTF-8。
- 如SPI的实现类为jar,则需要将其放在当前程序的classpath下。
- Service的具体实现类必须有一个不带参数的构造方法。
应用举例
这里以JDBC为例
在JDBC4.0之前,我们开发有连接数据库的时候,通常会用Class.forName("com.mysql.jdbc.Driver")
这句先加载数据库相关的驱动,然后再进行获取连接等的操作。而JDBC4.0之后不需要用Class.forName("com.mysql.jdbc.Driver")
来加载驱动,直接使用DriverManager.getConnection(String url)
就可以了。
注:
在以前,操作数据库的时候,需要先加载驱动。不同的数据库需要不同的驱动。如:
- mysql -
Class.forName("com.mysql.jdbc.Driver").newInstance()
- oracle -
Class.forName("oracle.jdbc.driver.OracleDriver").newInstance()
- sql server -
Class.forName("com.microsoft.jdbc.sqlserver.SQLServerDriver").newInstance()
- postgreSQL -
Class.forNaem("org.postgresql.Driver").newInstance()
- db2 -
Class.froName("com.ibm.db2.jdbc.app.DB2Driver").newInstance()
如果要更改数据库,就需要更改驱动,也就是说要修改代码。修改代码是个很麻烦的工作。使用SPI可以使我们无需修改代码就可以更换数据库。
通过SPI是如何实现的呢?
1. 组织方制定接口
这里的组织方是JDK组织。JDK中有定义驱动接口Driver
:
public interface Driver{
//接口方法略。。。
}
2. 实现方根据SPI规范实现接口
这里的实现方是各数据库厂商
msyql
对于MySQL,在mysql-connector-java.jar下,有META-INF/services目录,该目录下有SPI需要的文件java.sql.Driver
:
文件内容为:
com.mysql.jdbc.Driver
com.mysql.fabric.jdbc.FabricMySQLDriver
postgreSQL
同理,对于postgreSQL,在postgresql.jar中,META-INF/services目录下也有名为java.sql.Driver
的文件:
文件内容为:
org.postgresql.Driver
其他数据库与之类似。具体接口实现略过。
3. 组织方加载实现类
各个数据库驱动的加载是在JDK的DriverManager
类中实现的。该类中有如下一段静态代码,会在类初始化的时候执行:
class DriverManager{
static {
loadInitialDrivers();
println("JDBC DriverManager initialized");
}
}
loadInitialDrivers()
函数的内容为:
private static void loadInitialDrivers() {
String drivers;
try {
drivers = AccessController.doPrivileged(new PrivilegedAction<String>() {
public String run() {
return System.getProperty("jdbc.drivers");
}
});
} catch (Exception ex) {
drivers = null;
}
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
Iterator<Driver> driversIterator = loadedDrivers.iterator();
try{
while(driversIterator.hasNext()) {
driversIterator.next();
}
} catch(Throwable t) {
// Do nothing
}
return null;
}
});
//下面代码略。。。
}
这段代码中,ServiceLoader.load()
会查找classpath以及jar包中,META-INF/services目录下的所有java.sql.Driver
的实现类,并实例化。
使用SPI的第一步操作如下。这里没有去META-INF/services目录下查找配置文件,也没有加载具体实现类,做的事情就是封装了我们的接口类型和类加载器,并初始化了一个迭代器。
ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
第二步操作为:遍历使用SPI获取到的具体实现,实例化各个实现类
//获取迭代器
Iterator<Driver> driversIterator = loadedDrivers.iterator();
//遍历所有的驱动实现
while(driversIterator.hasNext()) {
driversIterator.next();
}
在遍历的时候,首先调用driversIterator.hasNext()
方法,这里会搜索classpath下以及jar包中所有的META-INF/services目录下的java.sql.Driver
文件,并找到文件中的实现类的名字,此时并没有实例化具体的实现类。
第三步为:实例化各个驱动。关键代码为:
driversIterator.next();
到此为止,classpath下的所有数据库驱动都被加载并实例化了。
在测试项目中添加了两个jar包,mysql-connector-java-6.0.6.jar和postgresql-42.0.0.0.jar,跟踪到DriverManager中之后:
image.png
可以看到此时迭代器中有两个驱动,mysql和postgresql的都被加载了。有关两个驱动都加载了,具体使用哪个驱动,请自行深入jdbc的源码。这里不做过多解析。
谁使用了SPI
有很多的SPI扩展机制应用的实例,比如大名鼎鼎的slf4j, common-logging, JDBC, tomcat等等
SPI的思想
SPI重要的不是其原理,而是其思想。
Dubbo就借鉴了SPI的思想,实现了自动扩展。详情可参考下面这篇文章。
Dubbo中SPI扩展机制详解
网友评论