利用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 {

    @Override
    public 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{

    @Override
    public 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 机制的松耦合、可插拔性强、易于扩展等优点，使得应用程序更加灵活和可维护。