利用Java SPI机制实现可插拔的应用插件

2024-02-24 07:20
文章标签 java 实现 应用 插件 机制 spi 插拔

本文主要是介绍利用Java SPI机制实现可插拔的应用插件，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

自己搭建了个小博客，本文与这篇文章同步：

利用Java SPI机制实现可插拔的应用插件

什么是spi

Java SPI（Service Provider Interface）机制是 Java 提供的一种用于实现组件化、可插拔式架构的机制。通过 SPI，Java 应用程序可以在运行时动态地加载和实例化服务实现类，而无需在编译时将其硬编码到应用程序中。
SPI 机制的核心概念是服务提供者、服务接口和服务配置文件：
1.服务接口：定义了一组服务的接口或抽象类，表示一种功能或约定。
2.服务提供者：实现了服务接口的具体类。这些类可能由不同的供应商提供，用户可以根据需求选择其中一个或多个。
3.服务配置文件：在资源目录 META-INF/services 下，以服务接口的全限定名为文件名，内容是实现该服务接口的具体类的全限定名列表。这个文件告诉了 Java 运行时哪些类提供了特定的服务。

如何使用Spi

SPI 机制的使用步骤通常包括以下几个步骤：
1.定义服务接口：定义服务接口，明确服务的功能和约定。
2.实现服务提供者：编写实现服务接口的具体类，可以有多个不同的实现。
3.创建服务配置文件：在 META-INF/services 目录下创建以服务接口全限定名命名的文件，文件内容为提供该服务的实现类的全限定名列表。
4.获取服务实现：使用 ServiceLoader 类加载并获取服务接口的具体实现。

使用步骤示例

pom.xml

<dependency><groupId>com.google.auto.service</groupId><artifactId>auto-service</artifactId><version>1.0.1</version><scope>provided</scope>
</dependency>

引入auto-service是因为Google 的 AutoService 库提供的一个注解：@AutoService，它的类全限定名com.google.auto.service.AutoService，它可以帮助开发者自动生成 SPI 配置文件，而不需要手动创建 META-INF/services/ 文件夹和配置文件。这个库会在编译时扫描带有 @AutoService 注解的类，并自动将其注册到 SPI 服务配置文件中。

定义服务接口

DataSourceProcessor

package com.wizard.aquarius.spi;/*** @author zhaoyijie* @since 2024/2/22 17:51*/
public interface DataSourceProcessor {/*** get datasource Driver*/String getDatasourceDriver();}
实现服务提供者

MySQLDataSourceProcessor

package com.wizard.aquarius.spi;import com.google.auto.service.AutoService;/*** @author zhaoyijie* @since 2024/2/22 17:52*/
@AutoService(DataSourceProcessor.class)
public class MySQLDataSourceProcessor implements DataSourceProcessor {@Overridepublic String getDatasourceDriver() {return "com.mysql.cj.jdbc.Driver";}
}

PostgreSQLDataSourceProcessor

package com.wizard.aquarius.spi;import com.google.auto.service.AutoService;/*** @author zhaoyijie* @since 2024/2/22 17:57*/
@AutoService(DataSourceProcessor.class)
public class PostgreSQLDataSourceProcessor implements DataSourceProcessor{@Overridepublic String getDatasourceDriver() {return "org.postgresql.Driver";}}
获取服务实现
package com.wizard.aquarius.spi;import java.util.ServiceLoader;/*** @author zhaoyijie* @since 2024/2/22 17:50*/
public class SPITest {public static void main(String[] args) {ServiceLoader.load(DataSourceProcessor.class).forEach(factory -> {String datasourceDriver = factory.getDatasourceDriver();System.out.println(datasourceDriver);});}
}

运行结果

com.mysql.cj.jdbc.Driver
org.postgresql.Driver

查看编译后的文件夹

zhaoyijie@zhaoyijiedeMacBook-Pro classes % tree
.
├── META-INF
│   └── services
│       └── com.wizard.aquarius.spi.DataSourceProcessor
└── com└── wizard└── aquarius├── spi├── DataSourceProcessor.class├── MySQLDataSourceProcessor.class├── PostgreSQLDataSourceProcessor.class└── SPITest.class

查看com.wizard.aquarius.spi.DataSourceProcessor文件内容

com.wizard.aquarius.spi.MySQLDataSourceProcessor
com.wizard.aquarius.spi.PostgreSQLDataSourceProcessor

这里验证了文件内容为提供该服务的实现类的全限定名列表。

开源项目中哪些应用使用SPI

1.Apache Hadoop
：Hadoop 中的文件系统抽象层 org.apache.hadoop.fs.FileSystem 就是一个经典的 SPI 示例。不同的文件系统（比如 HDFS、本地文件系统、S3 等）都可以实现这个接口，并通过 SPI 机制来动态注册和加载。这种设计使得 Hadoop 可以支持不同的存储后端，实现了高度的可扩展性。

// 使用 ServiceLoader 加载文件系统
ServiceLoader<FileSystem> fileSystems = ServiceLoader.load(FileSystem.class);
for (FileSystem fs : fileSystems) {
// 使用加载到的文件系统
// ...
}

2.Apache HBase
：HBase 是一个分布式、面向列的 NoSQL 数据库。它的存储引擎是可插拔式的，不同的存储引擎（比如 HDFS、本地文件系统、RockDB 等）都可以通过实现 org.apache.hadoop.hbase.regionserver.wal.WALProvider 接口来集成到 HBase 中。
3.Apache Kafka
：Kafka 是一个分布式流处理平台，用于发布和订阅消息流。Kafka 中的消息存储实现了 SPI 机制，不同的存储后端（比如日志文件、Kafka Connect、Kafka Streams）都可以通过实现 org.apache.kafka.common.record.MemoryRecords.MemoryRecordsBuilder 接口来实现自定义的消息存储逻辑。
4.Apache Dubbo
：Dubbo 是一款高性能的分布式服务框架。在 Dubbo 中，SPI 机制被广泛应用于扩展点的加载和扩展，比如注册中心的实现、协议的扩展、负载均衡的策略等，所有这些都可以通过实现对应的 SPI 接口来进行扩展和定制。
以下是 Dubbo 中的一个示例，展示了如何加载并使用扩展点：

// 加载并使用扩展点
ExtensionLoader<RegistryFactory> loader = ExtensionLoader.getExtensionLoader(RegistryFactory.class);
RegistryFactory registryFactory = loader.getExtension("zookeeper");
Registry registry = registryFactory.getRegistry(new URL("zookeeper://localhost:2181"));

5.Apache Maven
：Maven 是一个项目管理和构建工具。它也使用了 SPI 机制，比如插件机制、生命周期扩展点等都是通过 SPI 实现的。Maven 核心提供了一系列 SPI 接口，而插件开发者可以通过实现这些接口来扩展 Maven 的功能。
这些只是开源项目中 SPI 应用的一部分示例。SPI 机制的松耦合、可插拔性强、易于扩展等优点，使得应用程序更加灵活和可维护。

这篇关于利用Java SPI机制实现可插拔的应用插件的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/741362。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
中文分词jieba库的使用与实景应用（一）

中文分词jieba库的使用与实景应用（一）

知识星球：https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义： 精确模式（默认模式）： 全模式： 搜索引擎模式： paddle 模式（基于深度学习的分词模式）： 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取
阅读更多...
水位雨量在线监测系统概述及应用介绍

水位雨量在线监测系统概述及应用介绍

在当今社会，随着科技的飞速发展，各种智能监测系统已成为保障公共安全、促进资源管理和环境保护的重要工具。其中，水位雨量在线监测系统作为自然灾害预警、水资源管理及水利工程运行的关键技术，其重要性不言而喻。 一、水位雨量在线监测系统的基本原理 水位雨量在线监测系统主要由数据采集单元、数据传输网络、数据处理中心及用户终端四大部分构成，形成了一个完整的闭环系统。 数据采集单元：这是系统的“眼睛”，
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2