Java SPI机制详解

news2024/11/19 9:29:50

一、什么是SPI

SPI全称Service Provider Interface，是Java提供的一种服务发现机制。实现服务接口和服务实现的解耦。
Java SPI 实际上是“基于接口的编程＋策略模式＋配置文件”组合实现的动态加载机制，实现不修改任何代码的情况下切换不同的实现。
ServiceLoader
加载特定接口
从META-INF/services加载配置
加载接口实现类A
加载接口实现类B

二、使用场景

很多开源第三方jar包都有基于SPI的实现，在jar包META-INF/services中都有相关配置文件。

如下几个常见的场景：

1）JDBC加载不同类型的数据库驱动
2）Slf4j日志框架
3）Dubbo框架

三、使用步骤示例

假设有个上传附件的场景，可以上传到不同的云储存（如阿里云OSS，亚马逊S3），那么基于Java SPI机制的实现，我们应该做如下步骤：

步骤1、创建4个工程

SPI的核心就是实现服务接口和服务实现的解耦，所以我们不能将接口和实现放在一个工程里面。

  • spi-file-upload，在这定义附件上传接口IFileUpload
  • spi-file-upload-oss，实现附件上传到oss，FileUploadOss实现接口IFileUpload
  • spi-file-upload-s3，实现附件上传到s3，FileUploadS3实现接口IFileUpload
  • spi-file-upload-test，通过ServiceLoader加载接口实现，进行测试
    在这里插入图片描述

步骤2、 在工程spi-file-upload创建接口IFileUpload

接口代码示例

package com.hj.test.file.oss;

import com.hj.test.file.IFileUpload;

public class FileUploadOss implements IFileUpload {
    @Override
    public void upload(String fileName) {
        System.out.println("上传到阿里云OSS..." + fileName);
    }
}

步骤3、分别创建接口实现类FileUploadOss、FileUploadS3

1）FileUploadOss

在工程的 spi-file-upload-oss 的 resources目录下创建目录META-INF/services，并在该目录中创建以接口IFileUpload全路径命名的文件（com.hj.test.file.IFileUpload），文件内容是接口实现类 com.hj.test.file.oss.FileUploadOss

package com.hj.test.file.oss;

import com.hj.test.file.IFileUpload;

public class FileUploadOss implements IFileUpload {
    @Override
    public void upload(String fileName) {
        System.out.println("上传到阿里云OSS..." + fileName);
    }
}

在这里插入图片描述

2）FileUploadS3

在工程的 spi-file-upload-s3 的 resources目录下创建目录META-INF/services，并在该目录中创建以接口IFileUpload全路径命名的文件（com.hj.test.file.IFileUpload），文件内容是接口实现类 com.hj.test.file.s3.FileUploadS3

package com.hj.test.file.s3;

import com.hj.test.file.IFileUpload;

public class FileUploadS3 implements IFileUpload {
    @Override
    public void upload(String fileName) {
        System.out.println("上传到亚马逊s3..." + fileName);
    }
}

步骤4、在工程spi-file-upload-test中创建测试调用类

1）在pom.xml中引入3个依赖工程

<dependency>
    <groupId>com.hj</groupId>
    <artifactId>spi-file-upload</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>com.hj</groupId>
    <artifactId>spi-file-upload-oss</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>
<dependency>
    <groupId>com.hj</groupId>
    <artifactId>spi-file-upload-s3</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

2）测试实现

package com.hj.test.file.test;

import com.hj.test.file.IFileUpload;

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

public class FileTest{
    public static void main(String[] args) {
        ServiceLoader<IFileUpload> loader = ServiceLoader.load(IFileUpload.class);
        for(Iterator<IFileUpload> it = loader.iterator(); it.hasNext();){
            IFileUpload file = it.next();
            file.upload("测试文件上传");
        }
    }
}

控制台输出

上传到阿里云OSS...测试文件上传
上传到亚马逊s3...测试文件上传

如果哪天不想要传到s3，只需要把jar包依赖去掉就可以，无需改代码

四、原理解析

1、SPI的核心就是ServiceLoader.load()方法

总结如下：

  1. 调用ServiceLoader.load()，创建一个ServiceLoader实例对象
  2. 创建LazyIterator实例对象lookupIterator
  3. 通过lookupIterator.hasNextService()方法读取固定目录META-INF/services/下面service全限定名文件，放在Enumeration对象configs中
  4. 解析configs得到迭代器对象Iterator<String> pending
  5. 通过lookupIterator.nextService()方法初始化读取到的实现类，通过Class.forName()初始化

从上面的步骤可以总结以下几点

  1. 实现类工程必须创建定目录META-INF/services/，并创建service全限定名文件，文件内容是实现类全限定名
  2. 实现类必须有一个无参构造函数

2、ServiceLoader核心代码介绍

public final class ServiceLoader<S>
    implements Iterable<S>
{

    private static final String PREFIX = "META-INF/services/";

    // The class or interface representing the service being loaded
    private final Class<S> service;

    // The class loader used to locate, load, and instantiate providers
    private final ClassLoader loader;

    // The access control context taken when the ServiceLoader is created
    private final AccessControlContext acc;

    // Cached providers, in instantiation order
    private LinkedHashMap<String,S> providers = new LinkedHashMap<>();

    // The current lazy-lookup iterator
    private LazyIterator lookupIterator;

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

public void reload() {
    providers.clear();
    lookupIterator = new LazyIterator(service, loader);
}

private ServiceLoader(Class<S> svc, ClassLoader cl) {
    service = Objects.requireNonNull(svc, "Service interface cannot be null");
    loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
    acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
    reload();
}

通过方法iterator()生成迭代器，内部调用LazyIterator实例对象

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

    };
}

内部类LazyIterator，读取配置文件META-INF/services/

private class LazyIterator
        implements Iterator<S>
    {

    Class<S> service;
    ClassLoader loader;
    Enumeration<URL> configs = null;
    Iterator<String> pending = null;
    String nextName = null;

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

    private boolean hasNextService() {
        if (nextName != null) {
            return true;
        }
        if (configs == null) {
            try {
                String fullName = PREFIX + service.getName();
                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;
            }
            pending = parse(service, configs.nextElement());
        }
        nextName = pending.next();
        return true;
    }

    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
    }

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

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

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

}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/124914.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

不错的一个麦肯锡信任公式

不错的一个麦肯锡信任公式

1&#xff09;可信度&#xff1a;这人是不是专家。 你是否让他人可以相信你这个人。这取决于你解决问题的能力、经验、专业知识、资源等等&#xff1b;这个人的专业能力是否真有别人说的那么出色&#xff0c;是否能够胜任这份工作呢&#xff1f;过往的履历中是否做过足以让我值…
阅读更多...
函数指针到底需不需要解引用？类成员函数呢？

函数指针到底需不需要解引用？类成员函数呢？

1、 普通函数指针 C函数指针有两点比较令人疑惑的做法&#xff1a; 函数名作为实参时&#xff0c;到底要不要取地址&#xff1f;通过函数指针调用函数时&#xff0c;到底要不要解引用&#xff1f; int add(int a, int b) {cout << "common function: " <…
阅读更多...
ubuntu18安装、测试YOLOV3记录

ubuntu18安装、测试YOLOV3记录

官方教程&#xff1a; YOLO: Real-Time Object Detection 一、使用预训练模型进行检测 1、安装Darknet: git clone https://github.com/pjreddie/darknet cd darknet make 2、下载预训练权重https://pjreddie.com/media/files/yolov3.weights&#xff08;打开链接或wget&…
阅读更多...
C语言进阶-枚举

C语言进阶-枚举

C语言进阶-枚举
阅读更多...
VSCode无密码连接远程服务器，并能debug python代码

VSCode无密码连接远程服务器，并能debug python代码

1.官网下载VScode 官网 2.打开VScode&#xff0c;在扩展中搜索下载远程连接插件Remote-SSH 下载完毕会在侧边栏产生“远程资源管理器”图标①&#xff0c;打开远程资源管理器&#xff0c;点击右上角设置进入配置界面&#xff0c;并按照②添加远程服务器账号&#xff0c;输入…
阅读更多...
Charles -证书过期失效处理方法

Charles -证书过期失效处理方法

当出现环境配置正常但却无法抓包的时候&#xff0c;可能是因为证书失效了&#xff0c;这种情况移除旧证书&#xff0c;安装新的证书即可。 一、判断是否证书过期 iOS手机&#xff1a; 进入&#xff1a;设置 > 通用 > VPN与设备管理 > Charles Proxy CA... > 更多…
阅读更多...
45. 含并行连结的网络（GoogLeNet）代码实现

45. 含并行连结的网络（GoogLeNet）代码实现

1. Inception块 import torch from torch import nn from torch.nn import functional as F from d2l import torch as d2lclass Inception(nn.Module):# c1--c4是每条路径的输出通道数,c2,c3,c4是一个tuple元组def __init__(self, in_channels, c1, c2, c3, c4, **kwargs):su…
阅读更多...
C# .Net MVC框架实现最简单的登陆

C# .Net MVC框架实现最简单的登陆

提示&#xff1a;文章写完后&#xff0c;目录可以自动生成&#xff0c;如何生成可参考右边的帮助文档 文章目录前言C#.net实现最简单登陆一、C#,.net是什么&#xff0c;相比较于C,java二、C# .net创建一个MVC框架工程1.步骤实现结果前言 C#.net实现最简单登陆 提示&#xff1…
阅读更多...
linux-----基本操作指令(2)

linux-----基本操作指令(2)

将一个文件按照升序排序:注意这里面的S是大写 按照文件大小按照降序排列:ll -hS 按照文件大小按照升序排列:ll -hrS 一:cp(copy)表示复制&#xff0c;类似于windows系统上面的复制文件到指定文件夹的操作时类似的&#xff0c;拿鼠标一拖到指定路径 1)同时也就是说这个文件最终在…
阅读更多...
Python实现的通用的二进制数据分析工具，分析任意格式的二进制数据，还能同时查看协议文档

Python实现的通用的二进制数据分析工具，分析任意格式的二进制数据，还能同时查看协议文档

这是一个通用的二进制数据分析工具。 完整程序代码下载地址&#xff1a;Python实现的通用的二进制数据分析工具 它能做什么 分析任意格式的二进制数据&#xff0c;还能同时查看协议文档逐字节、逐位分析手动、自动分析对分析结果建透视图&#xff0c;发现规律&#xff0c;学习…
阅读更多...
IO流的节点流和处理流（缓冲流）and ZIP流使用

IO流的节点流和处理流（缓冲流）and ZIP流使用

流的名称 字节流和字符流的区别 每次读写的字节数不同&#xff1b; 字符流是块读写&#xff0c;字节流是字节读写&#xff1b; 字符流带有缓存&#xff0c;字节流没有 java流在处理上分为字符流和字节流。字符流处理的单元为2个字节的Unicode字符&#xff0c;分别操作字符、…
阅读更多...
scipy.interpolate插值方法介绍

scipy.interpolate插值方法介绍

文章目录scipy.interpolate插值方法1 一维插值2 multivariate data3 Multivariate data interpolation on a regular grid4 Rbf 插值方法scipy.interpolate插值方法 1 一维插值 from scipy.interpolate import interp1d 1维插值算法 from scipy.interpolate import interp1d…
阅读更多...
u盘损坏后如何恢复数据?

u盘损坏后如何恢复数据?

u盘经常被用作移动数据存储盘。可以通过USB接口将u盘插入电脑&#xff0c;将需要复制的数据发送到u盘;然后拔掉u盘&#xff0c;插入另一台电脑的USB口打开&#xff0c;就可以把数据复制到另一台电脑上了。实现数据传输。但有使用就意味着有意外&#xff0c;当我们使用中出现了u…
阅读更多...
Flowable教程

Flowable教程

文章目录一、Flowable介绍1.简介2.Activiti、Flowable、Camunda二、Flowable实战&#xff08;集成Flowable Modeler&#xff09;三、流程的创建和使用1.BPMN基本概念介绍2.业务模型流程创建3.表单创建及使用4.流程的使用5.核心表介绍四、常见报错解决一、Flowable介绍 1.简介 …
阅读更多...
3.JMeter基本组成部分

3.JMeter基本组成部分

文章目录2.3 JMeter基本组成部分2.3 .1线程组2.3.1.1 添加线程组2.3.1.2 线程组的特点2.3.1.3 线程组分类2.3.1.4 线程组属性2.3.2 取样器 HTTP请求2.3.3 查看结果树2.3 JMeter基本组成部分 2.3 .1线程组 线程组是控制JMeter将用于执行测试的线程组数&#xff0c;也可以把一个…
阅读更多...
代理模式

代理模式

“接口隔离”模式 在组件构建过程中&#xff0c;某些接口之间直接的依赖常常会带来很多问题、甚至根本无法实现。采用添加一层间接&#xff08;稳定&#xff09;接口&#xff0c;来隔离本来互相紧密关联的接口是一种常见的解决方案。 典型模式 ①门面模式 ②代理模式 ③适配…
阅读更多...
[oeasy]python0033_回车_carriage_return_figlet_字体变大

[oeasy]python0033_回车_carriage_return_figlet_字体变大

回到开头 回忆上次内容 进程前后台切换 ctrl z 把当前进程切换到后台并暂停jobs 查看所有作业 用 fg 可以把后台进程再切回前台 fg %1 可以把指定的任务切回前台用 bg 可以让进程在后台运行 进程查询 ps -elf 查看所有进程信息ps -lf 查看本终端相关进程信息kill -9 PID 给进…
阅读更多...
部署项目到Nginx

部署项目到Nginx

目录 1、将vue脚手架项目打包 2、将服务端项目打为jar包后上传到linux 3、 使用nginx解决跨域问题 5、 proxy_pass配置问题 1、将vue脚手架项目打包 运行:npm run build命令将vue cli项目打包。 路径在终端会显示 在虚拟机上将此文件上传入nginx中 然后打开nginx,显示页面…
阅读更多...
linux下以rpm包安装mysql

linux下以rpm包安装mysql

目录 下载 上传解压 安装 编辑my.cnf配置文件 启动数据库 修改初始密码,授权远程登录 常见问题 下载 访问以下地址下载对应操作系统下所需的版本 https://downloads.mysql.com/archives/community/ 上传解压 使用ftp或者rz命令上传压缩包到服务器并执行 tar -xvf 压…
阅读更多...
JavaScript手写响应式原理（详解）

JavaScript手写响应式原理（详解）

响应式原理 首先我们有一个对象 const obj {name: zlk,age: 18}这个对象可能在别处被用到 比如是这样的 function foo() {const newValue obj.nameconsole.log(hello world);console.log(obj.name);}我们来改变obj对象中的name的值 obj.name zlk这时候foo()应该被重新执…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023