文章目录
- 1 SPI机制讲解
- 1.1 引言
- 1.2 Java SPI实现
- 1.2.1 示例说明
- 1.2.2 相关测试
- 1.2.3 源码分析
- 1.3 Spring SPI
- 1.3.1 Spring 示例
- 1.3.2 相关测试类
- 1.3.3 源码分析
1 SPI机制讲解
1.1 引言
SPI(Service Provider Interface)
是JDK
内置的一种服务提供发现机制,可以用来启用框架扩展和替换组件,主要用于框架中开发,例如Dubbo、Spring、Common-Logging,JDBC
等采用采用SPI
机制,针对同一接口采用不同的实现提供给不同的用户,从而提高了框架的扩展性。
1.2 Java SPI实现
Java
内置的SPI
通过java.util.ServiceLoader
类解析classPath
和jar
包的META-INF/services/
目录下的以接口全限定名命名的文件,并加载该文件中指定的接口实现类,以此完成调用。
1.2.1 示例说明
创建动态接口
public interface VedioSPI
{
void call();
}
实现类1
public class Mp3Vedio implements VedioSPI
{
@Override
public void call()
{
System.out.println("this is mp3 call");
}
}
实现类2
public class Mp4Vedio implements VedioSPI
{
@Override
public void call()
{
System.out.println("this is mp4 call");
}
}
在项目的source
目录下新建META-INF/services/
目录下,创建com.skywares.fw.juc.spi.VedioSPI
文件。
1.2.2 相关测试
public class VedioSPITest{
public static void main(String[] args)
{
ServiceLoader<VedioSPI> serviceLoader =ServiceLoader.load(VedioSPI.class);
serviceLoader.forEach(t->{
t.call();
});
}
}
说明:Java
实现spi
是通过ServiceLoader
来查找服务提供的工具类。
运行结果:
this is mp4 call
this is mp3 call
1.2.3 源码分析
上述只是通过简单的示例来实现下java
的内置的SPI
功能。其实现原理是ServiceLoader
是Java
内置的用于查找服务提供接口的工具类,通过调用load()
方法实现对服务提供接口的查找,最后遍历来逐个访问服务提供接口的实现类。
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;
// 类加载器
private final ClassLoader loader;
// The access control context taken when the ServiceLoader is created
private final AccessControlContext acc;
// 按照初始化顺序缓存服务提供接口实例
private LinkedHashMap<String,S> providers = new LinkedHashMap<>();
// 内部类实现了iterator接口
private LazyIterator lookupIterator;
}
从源码可以发现:
ServiceLoader
类本身实现了Iterable
接口并实现了其中的iterator
方法,iterator
方法的实现中调用了LazyIterator
这个内部类中的方法,迭代器创建实例。- 所有服务提供接口的对应文件都是放置在
META-INF/services/
目录下,final
类型决定了PREFIX
目录不可变更。
虽然java
提供的SPI
机制的思想非常好,但是也存在相应的弊端。具体如下:
Java
内置的方法方式只能通过遍历来获取- 服务提供接口必须放到
META-INF/services/
目录下。
针对java
的spi
存在的问题,Spring
的SPI
机制沿用的SPI
的思想,但对其进行扩展和优化
1.3 Spring SPI
Spring SPI
沿用了Java SPI
的设计思想,Spring
采用的是spring.factories
方式实现SPI
机制,可以在不修改Spring
源码的前提下,提供Spring
框架的扩展性。
1.3.1 Spring 示例
定义接口
public interface DataBaseSPI
{
void getConnection();
}
相关实现
##DB2实现
public class DB2DataBase implements DataBaseSPI
{
@Override
public void getConnection()
{
System.out.println("this database is db2");
}
}
##Mysql实现
public class MysqlDataBase implements DataBaseSPI
{
@Override
public void getConnection()
{
System.out.println("this is mysql database");
}
}
1、在项目的META-INF
目录下,新增spring.factories
文件
2、填写相关的接口信息,内容如下:
com.skywares.fw.juc.springspi.DataBaseSPI = com.skywares.fw.juc.springspi.DB2DataBase, com.skywares.fw.juc.springspi.MysqlDataBase
说明多个实现采用逗号分隔
1.3.2 相关测试类
public class SpringSPITest
{
public static void main(String[] args)
{
List<DataBaseSPI> dataBaseSPIs =SpringFactoriesLoader.loadFactories(DataBaseSPI.class,
Thread.currentThread().getContextClassLoader());
for(DataBaseSPI datBaseSPI:dataBaseSPIs){
datBaseSPI.getConnection();
}
}
}
输出结果
this database is db2
this is mysql database
从示例中我们看出,Spring
采用spring.factories
实现SPI
与java
实现SPI
非常相似,但是spring
的spi
方式针对java
的spi
进行的相关优化具体内容如下:
Java SPI
是一个服务提供接口对应一个配置文件,配置文件中存放当前接口的所有实现类,多个服务提供接口对应多个配置文件,所有配置都在services
目录下;Spring factories SPI
是一个spring.factories
配置文件存放多个接口及对应的实现类,以接口全限定名作为key
,实现类作为value
来配置,多个实现类用逗号
隔开,仅spring.factories
一个配置文件。
那么spring
是如何通过加载spring.factories
来实现SpI
的呢?我们可以通过源码来进一步分析。
1.3.3 源码分析
说明:loadFactoryNames
解析spring.factories
文件中指定接口的实现类的全限定名,具体实现如下:
说明:获取所有jar
包中META-INF/spring.factories
文件路径,以枚举值返回。遍历spring.factories
文件路径,逐个加载解析,整合factoryClass
类型的实现类名称,获取到实现类的全类名称后进行类的实例话操作,其相关源码如下:
说明:实例化是通过反射来实现对应的初始化。