最近学习了JDK SPI

JDK SPI是什么

最近工作中听几个同事说了好几次SPI这个名词,虽然和我没关系,但是心里默默想还是学习一下,不然下次和我说到SPI,连是什么都不知道那就尴尬了。

所以SPI是什么呢?SPI全称Service Provider Interface,在Java中还是一个比较重要的概念,是Java提供的一套用来被第三方实现或者扩展的API,或者换句话说,SPI是一种服务发现机制

JDK SPI使用说明及示例

要使用SPI比较简单,只需要按照以下几个步骤操作即可:

  • 在jar包的META-INF/services目录下创建一个以"接口全限定名"为命名的文件,内容为实现类的全限定名
  • 接口实现类所在的jar包在classpath下
  • 主程序通过java.util.ServiceLoader动态状态实现模块,它通过扫描META-INF/services目录下的配置文件找到实现类的全限定名,把类加载到JVM
  • SPI的实现类必须带一个无参构造方法

接着我们看一下具体例子,首先定义一个SpiService,它是一个接口:

package org.xrq.test.spi;

public interface SpiService {

    public void hello();

}

两个实现类,分别为SpiServiceA与SpiServiceB:

package org.xrq.test.spi;

public class SpiServiceA implements SpiService {

    public void hello() {
        System.out.println("SpiServiceA.Hello");
    }

}
package org.xrq.test.spi;

public class SpiServiceB implements SpiService {

    @Override
    public void hello() {
        System.out.println("SpiServiceB.hello");
    }

}

接着我们建一个META-INF/services的文件夹,里面建一个file,file的名字是接口的全限定名org.xrq.test.spi.SpiService:

文件的内容是SpiService实现类SpiServiceA、SpiServiceB的全限定名:

org.xrq.test.spi.SpiServiceA
org.xrq.test.spi.SpiServiceB

这样就大功告成了!然后我们写个测试类自动加载一下这两个类:

public class SpiTest {

    @Test
    public void testSpi() {
        ServiceLoader<SpiService> serviceLoader = ServiceLoader.load(SpiService.class);

        Iterator<SpiService> iterator = serviceLoader.iterator();
        while (iterator.hasNext()) {
            SpiService spiService = iterator.next();

            spiService.hello();
        }
    }

}

结果一目了然,调用了hello()方法:

SpiServiceA.Hello
SpiServiceB.hello

这就是SPI的使用示例,接着我们看一下SPI在实际场景中的应用。

SPI在JDBC中的应用

回看快四年前的文章https://www.cnblogs.com/xrq730/p/4851944.html,这篇名为《JDBC学习2:为什么要写Class.forName("XXX")?》的文章里面当时技术真的是稚嫩,为什么不写Class.forName("XXX")的解释现在看来真的是弱爆了,最后一楼网友的回复"不用写的原因是,新版本JDBC使用了SPI",所以学了一下SPI马上就想起这个例子来了,因此就由JDBC讲讲SPI的实际应用。

在老版本的JDBC中,假设我们使用的是MySql,初始化JDBC的时候是需要显式调用Class.forName("com.mysql.jdbc.Driver")这一句的,但是在某个版本之后就不需要做这一步操作了,如上所说这是通过SPI实现的,怎么理解呢。Class.forName其实没有实际意义,其实既不会new对象也不会反射生成对象,它只是为了调用com.mysql.jdbc.Driver的static方法块而已:

public class Driver extends NonRegisteringDriver implements java.sql.Driver {
    //
    // Register ourselves with the DriverManager
    //
    static {
        try {
            java.sql.DriverManager.registerDriver(new Driver());
        } catch (SQLException E) {
            throw new RuntimeException("Can‘t register driver!");
        }
    }

    /**
     * Construct a new driver and register it with DriverManager
     *
     * @throws SQLException
     *             if a database error occurs.
     */
    public Driver() throws SQLException {
        // Required for Class.forName().newInstance()
    }
}

方法块的作用只有一个,通过jdk自带的DriverManager注册Driver,registerDrivers方法没什么套路,把Driver放到CopyOnArrayList里面而已:

public static synchronized void registerDriver(java.sql.Driver driver, DriverAction da)
      throws SQLException {

    /* Register the driver if it has not already been added to our list */
    if(driver != null) {
        registeredDrivers.addIfAbsent(new DriverInfo(driver, da));
    } else {
        // This is for compatibility with the original DriverManager
        throw new NullPointerException();
    }

    println("registerDriver: " + driver);

}

从某个JDK版本,具体也不知道哪个版本,废弃了这个操作,看下新版的DriverManager,我的是JDK1.8的:

/**
 * Load the initial JDBC drivers by checking the System property
 * jdbc.properties and then use the {@code ServiceLoader} mechanism
 */
static {
    loadInitialDrivers();
    println("JDBC DriverManager initialized");
}

直接看一下loadInitialDrivers这个方法的核心部分:

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;
    }
});

看到使用SPI的方式从META-INF/services下去找java.sql.Driver这个文件,并找到里面的Driver实现类逐一注入。最后我们看一下Iterator的next()方法做了什么就完全懂了,通过next()方法调用了:

private S nextService() {
    if (!hasNextService())
        throw new NoSuchElementException();
    String cn = nextName;
    nextName = null;
    Class<?> c = null;
    try {
        c = Class.forName(cn, false, loader);
    } catch (ClassNotFoundException x) {
        fail(service,
             "Provider " + cn + " not found");
   }
    if (!service.isAssignableFrom(c)) {
       fail(service,
             "Provider " + cn  + " not a subtype");
    }
    try {
        S p = service.cast(c.newInstance());
        providers.put(cn, p);
        return p;
    } catch (Throwable x) {
        fail(service,
             "Provider " + cn + " could not be instantiated",
            x);
    }
    throw new Error();          // This cannot happen
}
            

看到Class.forName了吧,虽然都是Class.forName,但是通过SPI的方式把用户手动做的动作变成框架做。

对SPI的理解

最后谈一谈我对SPI的理解,学习了怎么用SPI、SPI在实际应用中的示例之后,深刻理解SPI机制才能在以后工作中真正将SPI为我所用。

首先大家可以注意到,标题是JDK SPI,也就是说SPI并不是JDK专属的。是的,我理解的SPI其实是一种可插拔技术的总称,最简单的例子就是USB,厂商提供了USB的标准,厂家根据USB的标准制造自己的外设,例如鼠标、键盘、游戏手柄等等,但是USB标准具体在电脑中是怎么用的,厂家就不需要管了。

回到我们的代码中也是一样的道理。当我们开发一个框架的时候,除了保证基本的功能外,最重要的一个点是什么?我认为最重要的应该是松耦合,即扩展开放、对修改关闭,保证框架实现对于使用者来说是黑盒。

框架不可能做好所有的事情,只能把共性的部分抽离出来进行流程化,松耦合实现的核心就是定义好足够松散的接口,或者可以理解是扩展点,具体的扩展点让使用者去实现,这样不同的扩展就不需要修改源代码或者对框架进行定制,这就是面向接口编程的好处。

回到我们框架的部分来说:

  • JDK对于SPI的实现是通过META-INF/services这个目录 + ServiceLoader
  • Spring实现SPI的方式是留了N多的接口,例如BeanPostProcessor、InitializingBean、DisposableBean,我们只需要实现这些接口然后注入即可

对已有框架而言,我们可以通过框架给我们提供的扩展点扩展框架功能。对自己写框架而言,记得SPI这个事情,留好足够的扩展点,这将大大加强你写的框架的扩展性。

原文地址:https://www.cnblogs.com/xrq730/p/11440174.html

时间: 2024-10-23 00:20:35

最近学习了JDK SPI的相关文章

观察者模式学习--使用jdk的工具类简单实现

观察者模式学习之二:使用jdk的自带的工具类实现,与自己实现相比,两者有以下的区别: 1,自己实现,需要定义观察者的接口类和目标对象的接口类.使用java util的工具类,则不需要自己定义观察者和目标对象的接口类了,jdk已经定义好了. 2,自己实现,具体的目标对象类中,实现了接口方法后,还必须要自己实现维护观察者的注册删除信息.但是使用jdk,则不需要了,在 jdk的util下的observable类里面已经帮忙维护好了. 3,目标对象触发观察者的update的通知方式有了变化,自己的实现,

AOP学习心得&amp;jdk动态代理与cglib比较

什么是AOP AOP(Aspect-OrientedProgramming,面向方面编程),可以说是OOP(Object-Oriented Programing,面向对象编程)的补充和完善.OOP引入封装.继承和多态性等概念来建立一种对象层次结构,用以模拟公共行为的一个集合.当我们需要为分散的对象引入公共行为的时候,OOP则显得无能为力.也就是说,OOP允许你定义从上到下的关系,但并不适合定义从左到右的关系.例如日志功能.日志代码往往水平地散布在所有对象层次中,而与它所散布到的对象的核心功能毫无

linux学习(JDK,Tomcat,nginx反向代理)

最近学习了在linux,在上面搭建了一个tomcat的服务器,后来又使用nginx进行反向代理了一下下,希望文章对初学者有所帮助. 1.安装JDK.(采用jdk的rpm包进行安装) 安装jdk之前需要去将jdk的包下载下来,然后将jdk的包复制到linux系统中,如果你的linux系统可以上网的话,可以直接在官网上下载,关于虚拟机访问本机网络的内容,我们在本章博客最后说明一下.还有就是vmware tools的工具安装.   1.将jdk-8u144-linux-x64.rpm包放在linux系

[java学习笔记]JDK的安装和环境变量的配置

1.JDK的下载和安装 jdk(java development kit)是java提供给我们的一套java开发工具,它必运行在JVM(java虚拟机)上,java语言的跨平台性就是利用java运行在JVM的不同平台版本实现的.比如JVM有linux版,windows版和mac版,我们写好的java程序不用修改就能运行在这三个不同的操作系统上,就是依靠这些平台对应的JVM. JDK的下载 java目前的最新版本是JDK-8u60,点击此链接下载java8.0,上面和下面的区别在于下面有api的使

【java学习】JDK、JRE、JVM的关系

目录结构: contents structure [-] 什么是JDK,JRE,JVM 安装JDK的时候为什么有两个jre 专用JRE 共用JRE 共用JRE和专用JRE的对比 java的跨平台特性 JDK各个文件的作用 参考文章 1,什么是JDK,JRE,JVM. JDK:java development toolskit,包含java开发工具和jre. JRE:java runtime enviroment,包含java运行环境和jvm. JVM:java virtual machine,j

stm32寄存器版学习笔记10 SPI

SPI(Serial Peripheral Interface),串行外围设备接口.SPI是一种高速的.全双工.同步的通信总线. SPI接口一般使用4条线通信: MISO 主设备数据输入,从设备数据输出 MOSI 主设备数据输出,从设备数据输入 SCLK 时钟信号,有主设备产生 CS 从设备片选信号,有主设备控制 SPI模块为了和外设进行数据交换,根据外设工作要求,其输出串行同步时钟极性和相位可以进行配置.SPI_CR寄存器的CPOL(时钟极性)位,控制在没有数据传输时时钟的空闲状态电平,此位对

Java学习1——JDK(学前准备)

一.下载: 可以在http://www.oracle.com/technetwork/java/javase/downloads/index.html下载并安装Java SE(JDK) java大致版本区别如下: Java SE(Java Platform,Standard Edition) 它允许开发和部署在桌面.服务器.嵌入式环境和实时环境中使用的 Java 应用程序.Java SE 包含了支持 Java Web 服务开发的类,并为 Java Platform,Enterprise Edit

CentOS学习笔记--JDK安装

JDK安装 大部分的服务都离不开JAVA环境,CentOS里都是OpenJDK,显然我们还是使用JAVA的JDK好.(注:minimal版没有安装OpenJDK,其它版本需要删除这个.) JDK下载 从http://www.oracle.com/technetwork/java/javase/downloads/index.html下载JDK的tar.gz版本. 利用SSH上传到/opt下. 安装 # cd /opt # tar xzvf *.tar.gz # mv *.tar.gz jdk <

Java学习2 - JDK和JRE和JVM的区别_JDK的下载安装_环境变量配置

一 JDK和JRE和JVM的区别 Jdk: Java Development kit - Java 开发工具 JRE: Java Runtime Environment - java运行环境 JVM: Java Virtual Machine - Java 虚拟机 关系:Jdk包含JRE,JRE包含JVM 二 Java 开发环境配置 1.下载JDK: www.oracle.com(download->Java(右侧)->Java SE (includes JavaFX) | Early Acc