基于SPI机制隔离业务多种实现方式

 相关文章：

基于若依框架实践（一）：总体的介绍_疯癫的老码农的博客-CSDN博客

基于若依框架实践（二）：通过profile隔离不同环境配置_疯癫的老码农的博客-CSDN博客

基于若依框架实践（三）：通过swagger定义接口_疯癫的老码农的博客-CSDN博客

​

SPI机制

SPI（Service Provider Interface）机制是一种服务发现和注册的机制，它允许服务提供者在注册表中声明它们提供的服务，并允许服务消费者从注册表中检索和连接到这些服务。SPI 是 Java 中的一种设计模式，主要用于解决模块之间的松耦合问题。

SPI机制应用场景

Java SPI 的应用场景如下：

1. 插件架构：通过 SPI，可以将程序的某项功能抽象为一个接口，然后让第三方开发者实现该接口，以插件的形式扩展程序功能。这有助于降低模块间的耦合度，提高代码的可扩展性和可维护性。
2. 驱动加载：SPI 常用于操作系统或硬件驱动程序的加载。通过 SPI，可以在运行时自动发现并加载驱动程序，无需手动指定驱动路径。
3. 功能扩展：SPI 允许开发者轻松地为应用程序添加新功能，而无需修改原有代码。例如，可以将字符编码转换、加密解密等功能实现为 SPI 服务提供者，然后在应用程序中使用 ServiceLoader 加载并使用这些服务。
4. 外部工具集成：通过 SPI，可以将外部工具（如命令行工具、图形界面工具等）集成到应用程序中，使应用程序能够调用这些工具执行特定任务。

SPI机制工作流程

SPI 机制的工作流程如下：

• 服务提供者实现一个接口，该接口定义了服务提供者提供的服务。
• 服务提供者在其内部注册表中注册自己提供的服务。
• 服务消费者从服务提供者的注册表中获取服务提供者的信息。
• 服务消费者根据获取到的服务提供者信息创建一个服务提供者实例。
• 服务消费者使用创建的服务提供者实例获取和实现服务。

这种设计模式使得服务提供者和服务消费者之间解耦，并且可以动态地添加或删除服务提供者，从而提高了系统的灵活性和可扩展性。

SPI实践样例

1、上传服务IFileUpload

/**
 * @author twlight
 * @since V1.0
 */
public interface IFileUpload {

    Object upload(int file);
}

2、上传服务多种方式

minio上传：MinioFileUpload

/**
 * @author twlight
 * @since V1.0
 */
public class MinioFileUpload implements IFileUpload {
    @Override
    public Object upload(int file) {
        System.out.println("MinioFileUpload");
        return null;
    }
}

oss上传：OssFileUpload

/**
 * @author twlight
 * @since V1.0
 */
public class OssFileUpload implements IFileUpload {
    @Override
    public Object upload(int file) {
        System.out.println("OssFileUpload");
        return null;
    }
}

3、配置具体的上传服务

在main/resources/META-INF/services目录下新增文件com.ruoyi.spi.service.upload.IFileUpload

​

com.ruoyi.spi.service.upload.IFileUpload文件内容如下：

com.ruoyi.spi.service.upload.impl.MinioFileUpload
#com.ruoyi.spi.service.upload.impl.OssFileUpload

这里同时一般配置一种实现方式。

4、业务加载传服务

/**
 * @author twlight
 * @since V1.0
 */
@Service
public class FileUploadServiceImpl implements IFileUploadService {

    public Object upload(int file){
        ServiceLoader<IFileUpload> loader = ServiceLoader.load(IFileUpload.class);
        Iterator<IFileUpload> iterator = loader.iterator();
        while (iterator.hasNext()) {
            return iterator.next().upload(file);
        }

        return null;
    }
}

5、业务接口调用上传服务

/**
 * @author twilight
 * @since V1.0
 */
@Api(tags = "spi测试接口")
@RestController
@RequestMapping("/service/spi")
public class SPIController extends BsBaseController
{
    @Autowired
    private FileUploadServiceImpl fuService;
    /**
     * upload
     */
    @ApiOperation(value = "spi测试接口")
    @GetMapping("/upload")
    public TableDataInfo upload()
    {
        fuService.upload(11);
        return getDataTable(new ArrayList<>());
    }
}

6、运行效果

16:03:17.201 [http-nio-8080-exec-2] INFO  o.a.c.c.C.[.[.[/] - [log,173] - Initializing Spring DispatcherServlet 'dispatcherServlet'
MinioFileUpload

项目源码

https://gitee.com/ricky_kai/ruoyi-vue-enhance.git