Java SPI机制详解-01

1. 概述

SPI(Service Provider Interface),是 Java 6 引入了一个内置功能,实现服务提供发现和加载机制,使之与特定接口的匹配。

SPI 机制的核心思想就是 解耦 ,将装配的控制权移到程序之外,这在企业模块化设计中非常重要。

有的人喜欢拿 SPIAPI 之间做比较,关于二者之间的差异主要在于侧重点不一样。

  • API :侧重 调用 并用于实现目标的类、接口、方法等的描述;
  • SPI :侧重对已实现目标类、接口、方法的 扩展和实现

20230808170610

2. 使用场景

调用者根据实际使用需要,启用、扩展、或者替换框架的实现策略。

  • 数据库驱动加载接口实现类的加载: JDBC 加载不同类型数据库的驱动

  • 日志门面接口实现类加载:SLF4J 加载不同提供商的日志实现类

  • Spring 框架:Spring 中大量使用 SPI ,比如:对 Servlet3.0 规范对 ServletContainerInitializer 的实现、自动类型转换 Type Conversion SPI(Converter SPI、Formatter SPI)

3. 入门使用介绍

在实际使用 SPI 需要遵循以下约定:

  • 按照定义创建加载文件:当服务提供者提供了接口的一种具体实现后,在 jar 包的 META-INF/services 目录下创建一个以 接口全限定名为命名的文件,内容为实现类的全限定名;
  • 动态加载:主程序通过 java.util.ServiceLoder 动态装载实现模块,它通过扫描 META-INF/services 目录下的配置文件找到实现类的全限定名,把类加载到 JVM
  • 无参构造方法: SPI实现类必须携带一个不带参数的构造方法;
  • 相同classpath:接口实现类所在的 jar 包放在主程序的 classpath中;

4. 示例

4.1. 构建接口

此处演示作用,只定义一组接口,接口为 灵长类 动物,它包含一个方法, 叫 动作


package io.github.rothschil.spi.framework;/*** 灵长类动物* @author <a href="mailto:WCNGS@QQ.COM">Sam</a>* @version 1.0.0*/
public interface Primate {void action();
}

4.2. 拓展实现

灵长类 这个接口,我们假定它的实现为人类 、猴子,它们都能有属于自己的动物。

  • 人类

package io.github.rothschil.spi.framework.impl;import io.github.rothschil.spi.framework.Primate;public class Human implements Primate {@Overridepublic void action() {System.out.println("Human");}
}
  • 猴子

package io.github.rothschil.spi.framework.impl;import io.github.rothschil.spi.framework.Primate;public class Monkey implements Primate {@Overridepublic void action() {System.out.println("Monkey");}
}

4.3. 构建META-INF下文件

  • 文件路径: resources/META-INF/services
  • 文件名: io.github.rothschil.spi.framework.Primate
  • 文件内容:

io.github.rothschil.spi.framework.impl.Human
io.github.rothschil.spi.framework.impl.Monkey

4.4. 验证

此处用到 ServiceLoader 类加载器,通过 Primate.class 将它的实现以此加载到 JVM 中。

4.5. 结果

验证结果


package io.github.rothschil.spi.framework;import java.util.ServiceLoader;public class TestSpi {public static void main(String[] args) {ServiceLoader<Primate> primates = ServiceLoader.load(Primate.class);for (Primate pr : primates) {pr.action();}}
}

4.5.1. ServiceLoader

ServiceLoader

属性图

ServiceLoader 本身就是一个迭代器,它的属性并不多,我们以 ServiceLoader.load 为入口,一步一步看下去。

  • 调用 ServiceLoader.load 根据当前线程调用类记载器 ClassLoader 利用 ServiceLoader 构造器,创建一个实例。
    • 类加载器
    • 访问控制器
    • 目标类
    • 迭代器
  • ServiceLoader 先判断成员变量 providers 对象中(LinkedHashMap<String,S>类型)是否有缓存实例对象,如果有缓存,直接返回
    • 读取 META-INF/services/ 下的配置文件,获得所有能被实例化的类的名称,值得注意的是, ServiceLoader 可以跨越 jar 包获取 META-INF 下的配置文件
    • 通过反射方法Class.forName()加载类对象,并用instance()方法将类实例化
    • 把实例化后的类缓存到providers对象中,(LinkedHashMap<String,S>类型)然后返回实例对象
public final class ServiceLoader<S>implements Iterable<S>
{private static final String PREFIX = "META-INF/services/";// The class or interface representing the service being loadedprivate final Class<S> service;// The class loader used to locate, load, and instantiate providersprivate final ClassLoader loader;// The access control context taken when the ServiceLoader is createdprivate final AccessControlContext acc;// Cached providers, in instantiation orderprivate LinkedHashMap<String,S> providers = new LinkedHashMap<>();// The current lazy-lookup iteratorprivate LazyIterator lookupIterator;/*** Clear this loader's provider cache so that all providers will be* reloaded.** <p> After invoking this method, subsequent invocations of the {@link* #iterator() iterator} method will lazily look up and instantiate* providers from scratch, just as is done by a newly-created loader.** <p> This method is intended for use in situations in which new providers* can be installed into a running Java virtual machine.*/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();}

5. 总结

这是我们第一篇 SPI 描述,主要引入它的几个概念、用途以及与我们 API 的区别,最后我们通过一个手写的样例,虽然通过 ServiceLoader 加载的,在实际生产环境中,这存在注入线程安全以及不够灵活注入从而导致资源开销大等问题,但是这只为我们 SPI 学习加深理解,算开启正式 SPI 之旅。

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

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

数学符号说明——三角等号(≜)

三角等号 &#xff0c;LaTex语法宏 (\triangleq&#xff09;&#xff0c;Unicode(U225C)&#xff0c;又称 "delta equal to(Δ 等)"。可以读作 "等于"、"根据定义 x 等于 y "。 有时候&#xff0c;用在数学(和物理学)的某种定义中。例如&#…

9.2.1Socket(UDP)

一.传输层: 1.UDP:无连接,不可靠,面向数据报,全双工. 2.TCP:有连接,可靠,面向字节流,全双工. 注意:这里的可不可靠是相对的,并且和安不安全无关. 二.UDP数据报套接字编程: 1.socket文件:表示网卡的这类文件. 2.DatagramPacket:表示一个UDP数据报. 三.代码实现: 1.回显服务…

通过PostMan监视提交文件,验证web文件传输

切换文件流,传输文件 找到图片地址 发送请求然后接受 再来一张 哈&#xff0c;谢谢各位同志的阅读&#xff0c;然后呢如果觉得本文对您有所帮助的话&#xff0c;还给个免费的赞捏 Thanks♪(&#xff65;ω&#xff65;)&#xff89;

Azure Kinect DK + ROS1 Noetic使用教程

作者&#xff1a; Herman Ye Galbot Auromix 版本&#xff1a; V1.0 测试环境&#xff1a; Ubuntu20.04 更新日期&#xff1a; 2023/08/08 注1&#xff1a; 本文内容中的硬件由 Galbot 提供支持。 注2&#xff1a; Auromix 是一个机器人爱好者开源组织。 注3&#xff1a; 本文在…

Java基础入门篇——修饰符

在Java中&#xff0c;修饰符&#xff08;Modifiers&#xff09;是一种用于修改类、方法、变量和其他实体的访问权限、行为或特性的关键字。Java提供了一组修饰符&#xff0c;可以用于实现对代码的封装、继承、多态和访问控制等功能。 1、访问修饰符&#xff08;Access Modifie…

腾讯云轻量应用服务器地域怎么选?上海广州北京?

腾讯云轻量应用服务器地域是指轻量服务器数据中心所在的地理位置&#xff0c;如上海、广州和北京等地域&#xff0c;如何选择地域&#xff1f;地域的选择建议就近原则&#xff0c;用户距离轻量服务器地域越近&#xff0c;网络延迟越低&#xff0c;速度就越快&#xff0c;根据用…

什么是BFC?它有什么作用?如何创建BFC?

聚沙成塔每天进步一点点 ⭐ 专栏简介⭐ 什么是BFC⭐ BFC的作用⭐ 创建BFC的方法⭐ 写在最后 ⭐ 专栏简介 前端入门之旅&#xff1a;探索Web开发的奇妙世界 记得点击上方或者右侧链接订阅本专栏哦 几何带你启航前端之旅 欢迎来到前端入门之旅&#xff01;这个专栏是为那些对Web…

springboot生成表结构和表数据sql

需求 业务背景是需要某单机程序需要把正在进行的任务导出&#xff0c;然后另一台电脑上单机继续运行&#xff0c;我这里选择的方案是同步SQL形式&#xff0c;并保证ID随机&#xff0c;多个数据库不会重复。 实现 package com.nari.web.controller.demo.controller;import cn…

ESP 32 蓝牙虚拟键盘链接笔记本电脑的键值问题

由于打算利用esp32 通过蓝牙链接电脑后实现一些特俗的键盘功能&#xff0c;所以就折腾了一下&#xff0c;折腾最耗费时间的却是键值问题&#xff0c;让一个20多年的老司机重新补充了知识 过程曲折就不说了&#xff0c;直接说结果。 我们通过网络搜索获取的键值和蓝牙模拟键盘传…

数据通信——VRRP

引言 之前把实验做了&#xff0c;结果发现我好像没有写过VRRP的文章&#xff0c;连笔记都没记过。可能是因为对STP的记忆&#xff0c;导致现在都没忘太多。 一&#xff0c;什么是VRRP VRRP全名是虚拟路由冗余协议&#xff0c;虚拟路由&#xff0c;看名字就知道这是运行在三层接…

【软件测试】Linux环境Ant调用Jmeter脚本并且生成测试报告(详细)

目录&#xff1a;导读 前言一、Python编程入门到精通二、接口自动化项目实战三、Web自动化项目实战四、App自动化项目实战五、一线大厂简历六、测试开发DevOps体系七、常用自动化测试工具八、JMeter性能测试九、总结&#xff08;尾部小惊喜&#xff09; 前言 准备工作 需要在…

mac arm 通过brew搭建 php+nginx+mysql+xdebug

1.安装nginx brew install nginx //安装brew services start nginx //启动2.安装php brew install php7.4 //安装export PATH"/opt/homebrew/opt/php7.4/bin:$PATH" //加入环境变量 export PATH"/opt/homebrew/opt/php7.4/sbin:$PATH"brew serv…