首页 > 编程语言 >Java SPI 机制浅析

Java SPI 机制浅析

时间:2022-11-25 21:12:56浏览次数:62  
标签:Java 实现 demo 接口 SPI org foo 浅析

本文通过探析 JDK 提供的,在开源项目中比较常用的 Java SPI 机制,希望给大家在实际开发实践、学习开源项目提供参考。

一、SPI 是什么

SPI 全称 Service Provider Interface,是 Java 提供的一套用来被第三方实现或者扩展的 API,它可以用来启用框架扩展和替换组件。整体机制图如下:

image

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、示例代码

(1)步骤一

定义一组接口 (假设是org.foo.demo.IShout),并写出接口的一个或多个实现,(假设是org.foo.demo.animal.Dogorg.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.Dogorg.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

参考

标签:Java,实现,demo,接口,SPI,org,foo,浅析
From: https://www.cnblogs.com/lin546/p/16926350.html

相关文章

  • Java 数组拷贝的几种方式
    目前在Java中数据拷贝提供了如下方式:1、clone2、System.arraycopy3、Arrays.copyOf4、Arrays.copyOfRange。一、clone方法clone方法是从Object类继承过来的,基本数据......
  • Java 序列化工具
    一、Java自带的序列化Java提供了一种对象序列化的机制,该机制中,一个对象可以被表示为一个字节序列,该字节序列包括该对象的数据、有关对象的类型的信息和存储在对象中数据......
  • Java学习六
    一.小结1.使用语法elemenrType[] arrayRefVar(元素类型[]数组引用变量)或elementType  arrayRefVar[](元素类型数组引用变量[])声明一个数组类型的变量。尽管e......
  • JavaScript中String的match方法详解
      String.prototype.match()**String.prototype.match()方法返回通过一个正则表达式匹配到的字符串结果。**varparagraph='Thequickbrownfoxjumpsove......
  • 对Java Web中WEB-INF目录的理解以及访问方法
    事情发生在上个暑假第一次写Javaweb大项目的时候,对于目录管理及分配没有任何经验,就想着清晰明了。后端servlet是用maven进行构建的,所以在目录上没有碰到什么大问题。用......
  • JAVA基础语法
    JAVA基础语法注释、标识符、关键字注释注释类似于笔记,程序是什么意思注释不会被执行书写注释是一个非常好习惯Java中注释分为单行注释,多行注释,文档注释平......
  • Java反射
    反射:框架设计的灵魂,将类的各个组成部分封装为其他对象,这就是反射机制。反射的好处:1.可以在程序运行过程中,操作这些对象2.可以解耦,提高程序的可扩展......
  • Java 中经常被提到的 SPI 到底是什么?
    layout:postcategories:Javatitle:Java中经常被提到的SPI到底是什么?tagline:by子悠tags:-子悠Java程序员在日常工作中经常会听到SPI,而且很多框架都使......
  • java基础语法学习笔记
    java基础语法学习笔记数组定义的三种方法int[]array1={1,2,3,4,5};//定义一int[]array2=newint[10];//定义二int[]array3=newint[]{1,2,3,4,5};/......
  • 第三周课程设计进展——基于java语言的国密算法库编译测试
    本周计划完成的任务本周实际完成情况(代码,文档,程序运行截图...),未完成计划的原因?如何改进?本周遇到的问题与解决过程(要详细)本周计划完成的任务给openeuler配置java......