Java中SPI机制的实现详解

 更新时间:2024年01月29日 10:31:53   作者:学而不思则忘  
SPI(Service Provider Interface),是 JDK 内置的一种服务提供发现机制,可以用来启用框架扩展和替换组件,下面我们就来看看Java中SPI机制的具体实现

简介

SPI(Service Provider Interface),是 JDK 内置的一种服务提供发现机制,可以用来启用框架扩展和替换组件,核心思想是解耦。比如java.sql.Driver接口,其他不同厂商可以针对同一接口做出不同的实现,MySQL 和 PostgreSQL 都有不同的实现提供给用户。

当服务提供者提供了一种接口的实现后,需要在 classpath 下的 META-INF/services/ 目录下创建一个以服务接口命名的文件,文件的内容就是接口的具体实现类。

当使用该服务时,扫描 META-INF/services/ 下配置文件,就可以加载类使用该服务。JDK 中查找服务的工具类是:java.util.ServiceLoader

以 MySQL 驱动为例:

源码实现

以上面连接数据库作为示例,看看 java8 SPI 怎么实现的。

入口在 java.sql.DriverManager 类中:

    static {
        loadInitialDrivers();
        println("JDBC DriverManager initialized");
    }

    private static void loadInitialDrivers() {
        String drivers;
        try {
            drivers = AccessController.doPrivileged(new PrivilegedAction<String>() {
                public String run() {
                    return System.getProperty("jdbc.drivers");
                }
            });
        } catch (Exception ex) {
            drivers = null;
        }
        // If the driver is packaged as a Service Provider, load it.
        // Get all the drivers through the classloader
        // exposed as a java.sql.Driver.class service.
        // ServiceLoader.load() replaces the sun.misc.Providers()

        AccessController.doPrivileged(new PrivilegedAction<Void>() {
            public Void run() {

                ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
                Iterator<Driver> driversIterator = loadedDrivers.iterator();

                /* Load these drivers, so that they can be instantiated.
                 * It may be the case that the driver class may not be there
                 * i.e. there may be a packaged driver with the service class
                 * as implementation of java.sql.Driver but the actual class
                 * may be missing. In that case a java.util.ServiceConfigurationError
                 * will be thrown at runtime by the VM trying to locate
                 * and load the service.
                 *
                 * Adding a try catch block to catch those runtime errors
                 * if driver not available in classpath but it's
                 * packaged as service and that service is there in classpath.
                 */
                try{
                    while(driversIterator.hasNext()) {
                        driversIterator.next();
                    }
                } catch(Throwable t) {
                // Do nothing
                }
                return null;
            }
        });

        println("DriverManager.initialize: jdbc.drivers = " + drivers);

        if (drivers == null || drivers.equals("")) {
            return;
        }
        String[] driversList = drivers.split(":");
        println("number of Drivers:" + driversList.length);
        for (String aDriver : driversList) {
            try {
                println("DriverManager.Initialize: loading " + aDriver);
                Class.forName(aDriver, true,
                        ClassLoader.getSystemClassLoader());
            } catch (Exception ex) {
                println("DriverManager.Initialize: load failed: " + ex);
            }
        }
    }

上面的代码主要步骤是:

  • 从系统变量中获取有关驱动的定义。
  • 使用 SPI 来获取驱动的实现。
  • 遍历使用 SPI 获取到的具体实现,实例化各个实现类。
  • 根据第一步获取到的驱动列表来实例化具体实现类。

主要关注第2,3步,第 2 步使用 SPI 获取驱动的实现,对应实现:

ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);

这里没有去 META-INF/services 目录下查找配置文件,也没有加载具体实现类,只是封装了接口类型和类加载器,并初始化了一个迭代器。

接着看第三步,遍历使用 SPI 获取到的具体实现,实例化各个实现类,对应的代码如下:

// 获取迭代器
Iterator<Driver> driversIterator = loadedDrivers.iterator();
// 遍历所有的驱动实现
while(driversIterator.hasNext()) {
    driversIterator.next();
}

在遍历的时候,首先调用driversIterator.hasNext()方法,这里会搜索 classpath 下以及jar包中所有的META-INF/services目录下的java.sql.Driver文件,并找到文件中的实现类的名字,此时并没有实例化具体的实现类。

然后是调用driversIterator.next();方法,此时就会根据驱动名字具体实例化各个实现类了。具体的扫描加载源码见java.util.ServiceLoader 方法。

以上就是Java中SPI机制的实现详解的详细内容,更多关于Java SPI机制的资料请关注脚本之家其它相关文章!

相关文章

  • Java反射机制详解

    Java反射机制详解

    这篇文章主要介绍了Java反射机制,首先简单介绍了反射机制的预备知识,进一步分析了Java反射机制的原理、实现技巧与应用方法,需要的朋友可以参考下
    2015-12-12
  • Maven Plugin的@Mojo和@Execute的具体使用

    Maven Plugin的@Mojo和@Execute的具体使用

    本文主要介绍了Maven Plugin的@Mojo和@Execute的具体使用,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • SpringBoot配置 Druid 三种方式(包括纯配置文件配置)

    SpringBoot配置 Druid 三种方式(包括纯配置文件配置)

    本文给大家分享在项目中用纯 YML(application.yml 或者 application.properties)文件、Java 代码配置 Bean 和注解三种方式配置 Alibaba Druid 用于监控或者查看 SQL 状况的相关知识,感兴趣的朋友一起看看吧
    2021-10-10
  • Java内部排序之插入排序与交换排序详解

    Java内部排序之插入排序与交换排序详解

    这篇文章主要介绍了Java内部排序之插入排序与交换排序详解,排序是将任意序列重新排列按照关键字有序,排序根基存储器的不同分为内部排序、外部排序,排序根据关键字分为稳定排序、不稳定排序,需要的朋友可以参考下
    2023-12-12
  • Spring Boot 如何解决富文本上传图片跨域问题

    Spring Boot 如何解决富文本上传图片跨域问题

    这篇文章主要介绍了Spring Boot 如何解决富文本上传图片跨域问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • SpringMVC 请求参数绑定的核心场景与解决方案

    SpringMVC 请求参数绑定的核心场景与解决方案

    本文介绍了SpringMVC请求参数绑定的实现方式,包括基本类型、JavaBean、集合、自定义转换器和原生ServletAPI等6大核心场景,重点讲解了每个场景的绑定机制和核心要求,并提供了完整的示例代码,此外,还特别强调了中文乱码的解决方法和一些注意事项,感兴趣的朋友一起看看吧
    2025-11-11
  • 教你构建第一个Java Applet程序

    教你构建第一个Java Applet程序

    本文的主要目的是创建一个简单的Java applet,需要的朋友可以参考下
    2014-10-10
  • JAVA IDEA 打开assert 设置方式

    JAVA IDEA 打开assert 设置方式

    这篇文章主要介绍了JAVA IDEA 打开assert 设置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11
  • Java加载本地库的方法之System.load与System.loadLibrary

    Java加载本地库的方法之System.load与System.loadLibrary

    最近在做的工作要用到本地方法,所以下面这篇文章主要介绍了Java加载本地库的方法之System.load与System.loadLibrary的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-09-09
  • SpringBoot Web开发之系统任务启动与路径映射和框架整合

    SpringBoot Web开发之系统任务启动与路径映射和框架整合

    这篇文章主要介绍了SpringBoot Web开发中的系统任务启动与路径映射和Servlet、Filter、Listener框架整合,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08

最新评论