java中SPI服务提供者的接口使用总结

 更新时间:2024年10月11日 11:50:45   作者:醉卧雕龙舫 、  
SPI英文全称为Service Provider Interface,顾名思义,服务提供者接口,它是jdk提供给“服务提供厂商”或者“插件开发者”使用的接口

一:什么是SPI

SPI:“服务提供者的接口”,是一种服务发现机制

用于实现框架或库的扩展点,允许在运行时动态地插入或更换组件实现。

它提供了一个框架(JDK1.6后ServiceLoader)来发现和加载服务实现,使得软件模块能够灵活地选择和使用不同的服务提供商。

在这里插入图片描述

在java中通俗讲就是:

  • 对框架或第三方jar包提供者来说可制定规范,提供给开发者可扩展性
  • 对开发者来说可以根据需要轻松替换框架或第三方jar包中提供了SPI机制的接口的实现

在AJ-Captcha与Nacos中均提供了SPI扩展。

二:java SPI示例

1.SPI服务提供方

SPI服务提供方架构图:

在这里插入图片描述

定义接口规范:

public interface SpiService {
    /**
     * 呼叫方式
     */
    void call();
}

加载具体的服务实现:

package com.lmy.config;

import com.lmy.service.SpiService;

import java.util.ArrayList;
import java.util.List;
import java.util.ServiceLoader;

/**
 * @author : lmy
 * @date : 2024/9/14 上午 11:35
 * 加载具体的服务实现
 */
public class SpiServiceLoader {
    private static volatile SpiServiceLoader LOADER;

    private final SpiService spiService;

    private final List<SpiService> spiServiceList;

    /**
     * 加载服务
     * */
    private SpiServiceLoader() {
        ServiceLoader<SpiService> loader = ServiceLoader.load(SpiService.class);
        List<SpiService> list = new ArrayList<>();
        for (SpiService spiService : loader) {
            list.add(spiService);
        }
        spiServiceList = list;
        if (!list.isEmpty()) {
            // 取第一个
            spiService = list.get(0);
        } else {
            spiService = null;
        }
    }

    /**
     * SpiServiceLoader 单例加载
     * */
    public static SpiServiceLoader getLOADER() {
        if (LOADER == null) {
            synchronized (SpiServiceLoader.class) {
                if (LOADER == null) {
                    LOADER = new SpiServiceLoader();
                }
            }
        }
        return LOADER;
    }


    public void call(){
        if(spiServiceList.isEmpty()){
            System.out.println("SpiService服务未加载!");
        }else {
            SpiService spiService = spiServiceList.get(0);
            spiService.call();
        }
    }

}

默认实现:

package com.lmy.service.impl;

import com.lmy.service.SpiService;

/**
 * @author : lmy
 * @date : 2024/9/14 上午 10:58
 * 默认实现
 */
public class SpiServiceImpl implements SpiService {
    @Override
    public void call() {
        System.out.println("默认手机呼叫");
    }
}

指定服务实现方式:
须在resource下创建META-INF.services,文件名为接口全限定类名,配置为需要被加载的接口实现类的全限定类名

在这里插入图片描述

com.lmy.service.impl.SpiServiceImpl

项目打包发布本地:

在这里插入图片描述

2.SPI服务应用方开发者

开发者引入jar包使用服务:

<dependency>
    <groupId>com.lmy</groupId>
    <artifactId>SPI-interface</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>
package com.lmy.Spi;

import com.lmy.config.SpiServiceLoader;
import org.junit.Test;

/**
 * @author : lmy
 * @date : 2024/9/14 上午 11:48
 */
public class SpiTest {

    @Test
    public void spiTest () {
        SpiServiceLoader loader = SpiServiceLoader.getLOADER();
        loader.call();
    }
}

执行结果:

在这里插入图片描述

开发者根据需要扩展替换为自己的服务实现:

package com.lmy.Spi.service;

import com.lmy.service.SpiService;

/**
 * @author : lmy
 * @date : 2024/9/14 下午 2:09
 */
public class SpiServiceNewImpl implements SpiService {
    @Override
    public void call() {
        System.out.println("卫星直呼");
    }
}

在这里插入图片描述

com.lmy.Spi.service.SpiServiceNewImpl

执行结果:

在这里插入图片描述

三:JavaSPI 机制的核心-ServiceLoader

上面代码可见是通过ServiceLoader 去加载具体的服务实现的

在这里插入图片描述

ServiceLoader 是从JDK1.6 开始提供的一个类,用于加载服务提供者。

进入源码可见:
其中 String PREFIX = “META-INF/services/”;
这个就是JDK的SPI功能规定的具体服务实现的配置信息文件所在的目录 META-INF/services/

在这里插入图片描述

JDK的SPI规定 服务实现者需要在 META-INF/services/ 目录下 新建文件名为 SPI接口全限定类名的文件
文件内容为 服务实现者需要被加载的具体类的全限定类名

到此这篇关于java中SPI服务提供者的接口使用总结的文章就介绍到这了,更多相关java spi详解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java持久层框架Mybatis入门详细教程

    Java持久层框架Mybatis入门详细教程

    Mybatis持久层框架支持自定义SQL、存储过程以及高级映射,可以通过XML或注解来配置和映射原始类型、接口和Java POJOs为数据库中的记录,接下来通过本文给大家介绍Java持久层框架Mybatis入门详细教程,一起学习下吧
    2021-06-06
  • mybatis配置获取自增主键的操作方法

    mybatis配置获取自增主键的操作方法

    当需要刚刚插入数据库的数据对应的新增主键时,通过配置xml文件,使数据库返回新增主键id,并把主键id与类参数对应,本文给大家介绍了mybatis配置获取自增主键的操作方法,需要的朋友可以参考下
    2024-05-05
  • 使用Apache Ignite实现Java数据网格

    使用Apache Ignite实现Java数据网格

    今天我们来探讨如何使用Apache Ignite来实现Java数据网格,Apache Ignite是一个高性能的内存计算平台,它提供了分布式缓存、数据网格和计算功能,可以显著提高大规模应用的数据处理性能,感兴趣的小伙伴跟着小编一起来看看吧
    2024-08-08
  • 解决mybatis 执行mapper的方法时报空指针问题

    解决mybatis 执行mapper的方法时报空指针问题

    这篇文章主要介绍了解决mybatis 执行mapper的方法时报空指针问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • Java获取磁盘空间的两种代码示例

    Java获取磁盘空间的两种代码示例

    这篇文章主要介绍了Java获取磁盘空间的两种代码示例,没什么事的时候可以拿来玩玩,需要的朋友参考下。
    2017-11-11
  • 分布式框架Zookeeper api的使用介绍

    分布式框架Zookeeper api的使用介绍

    Zookeeper作为⼀个分布式框架,主要用来解决分布式⼀致性问题,它提供了简单的分布式原语,并且对多种编程语⾔提供了API,所以接下来重点来看下Zookeeper的java客户端API使用方式
    2022-09-09
  • Java中的ScheduledThreadPoolExecutor定时任务详解

    Java中的ScheduledThreadPoolExecutor定时任务详解

    这篇文章主要介绍了Java中的ScheduledThreadPoolExecutor详解,  ScheduledThreadPoolExecutor 继承自 ThreadPoolExecutor,它主要用来在给定的延迟之后运行任务,或者定期执行任务,ScheduledThreadPoolExecutor 的功能与 Timer 类似<BR>,需要的朋友可以参考下
    2023-12-12
  • Java中该如何优雅的使用线程池详解

    Java中该如何优雅的使用线程池详解

    在java开发中我们对“池”的概念并不陌生,常见的有数据库连接池、线程池、对象池、常量池等等,其作用基本上就是避免频繁的创建和回收,造成资源浪费,线程池也不例外,这篇文章主要给大家介绍了关于Java中该如何优雅的使用线程池的相关资料,需要的朋友可以参考下
    2021-12-12
  • 详解Spring Security 中的四种权限控制方式

    详解Spring Security 中的四种权限控制方式

    这篇文章主要介绍了详解Spring Security 中的四种权限控制方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • Struts2的配置文件方法小结

    Struts2的配置文件方法小结

    最近正在学习Struts2,在配置文件中遇到好多标签,各种意义不同。下面这篇文章就来给大家介绍关于Struts2配置文件的相关资料,文中通过图文介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧。
    2018-04-04

最新评论