在java中使用SPI创建可扩展的应用程序操作
简介
什么是可扩展的应用程序呢?可扩展的意思是不需要修改原始代码,就可以扩展应用程序的功能。我们将应用程序做成插件或者模块。
这样可以在不修改原应用的基础上,对系统功能进行升级或者定制化。
本文将会向大家介绍如何通过java中的spi机制实现这种可扩展的应用程序。
spi简介
spi的全称是java service provider interface。是java提供的一种服务发现的机制。
通过遵循相应的规则编写应用程序之后,就可以使用serviceloader来加载相应的服务了。
spi的实现主要分为4个部分:
service provider interface: spi是一个interface或者是抽象类,其中定义了我们需要扩展实现的功能。
service providers:这是spi的具体实现,提供了具体的实现功能
spi configuration file:spi的配置文件,通过在配置文件我们来配置相关的spi发现信息。
serviceloader: serviceloader是用来加载和发现服务的java类,并提供了很多有用的方法。
spi的普通java实现
讲完spi的定义,大家可能还是不清楚spi到底是做什么的,又该怎么使用它。
不用急,我们下面通过一个例子来说明。
首先创建一个module:spi-service,里面主要定义了一个moduleservice接口:
public interface moduleservice {
}
然后再分别创建两个module,作为moduleservice的实现:
public class moduleservicea implements moduleservice { public moduleservice getmoduleservice(){ return new moduleservicea(); } }
public class moduleserviceb implements moduleservice { public moduleservice getmoduleservice(){ return new moduleserviceb(); } }
接着分别在两个module中创建meta-inf/services文件夹,并且在里面创建两个以 service provider interface限定名为名字的文件,这里文件名是:com.flydean.base.service.moduleservice,文件里面存放的是spi的具体实现类:
com.flydean.base.servicea.moduleservicea
com.flydean.base.serviceb.moduleserviceb
最后,我们需要创建一个使用spi的类:
public class modulecontroller { public static void main(string[] args) { list<moduleservice> moduleservices = serviceloader .load(moduleservice.class).stream() .map(serviceloader.provider::get) .collect(tolist()); log.info("{}", moduleservices); } }
为了更好的展示扩展应用的实际使用,我们分别创建4个模块。在实际应用中,只需要将这些jar包加入应用程序的classpath即可。
运行看下输出结果:
[com.flydean.base.servicea.moduleservicea@16f65612,
com.flydean.base.serviceb.moduleserviceb@311d617d]
从结果看到,我们获得了两个moduleservice。证明系统扩展成功。
spi在jpms模块化系统下的实现
上面我们讲的是基本的操作,考虑一下,如果是在jdk9之后,引入了jpms模块化系统之后,应该怎么使用spi呢?
代码肯定是一样,我们需要修改的是spi配置文件。
如果在jpms中,我们就不需要使用meta-inf/services了,我们只需要创建相应的module-info.java文件即可。
先看下spi模块的module-info.java文件:
module com.flydean.service { exports com.flydean.service; }
这个模块我们对外暴露了service package,供其他模块调用。
接下来是spi的实现模块:
module com.flydean.servicea { requires com.flydean.service; provides com.flydean.service.moduleservice with com.flydean.servicea.moduleservicea; exports com.flydean.servicea; }
这里我们使用了provides命令,定义了两个类的关联关系。
最后是调用的模块:
module com.flydean.controller { uses com.flydean.service.moduleservice; requires com.flydean.service; requires lombok; requires slf4j.api; }
这里我们使用uses关键词来引用moduleservice。
总结
本文介绍了spi在模块化和非模块化系统中的应用。
本文中的例子:
补充知识:java中spi机制详解
本文通过探析jdk提供的,在开源项目中比较常用的java spi机制,希望给大家在实际开发实践、学习开源项目提供参考。
一、 spi是什么
spi全称service provider interface,是java提供的一套用来被第三方实现或者扩展的api,它可以用来启用框架扩展和替换组件。
整体机制图如下:
java spi 实际上是“基于接口的编程+策略模式+配置文件”组合实现的动态加载机制。
系统设计的各个抽象,往往有很多不同的实现方案,在面向的对象的设计里,一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。
java spi就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点类似ioc的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。所以spi的核心思想就是解耦。
二、使用场景
概括地说,适用于:调用者根据实际使用需要,启用、扩展、或者替换框架的实现策略。
比较常见的例子:
数据库驱动加载接口实现类的加载
jdbc加载不同类型数据库的驱动
日志门面接口实现类加载
slf4j加载不同提供商的日志实现类
spring
spring中大量使用了spi,比如:对servlet3.0规范
对servletcontainerinitializer的实现、自动类型转换type conversion spi(converter spi、formatter spi)等
dubbo
dubbo中也大量使用spi的方式实现框架的扩展, 不过它对java提供的原生spi做了封装,允许用户扩展实现filter接口
三、使用介绍
要使用java spi,需要遵循如下约定:
当服务提供者提供了接口的一种具体实现后,在jar包的meta-inf/services目录下创建一个以“接口全限定名”为命名的文件,内容为实现类的全限定名;
接口实现类所在的jar包放在主程序的classpath中;
主程序通过java.util.serviceloder动态装载实现模块,它通过扫描meta-inf/services目录下的配置文件找到实现类的全限定名,把类加载到jvm;
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.dog
org.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 wang
miao miao
五、原理解析
首先看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>类型)是否有缓存实例对象,如果有缓存,直接返回。如果没有缓存,执行类的装载,实现如下:
读取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); }
通过反射方法class.forname()加载类对象,并用instance()方法将类实例化。
把实例化后的类缓存到providers对象中,(linkedhashmap<string,s>类型),然后返回实例对象。
六、总结
优点:
使用java spi机制的优势是实现解耦,使得第三方服务模块的装配控制的逻辑与调用者的业务代码分离,而不是耦合在一起。应用程序可以根据实际业务情况启用框架扩展或替换框架组件。
缺点:
虽然serviceloader也算是使用的延迟加载,但是基本只能通过遍历全部获取,也就是接口的实现类全部加载并实例化一遍。如果你并不想用某些实现类,它也被加载并实例化了,这就造成了浪费。获取某个实现类的方式不够灵活,只能通过iterator形式获取,不能根据某个参数来获取对应的实现类。
多个并发多线程使用serviceloader类的实例是不安全的。
以上这篇在java中使用spi创建可扩展的应用程序操作就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持。