从源码全面解析 Java SPI 的来龙去脉

2023-07-05 23:58:56
  • 👏作者简介：大家好，我是爱敲代码的小黄，独角兽企业的Java开发工程师，CSDN博客专家，阿里云专家博主
  • 📕系列专栏：Java设计模式、Spring源码系列、Netty源码系列、Kafka源码系列、JUC源码系列、duubo源码系列
  • 🔥如果感觉博主的文章还不错的话，请👍三连支持👍一下博主哦
  • 🍂博主正在努力完成2023计划中：以梦为马，扬帆起航，2023追梦人
  • 📝联系方式：hls1793929520，加我进群，大家一起学习，一起进步，一起对抗互联网寒冬👀

在这里插入图片描述

文章目录

从源码全面解析 Java SPI 的来龙去脉

一、引言

对于 Java 开发者而言，关于 dubbo ，我们一般当做黑盒来进行使用，不需要去打开这个黑盒。

但随着目前程序员行业的发展，我们有必要打开这个黑盒，去探索其中的奥妙。

本期 dubbo 源码解析系列文章，将带你领略 dubbo 源码的奥秘

本期源码文章吸收了之前 Spring、Kakfa、JUC源码文章的教训，将不再一行一行的带大家分析源码，我们将一些不重要的部分当做黑盒处理，以便我们更快、更有效的阅读源码。

虽然现在是互联网寒冬，但乾坤未定，你我皆是黑马！

废话不多说，发车！

二、SPI是什么

SPI 全称 Service Provider Interface ，是 Java 提供的一套用来被第三方实现或者扩展的 API，它可以用来启用框架扩展和替换组件。

img

Java SPI 实际上是 基于接口的编程＋策略模式＋配置文件 组合实现的动态加载机制。

Java SPI 就是提供这样的一个机制：为某个接口寻找服务实现的机制。

将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要。

所以 SPI 的核心思想就是解耦。

三、使用介绍

我们定义一个接口 Phone：

package com.study.spring.spi;
public interface Phone {
    public void getName();
}

实现其三个类：

  • HuaWei
package com.study.spring.spi;

public class HuaWei implements Phone {
    @Override
    public void getName() {
        System.out.println("我是是华为手机");
    }
}
  • IPhone
package com.study.spring.spi;

public class IPhone implements Phone {
    @Override
    public void getName() {
        System.out.println("我是是苹果手机");
    }
}
  • XiaoMi
package com.study.spring.spi;

public class XiaoMi implements Phone {
    @Override
    public void getName() {
        System.out.println("我是是小米手机");
    }
}

重点来了：我们要在 resources 文件夹下面建立一个路径：META-INF/services

然后我们建立一个 txt 名为：com.study.spring.spi.Phone，如下：

image-20230704221922760

我们在这个文件中写上各实现类的路径：

com.study.spring.spi.HuaWei
com.study.spring.spi.IPhone
com.study.spring.spi.XiaoMi

测试类：

package com.study.spring.spi;

import java.util.Iterator;
import java.util.ServiceLoader;

public class JavaSPITest {
    public static void main(String[] args) {
        // 执行Java SPI的规范
        ServiceLoader<Phone> phoneServiceLoader = ServiceLoader.load(Phone.class);
		// 获取迭代器
        Iterator<Phone> it = phoneServiceLoader.iterator();
        // 迭代遍历，输出集合中的所有元素
        while (it.hasNext()) {
            System.out.println(it.next());
        }
    }
}

结果：

我是是华为手机
我是是苹果手机
我是是小米手机

从这里我们可以看到，通过 SPI 的机制，我们可以获取当前接口类的实现

四、生产场景

相信大家在生产上都使用过 JDBC，没错，我们的 JDBC 实际上也使用了 SPI

我们看 DriverManager 的静态方法 loadInitialDrivers：

 static {
     // 初始化加载
     loadInitialDrivers();
     println("JDBC DriverManager initialized");
}

我们查看下 loadInitialDrivers 方法的代码：

private static void loadInitialDrivers() {
    String drivers;
    AccessController.doPrivileged(new PrivilegedAction<Void>() {
        public Void run() {
            // SPI的加载机制
            ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
            // 迭代
            Iterator<Driver> driversIterator = loadedDrivers.iterator();
            try{
                while(driversIterator.hasNext()) {
                    driversIterator.next();
                }
            }
            return null;
        }
    });   
}

当然，这里我们需要引入下面的 MAVEN 依赖，不然 Driver.class 的实现类为空

 <dependency>
     <groupId>mysql</groupId>
     <artifactId>mysql-connector-java</artifactId>
     <version>8.0.18</version>
</dependency>

测试类：

package com.study.spring.spi;

import java.sql.Driver;
import java.util.Iterator;
import java.util.ServiceLoader;

public class JDBCTest {
    public static void main(String[] args) {
        ServiceLoader<Driver> serviceLoader = ServiceLoader.load(Driver.class);

        for (Iterator<Driver> iterator = serviceLoader.iterator(); iterator.hasNext(); ) {

            Driver driver = iterator.next();

            System.out.println(driver.getClass().getPackage() + " ------> " + driver.getClass().getName());
        }
    }
}

启动：

package com.mysql.cj.jdbc, JDBC, version 4.2 ------> com.mysql.cj.jdbc.Driver

从这里的输出我们可以得出一个假设：我们引入的 JDBC 包里面，存在上述 SPI 机制的 txt 文件名称为: java.sql.Driver 且内容为：com.mysql.cj.jdbc.Driver

我们直接去引入的包里面搜索一下：

image-20230704230413850

果然没错，接下来我们来一下 SPI 的原理

五、SPI运行原理剖析

从我们上面的示例中可以发现，SPI 的实现一共两行：

package com.study.spring.spi;

import java.util.Iterator;
import java.util.ServiceLoader;

public class JavaSPITest {
    public static void main(String[] args) {
        // 执行Java SPI的规范
        ServiceLoader<Phone> phoneServiceLoader = ServiceLoader.load(Phone.class);
		// 获取迭代器
        Iterator<Phone> it = phoneServiceLoader.iterator();
        // 迭代遍历，输出集合中的所有元素
        while (it.hasNext()) {
            System.out.println(it.next());
        }
    }
}

我们挨个分析

1、服务初始化加载

ServiceLoader<Phone> phoneServiceLoader = ServiceLoader.load(Phone.class);

public static <S> ServiceLoader<S> load(Class<S> service) {
    // 获取当前线程的类加载器
    ClassLoader cl = Thread.currentThread().getContextClassLoader();
    return ServiceLoader.load(service, cl);
}

public static <S> ServiceLoader<S> load(Class<S> service, ClassLoader loader){
    return new ServiceLoader<>(service, loader);
}

private ServiceLoader(Class<S> svc, ClassLoader cl) {
    // svc:com.study.spring.spi.Phone
    service = Objects.requireNonNull(svc, "Service interface cannot be null");
    // AppClassLoader
    loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
    // 安全控制
    acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
    // 重点
    reload();
}

这里的重点还是在我们的 reload 中：

public void reload() {
    // 清空我们的服务提供者缓存
    providers.clear();
    // 延时迭代器，用于延迟加载服务提供者
    // 达到用需加载的目的
    lookupIterator = new LazyIterator(service, loader);
}

private LazyIterator(Class<S> service, ClassLoader loader) {
    this.service = service;
    this.loader = loader;
}

2、获取迭代器

Iterator<Phone> it = phoneServiceLoader.iterator();

// 返回我们ServiceLoader自定义实现的迭代器
public Iterator<S> iterator() {
    return new Iterator<S>() {

        Iterator<Map.Entry<String,S>> knownProviders = providers.entrySet().iterator();

        public boolean hasNext() {
            if (knownProviders.hasNext())
                return true;
            return lookupIterator.hasNext();
        }

        public S next() {
            if (knownProviders.hasNext()){
                return knownProviders.next().getValue();
            }
            return lookupIterator.next();
        }

        public void remove() {
            throw new UnsupportedOperationException();
        }
    };
}

3、判断是否有数据

it.hasNext()
public boolean hasNext() {
    // 刚刚初始化knownProviders是空的
    if (knownProviders.hasNext())
        return true;
    // 
    return lookupIterator.hasNext();
}

public boolean hasNext() {
    // 是否有控制权限
    // 一般都是空的
    if (acc == null) {
        return hasNextService();
    } else {
        PrivilegedAction<Boolean> action = new PrivilegedAction<Boolean>() {
            public Boolean run() { return hasNextService(); }
        };
        return AccessController.doPrivileged(action, acc);
    }
}

重点还是在 hasNextService 方法中

private boolean hasNextService() {
    // 如果当前的Name不等于空直接返回
    if (nextName != null) {
        return true;
    }
    // 配置是否为空(第一次肯定为空)
    if (configs == null) {
        try {
            // 写死的：META-INF/services 加上接口的名字
            // META-INF/services/com.study.spring.spi.Phone
            String fullName = PREFIX + service.getName();
            // 加载配置
            // configs
            if (loader == null)
                configs = ClassLoader.getSystemResources(fullName);
            else
                configs = loader.getResources(fullName);
        } catch (IOException x) {
            fail(service, "Error locating configuration files", x);
        }
    }
    // 判断当前的集合是否为空 || 是否已经遍历完毕
    while ((pending == null) || !pending.hasNext()) {
        // 校验是否有错误
        if (!configs.hasMoreElements()) {
            return false;
        }
        // 从上述配置文件中读取当前的配置信息
        // com.study.spring.spi.HuaWei
        // com.study.spring.spi.IPhone
        // com.study.spring.spi.XiaoMi
        pending = parse(service, configs.nextElement());
    }
    // 遍历当前的列表，返回第一次的遍历信息(com.study.spring.spi.HuaWei)
    nextName = pending.next();
    return true;
}

4、结果输出

System.out.println(it.next());
public S next() {
    // 刚刚初始化knownProviders是空的
    if (knownProviders.hasNext())
        return knownProviders.next().getValue();
    return lookupIterator.next();
}

public S next() {
    // 是否有控制权限
    // 一般都是空的
    if (acc == null) {
        return nextService();
    } else {
        PrivilegedAction<S> action = new PrivilegedAction<S>() {
            public S run() { return nextService(); }
        };
        return AccessController.doPrivileged(action, acc);
    }
}

重点还是在 nextService 方法中

private S nextService() {
    String cn = nextName;
    nextName = null;
    Class<?> c = null;
    // cn：com.study.spring.spi.HuaWei
    // 根据类加载器+类的名称得出类
    c = Class.forName(cn, false, loader);
	
    // 创建实例 
    S p = service.cast(c.newInstance());
    // 将实例放到缓存里面
    // key:com.study.spring.spi.HuaWei
    // value:HuaWei@773
    providers.put(cn, p);
    // 返回实例
    return p;
}

六、SPI流程图

高清图可私聊博主获取

在这里插入图片描述

七、总结

鲁迅先生曾说：独行难，众行易，和志同道合的人一起进步。彼此毫无保留的分享经验，才是对抗互联网寒冬的最佳选择。

其实很多时候，并不是我们不够努力，很可能就是自己努力的方向不对，如果有一个人能稍微指点你一下，你真的可能会少走几年弯路。

后面会继续更新 Dubbo 的 SPI 以及项目真实落地的 SPI 实现

如果你也对 后端架构 和 中间件源码 有兴趣，欢迎添加博主微信：hls1793929520，一起学习，一起成长

我是爱敲代码的小黄，独角兽企业的Java开发工程师，CSDN博客专家，喜欢后端架构和中间件源码。

我们下期再见。

我从清晨走过，也拥抱夜晚的星辰，人生没有捷径，你我皆平凡，你好，陌生人，一起共勉。

往期文章推荐：

更多推荐

【Git】03-GitHub

文章目录1.GitHub核心功能2.GitHub搜索项目3.GitHub搭建个人博客4.团队项目创建5.git工作流选择5.1需要考虑的因素5.2主干开发5.2GitFlow5.3GitHubFlow5.4GitLabFlow(带生产分支)5.4GitLabFlow(带环境分支)5.4GitLabFlow(带发布分支)

Ceph入门到静态-deep scrub 深度清理处理

9.6洗刷REPORTDOCUMENTATIONBUG#除了为对象创建多个副本外，Ceph还可通过洗刷归置组来确保数据完整性（请参见第1.3.2节“归置组”了解有关归置组的详细信息）。Ceph的洗刷类似于在对象存储层运行fsck。对于每个归置组，Ceph都会生成一个包含所有对象的编目，并比较每个主对象及其副本，以确保不

如何解决 Spring Boot Actuator 的未授权访问漏洞

SpringBootActuator的作用是提供了一组管理和监控端点，允许你查看应用程序的运行时信息，例如健康状态、应用程序信息、性能指标等。这些端点对于开发、测试和运维团队来说都非常有用，可以帮助快速诊断问题、监控应用程序的性能，并采取必要的措施来维护和管理应用程序。SpringBootActuator未授权访问的配

LeetCode 40. Combination Sum II【回溯,剪枝】中等

本文属于「征服LeetCode」系列文章之一，这一系列正式开始于2021/08/12。由于LeetCode上部分题目有锁，本系列将至少持续到刷完所有无锁题之日为止；由于LeetCode还在不断地创建新题，本系列的终止日期可能是永远。在这一系列刷题文章中，我不仅会讲解多种解题思路及其优化，还会用多种编程语言实现题解，涉及

LeetCode 39. Combination Sum【回溯,剪枝】中等

本文属于「征服LeetCode」系列文章之一，这一系列正式开始于2021/08/12。由于LeetCode上部分题目有锁，本系列将至少持续到刷完所有无锁题之日为止；由于LeetCode还在不断地创建新题，本系列的终止日期可能是永远。在这一系列刷题文章中，我不仅会讲解多种解题思路及其优化，还会用多种编程语言实现题解，涉及

Android.bp常用语法和预定义属性

介绍Android.bp是Android构建系统中用于定义模块和构建规则的配置文件，它使用一种简单的声明式语法。以下是Android.bp的一些常见语法规则和约定：注释：单行注释使用//符号。多行注释使用/和/包围。和go语言相同//这是单行注释/*这是多行注释*/模块定义：每个模块都以module_type字段开始，

hadoop集群搭建

vim/etc/hosts192.168.1.2Master.Hadoop192.168.1.3Slave1.Hadoop192.168.1.4Slave2.Hadoop192.168.1.5Slave3.Hadoop若能用主机名进行ping通，说明刚才添加的内容，在局域网内能进行DNS解析。hadoop:https:

【iOS】浅析static，const，extern关键字

文章目录前言一、staticstatic修饰局部变量static修饰全局变量总结二、const三、extern声明全局变量声明函数在头文件中使用总结前言笔者本周在学习单例模式时，用到了static关键字，特此总结博客记录学习static，const，extern关键字的过程一、staticstatic——静态，我们将用

【golang】实现通用的get/post请求（接受一个 URL 和一个结构体参数）

通用的GET请求实现一个通用的GET请求函数，该函数接受一个URL和一个结构体参数，并将结构体参数编码为查询参数。以下是一个通用的示例代码：packagemainimport("fmt""net/http""net/url""reflect""strings")funcgetFunc(baseUrlstring,str

Learn Prompt-ChatGPT 精选案例:简单介绍

恭喜你!现在你已经学会了如何编写提示语。本节主要讨论的是如何使用提示语来解决我们在日常或工作中遇到的任务。如果你已经有了一个提示语集，如何决定哪些提示语适合手头的任务？在本节中，我们将通过一些实际例子来给你提供灵感。在挑选案例的时候，我们更加希望展示的是如何将复杂的工作任务拆解成相互关联的小任务。例如在PPT制作中，我

【C++代码】平衡二叉树，二叉树的所有路径，左叶子之和--代码随想录

题目：平衡二叉树给定一个二叉树，判断它是否是高度平衡的二叉树。一棵高度平衡二叉树定义为：一个二叉树每个节点的左右两个子树的高度差的绝对值不超过1。题解这道题中的平衡二叉树的定义是：二叉树的每个节点的左右子树的高度差的绝对值不超过1，则二叉树是平衡二叉树。根据定义，一棵二叉树是平衡二叉树，当且仅当其所有子树也都是平衡二叉

热文推荐
  1. Spring高手之路12——BeanDefinitionRegistry与BeanDefinition合并解析

    文章目录1.什么是BeanDefinitionRegistry？2.为什么需要BeanDefinitionRegistry？3.BeanDefinitionRegistry的使用3.1BeanDefinitionRegistry简单例子3.2有关ImportBeanDefinitionRegistrar的实现类的例子4

  2. sed的不同执行方式

    1.命令行执行多条sed命令1.1命令行通过多条-e选项sed-e'command1'-e'command2'-e'command3'匹配root或nobody，或mail：sed-n-e'/^root/p'-e'/^nobody/p'-e'/^mail/p'/etc/passwd1.2用\换行Shell的换行符依然有

  3. 音频领域的50个关键词

    音频领域的50个关键词前言50个关键词label:音频领域，关键词，领域黑话持续更新中，评论点赞收藏能加快更新的速度……前言本文小结音频领域中高频出现的关键词，便于初入此道的同学有个初略概念。有了这个黑话词典或者研究地图，也能帮助新同学更好地和音频相关领域人员进行交流沟通。单个关键词深入的细节都可以在互联网上搜索到，感

  4. 献给阿尔吉侬的花束( 入门级bfs查找 + 模版解读 + 错误示范)

    献给阿尔吉侬的花束问题文章目录献给阿尔吉侬的花束问题前言题目描述题目分析方法判定bfs算法模版介绍两个数组【记录地图，记录移动距离】一个队列【依次遍历所有接触到的点】一次遍历模版代码如下;题解代码错误示范总结前言许多小伙伴刚刚接触到bfs算法时可能会觉得步骤比较繁琐，所以这里找了一道入门级的bfs算法题为大家介绍模版，

  5. 亿图脑图移动端V7.0.0推出一键生成竖屏海报，提升思维导图在手机上的阅读体验

    近日，亿图脑图移动端V7.0.0版本上线，支持思维导图一键生成竖版海报，开拓了一种新的图文表现形式。思维导图作为一种便捷的可视化工具，被广泛应用于日常生活和工作场合中，然而，在手机终端成为主导的竖屏阅读时代，思维导图往往会出现排版复杂，显示效果不佳等问题，这严重影响了用户的使用体验和效率。所以，亿图脑图移动端V7.0.

  6. 算法通关村第13关【白银】| 数字与数学高频问题

    数组实现加法1.加一思路：不进位末尾加一，进位挨个加一99,999...进位，新建长度+1的数组，res[0]=1，直接返回lassSolution{publicint[]plusOne(int[]digits){for(inti=digits.length-1;i>=0;i--){intnum=++digits[i]

  7. Direct3D融合技术

    该技术能使我们将当前要进行光栅化的像素的颜色与先前已已光栅化并处于同一位置的像素的颜色进行合成，即将正在处理的图元颜色值与存储在后台缓存中的像素颜色值进行合成(混合)，利用该技术我们可得到各种各样的效果，尤其是透明效果。在融合运算时需要遵循：首先绘制那些不需要进行融合的物体，然后将需要进行融合的物体按照相对于摄像机的深

  8. 低代码之JeecgBoot

    JeecgBootJeecgBoot是一款基于BPM的低代码平台！前后端分离架构SpringBoot2.x，SpringCloud，AntDesign&Vue，Mybatis-plus，Shiro，JWT，支持微服务。强大的代码生成器让前后端代码一键生成，实现低代码开发！JeecgBoot引领新低代码开发模式Onlin

  9. 【网络协议】Http-下

    因为Http是无状态的，所以为了协助Web保持状态，Cookie诞生了。下面中是百度百科关于Cookie和Session的解释：Cookie：举例来说,一个Web站点可能会为每一个访问者产生一个唯一的ID,然后以Cookie文件的形式保存在每个用户的机器上。如果使用浏览器访问Web,会看到所有保存在硬盘上的Cookie