Java SPI机制

陇西行_44301937

已于 2024-01-11 18:16:58 修改

阅读量927

点赞数 25

文章标签： java 开发语言

于 2024-01-11 18:15:26 首次发布

本文链接：https://blog.csdn.net/qq_44301937/article/details/135529693

版权

引言

最近在重新学习Java基础，学习到SPI相关知识时发现大部分文章并没能描述清楚其核心意义及思想，于是结合自己的感悟梳理了一篇相对全面、易懂的SPI文章，仅供大家学习参考

一、概念

SPI全称：Service Provider Interface，即服务提供接口。是Java官方提供的一种服务发现机制，它允许在程序运行时动态地加载实现特定接口的实现类，极大的增强了程序的灵活性、降低了耦合性。

一套完整的逻辑闭环的SPI简单来说就是服务方提供某一个服务的接口，提供给服务开发者或者服务生产商来进行实现。场景举例：JDBC与MySql厂商、Oracle厂商，JDBC就是服务方，提供了java.sql.Driver接口，MySql厂商与Oracle厂商来分别实现此接口，以提供自家的数据库驱动程序；在此过程中，JDBC的开发者不关注java.sql.Driver接口的具体实现，他们仅需与java.sql.Driver接口交互即可。而我们在引用JDBC包的时候，就可以直接使用到Driver的实现类

二、原理

思考：在上述过程中，JDBC的Driver实现类是由别人提供的，也就是说此实现类并不能存在于JDBC的src目录下，那么JDBC的项目是如何加载到这个实现的呢？

具体实现逻辑如下图：

由图可知，除开JDBC提供接口、数据库厂商实现接口这两个环节之外，还有一个非常重要的动作将这两个环节融合到一起，即上图中标黄的元素：ServiceLoader。至此，我们认识到了SPI中的所有角色，分别是：

1.Service：一个公开的接口，或定义了一个抽象的功能模块

2.ServiceProvider：Service接口的实现类

3.ServiceLoader：SPI机制中的核心组件，负责在程序运行过程中发现并加载ServiceProvider

三、实例

模拟需求：有一家公司A，它需要接入互联网。它定义了一个连接网络的API，由中国移动和中国联通提供网络服务。此场景下共涉及三个角色，如下图所示：

在此需求中spi-core项目中的ClassName接口即为SPI的Service

spi-moblie、spi-unicom项目分别实现spi-core中的ClassName接口

同时ServiceProvider项目的resource目录下需要添加一个配置文件，文件格式如图：简单来说就是需要让ServiceLoader清楚的知道需要加载哪个接口，此接口又有哪些实现类（当实现类为多个时，用回车分割多个全路径名即可）

至此，一套简易的SPI就搭建完成了，当我们在程序中依赖了spi-unicom时，调用如下代码即可访问到spi-unicom对spi-core的实现

package com.example.web.test;

import com.example.spicore.core.ClassName;

import java.util.ServiceLoader;

/**
 * @author cui
 * @version 1.0.0
 * @ClassName RunName.java
 * @Description
 * @createTime 2023年09月18日 17:35:00
 */
public class RunName {
    public static void main(String[] args) {
        ServiceLoader<ClassName> classNames = ServiceLoader.load(ClassName.class);
        for (ClassName className : classNames) {
            className.soutName();
        }
    }
}

输出结果如下：