在java中使用SPI创建可扩展的应用程序操作

 更新时间:2020年09月14日 14:56:32   作者:flydean程序那些事  
这篇文章主要介绍了在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在模块化和非模块化系统中的应用。

本文中的例子:learn-java-base-9-to-20

补充知识: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创建可扩展的应用程序操作就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java工具jsch.jar实现上传下载

    Java工具jsch.jar实现上传下载

    这篇文章主要为大家详细介绍了Java操作ftp的一款工具,利用jsch.jar针对sftp的上传下载工具类,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-12-12
  • IntelliJ IDEA中properties文件显示乱码问题的解决办法

    IntelliJ IDEA中properties文件显示乱码问题的解决办法

    今天小编就为大家分享一篇关于IntelliJ IDEA中properties文件显示乱码问题的解决办法,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-10-10
  • 详解springboot读取yml配置的几种方式

    详解springboot读取yml配置的几种方式

    这篇文章主要介绍了详解springboot读取yml配置的几种方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • Spring Boot实战之模板引擎

    Spring Boot实战之模板引擎

    这篇文章主要介绍了Spring Boot实战之模板引擎,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05
  • Java annotation元注解原理实例解析

    Java annotation元注解原理实例解析

    这篇文章主要介绍了Java annotation元注解原理实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • spring-boot List转Page的方法步骤

    spring-boot List转Page的方法步骤

    这篇文章主要介绍了spring-boot List转Page的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-03-03
  • Spring Boot使用Allatori代码混淆的方法

    Spring Boot使用Allatori代码混淆的方法

    这篇文章主要介绍了Spring Boot使用Allatori代码混淆的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-03-03
  • SpringBoot中maven项目打成war包部署在liunx服务器上的方法

    SpringBoot中maven项目打成war包部署在liunx服务器上的方法

    这篇文章主要介绍了SpringBoot中maven项目打成war包部署在liunx服务器上的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-05-05
  • Mybatis传list参数调用oracle存储过程的解决方法

    Mybatis传list参数调用oracle存储过程的解决方法

    怎么利用MyBatis传List类型参数到数据库存储过程中实现批量插入数据?接下来通过本文给大家介绍Mybatis传list参数调用oracle存储过程,需要的朋友可以参考下
    2017-03-03
  • Dwr3.0纯注解(纯Java Code配置)配置与应用浅析三之后端反向调用前端

    Dwr3.0纯注解(纯Java Code配置)配置与应用浅析三之后端反向调用前

    Dwr是为人所熟知的前端框架,其异步推送功能是为人所津津乐道的,下来主要研究一下它的这个功能是怎么应用的;
    2016-04-04

最新评论