Java SPI机制实战详解及源码分析

简介: Java SPI机制实战详解及源码分析

背景介绍

提起SPI机制,可能很多人不太熟悉,它是由JDK直接提供的,全称为:Service Provider Interface。而在平时的使用过程中也很少遇到,但如果你阅读一些框架的源码时,会发现它的有点无处不在的感觉。比如我们经常使用的spring框架,其spring-web包下就在使用该机制。



image.png还有我们每个项目都离不开的日志框架log4j和数据库驱动框架中也同样的使用着SPI机制。image.pngimage.png这么看来,SPI机制可谓无处不在,那么今天这篇文章就带大家揭开它的神秘面纱。


什么是SPI机制

SPI机制,全称 Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的API,可以用来启用框架扩展和替换组件,它的核心类是java.util.ServiceLoader。


在大型系统设计中,开闭原则和解耦是必不可少的,而SPI机制的核心便是解耦合。通过SPI机制,将实现类隐藏在接口后面,根据需要寻找服务实现,SPI就提供了这样的服务发现机制。


Effective Java中也提到SPI是一种将服务接口与服务实现分离以达到解耦、大大提升了程序可扩展性的机制。引入服务提供者就是引入了SPI接口的实现者,通过本地的注册发现获取到具体的实现类,轻松可插拔。


image.png使用场景

在最开始的背景介绍中,我们已经在不同的框架中发现SPI的身影。可以说在针对“调用者根据实际需要,使用不同框架的实现策略”中非常有用。


比如,我们日常使用是数据库驱动,会提供统一的规范(java.sql.Driver),各数据库服务商提供对应数据库的逻辑实现。当使用到该数据库时,直接引入不同的SPI服务实现即可。


常见场景:


Spring框架中有大量实现,如上图中Spring对servlet3.0规范的ServletContainerInitializer的实现。

数据库驱动程序加载不同数据库的实现,如上图中java.sql.Driver接口的实现。

日志框架log4j中的实现。

Dubbo中实现框架扩展的实现。

使用规范

下面了解一下使用SPI的基本规范步骤:


服务提供者定义对外接口及方法,比如数据库驱动会提供一个java.sql.Driver的接口。

针对定义的接口,提供一个实现类。

在项目或jar包的META-INF/services目录下,创建一个文本文件:名称为接口的“全限定名”,内容为实现类的全限定名。上面的截图中其实已经可以发现,统一都是如此。

服务调用者引入该项目的jar包,并将其放置于classpath下。

服务调用者通过核心API java.util.ServiceLoader来动态加载该实现,主要就是扫描classpath下所有jar包内META-INF/services目录下,按照指定格式定义的文件,并把其中类进行加载。

由于SPI机制使用的过程中无法进行传递构造参数,因此需提供一个无参的构造方法。

具体实例

下面以订阅公众号为例,来演示SPI机制的使用。为了方便起见,服务使用者和服务提供者放在了同一个项目内,正常来说,服务提供者单独定义接口及实现,然后通过jar包的形式引入到服务调用者项目中。


首先,创建项目,定义接口Subscribe,并提供一个follow方法。


public interface Subscribe {

void follow();

}


然后,定义两个实现类:MySubscribe和OtherSubscribe。

public class MySubscribe implements Subscribe {
  @Override
  public void follow() {
    System.out.println("关注了公众号:程序新视界!");
  }
}
public class OtherSubscribe implements Subscribe {
  @Override
  public void follow() {
    System.out.println("关注了其他公众号!");
  }
}

然后,在resources目录下依次创建META-INF/services目录,并在目录下创建名称为:com.secbro2.Subscribe的文件。文件内容为:


com.secbro2.impl.MySubscribe

com.secbro2.impl.OtherSubscribe


最后,编写main方法进行调用,main方法相当于SPI机制中的调用者。


public class Call {
  public static void main(String[] args) {
    ServiceLoader<Subscribe> services = ServiceLoader.load(Subscribe.class);
    for (Subscribe sub : services) {
      sub.follow();
    }
  }
}

执行main方法,打印如下内容:


关注了公众号:程序新视界!

关注了其他公众号!


ServiceLoader源码解析

顺便我们看一下ServiceLoader的源码信息,首先通过常量的定义,我们可以看到为什么要将文件配置在META-INF/services下了。


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

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

}


整个类的源码就不全部贴出了,简单介绍一下该类的基本操作流程。


通过ServiceLoader的load(Class<S> service)方法进入程序内部;

上面load方法内获得到ClassLoader,并再此调用内部的load(Class<S> service,lassLoader loader)方法,该方法内会创建ServiceLoader对象,并初始化一些常量。

ServiceLoader的构造方法内会调用reload方法,来清理缓存,初始化LazyIterator,注意此处是Lazy,也就懒加载。此时并不会去加载文件下的内容。

当遍历器被遍历时,才会去读取配置文件。

关于读取META-INF/services下配置文件的核心代码如下:


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

同过以上代码我们会发现,其实ServiceLoader扫描了所有jar包下的配置文件。然后通过解析全限定名获得,并在遍历时通过Class.forName进行实例化。


小结

经过上面的讲解和示例,大家已经了解整个SPI机制的使用,但SPI机制并不是万能的,它也有自身的缺点。比如,虽然它采用了懒加载,在真正遍历使用的时候才会去加载类,但每次基本上都是将全部的类遍历一遍并进行实例化,这也造成了不必要的浪费。另外,它是非线程安全的。


目录
相关文章
|
6月前
|
安全 Java 开发者
告别NullPointerException:Java Optional实战指南
告别NullPointerException:Java Optional实战指南
329 119
|
8月前
|
Java 关系型数据库 数据库
Java 项目实战教程从基础到进阶实战案例分析详解
本文介绍了多个Java项目实战案例,涵盖企业级管理系统、电商平台、在线书店及新手小项目,结合Spring Boot、Spring Cloud、MyBatis等主流技术,通过实际应用场景帮助开发者掌握Java项目开发的核心技能,适合从基础到进阶的学习与实践。
1161 3
|
8月前
|
Java API Maven
2025 Java 零基础到实战最新技术实操全攻略与学习指南
本教程涵盖Java从零基础到实战的全流程,基于2025年最新技术栈,包括JDK 21、IntelliJ IDEA 2025.1、Spring Boot 3.x、Maven 4及Docker容器化部署,帮助开发者快速掌握现代Java开发技能。
1574 1
|
7月前
|
存储 前端开发 Java
【JAVA】Java 项目实战之 Java Web 在线商城项目开发实战指南
本文介绍基于Java Web的在线商城技术方案与实现,涵盖三层架构设计、MySQL数据库建模及核心功能开发。通过Spring MVC + MyBatis + Thymeleaf实现商品展示、购物车等模块,提供完整代码示例,助力掌握Java Web项目实战技能。(238字)
827 0
|
7月前
|
Java 开发者
Java并发编程:CountDownLatch实战解析
Java并发编程:CountDownLatch实战解析
561 100
|
8月前
|
数据采集 JSON Java
Java爬虫获取1688店铺所有商品接口数据实战指南
本文介绍如何使用Java爬虫技术高效获取1688店铺商品信息,涵盖环境搭建、API调用、签名生成及数据抓取全流程,并附完整代码示例,助力市场分析与选品决策。
|
7月前
|
人工智能 Java API
Java AI智能体实战:使用LangChain4j构建能使用工具的AI助手
随着AI技术的发展,AI智能体(Agent)能够通过使用工具来执行复杂任务,从而大幅扩展其能力边界。本文介绍如何在Java中使用LangChain4j框架构建一个能够使用外部工具的AI智能体。我们将通过一个具体示例——一个能获取天气信息和执行数学计算的AI助手,详细讲解如何定义工具、创建智能体并处理执行流程。本文包含完整的代码示例和架构说明,帮助Java开发者快速上手AI智能体的开发。
2711 8
|
7月前
|
人工智能 Java API
Java与大模型集成实战:构建智能Java应用的新范式
随着大型语言模型(LLM)的API化,将其强大的自然语言处理能力集成到现有Java应用中已成为提升应用智能水平的关键路径。本文旨在为Java开发者提供一份实用的集成指南。我们将深入探讨如何使用Spring Boot 3框架,通过HTTP客户端与OpenAI GPT(或兼容API)进行高效、安全的交互。内容涵盖项目依赖配置、异步非阻塞的API调用、请求与响应的结构化处理、异常管理以及一些面向生产环境的最佳实践,并附带完整的代码示例,助您快速将AI能力融入Java生态。
1160 12
|
6月前
|
存储 人工智能 算法
从零掌握贪心算法Java版:LeetCode 10题实战解析(上)
在算法世界里,有一种思想如同生活中的"见好就收"——每次做出当前看来最优的选择,寄希望于通过局部最优达成全局最优。这种思想就是贪心算法,它以其简洁高效的特点,成为解决最优问题的利器。今天我们就来系统学习贪心算法的核心思想,并通过10道LeetCode经典题目实战演练,带你掌握这种"步步为营"的解题思维。
|
8月前
|
算法 Java 开发者
Java流程控制:条件与循环结构实战
本文深入讲解编程中的流程控制结构,涵盖条件语句(if-else、switch)、循环结构(for、while、do-while)及循环控制关键字(break、continue)的使用技巧与实战案例,帮助开发者写出更清晰、高效的代码。