基于插件机制、SPI与事件驱动的系统设计

时间：2024年08月26日

作者：小蒋聊技术

邮箱：wei_wei10@163.com

微信：wei_wei10

音频地址:https://xima.tv/1_F4V6FW?_sonic=0

希望大家帮个忙！如果大家有工作机会，希望帮小蒋内推一下，小蒋希望遇到一个认真做事的团队，一起努力。需要简历可以加我微信。

大家好，欢迎来到小蒋聊技术，小蒋准备和大家一起聊聊技术的那些事。

今天小蒋准备和大家一起聊的这个技术就厉害了！那就是可扩展的系统架构设计。

要解决的问题是：在标准产品以二进制方式发布、不提供源码的前提下，如何设计产品，使得标准功能与个性化定制能够协作？

本方案旨在设计一个标准产品，使其以二进制方式发布，并能够有效与个性化定制功能协作。方案中将详细介绍事件驱动机制，结合插件机制和SPI，实现标准功能与定制功能的解耦与协作。

1. 设计目标

隔离性：标准产品与定制功能相互隔离，标准产品以二进制形式发布，不提供源码，确保核心产品的安全性和稳定性。
扩展性：通过定义扩展点（如接口、事件等），允许定制模块在不修改标准产品代码的情况下，灵活扩展系统功能。
协作性：标准产品与定制模块之间能够顺畅协作，通过统一的接口和事件机制实现功能的定制和扩展。

2. 核心设计思路

模块化设计：标准产品和定制模块作为独立的模块开发，通过接口和事件机制进行交互，避免相互依赖。
插件机制与SPI：标准产品通过SPI机制提供扩展点，定制模块可以实现这些扩展点并在运行时动态加载。
事件驱动机制：标准产品在关键操作完成后发布事件，定制模块可以监听这些事件并执行相应的定制逻辑。

3. 标准产品设计

3.1 接口定义

标准产品通过接口（API）定义核心功能，这些接口是标准产品与定制功能的契约。定制模块通过实现这些接口来扩展或替换标准功能。

public interface PaymentService {

    PaymentResult processPayment(PaymentRequest request);

}

3.2 默认实现

标准产品提供接口的默认实现，但不会暴露源码。默认实现通过SPI机制加载，允许在运行时被定制模块替换或扩展。

public class DefaultPaymentService implements PaymentService {

    @Override

    public PaymentResult processPayment(PaymentRequest request) {

        // 执行标准的核心支付逻辑

        return new PaymentResult("SUCCESS");

    }

}

在 META-INF/services/com.example.PaymentService 文件中配置默认实现：

com.example.impl.DefaultPaymentService

4. 定制模块设计

定制模块通过实现标准产品的接口，可以在不修改标准产品代码的前提下插入自定义逻辑。定制模块的实现会通过SPI机制动态加载，并可能覆盖标准产品的默认实现。

4.1 定制接口实现

定制模块可以通过实现标准接口，在方法执行前后插入自定义逻辑，同时仍可调用标准产品的核心逻辑。

public class CustomPaymentService implements PaymentService {



    private final PaymentService delegate;



    public CustomPaymentService(PaymentService delegate) {

        this.delegate = delegate;

    }



    @Override

    public PaymentResult processPayment(PaymentRequest request) {

        beforeProcess(request);  // 自定义前置逻辑

        PaymentResult result = delegate.processPayment(request);  // 调用标准方法

        afterProcess(result);  // 自定义后置逻辑

        return result;

    }



    private void beforeProcess(PaymentRequest request) {

        // 自定义前置逻辑，如参数验证、日志记录等

    }



    private void afterProcess(PaymentResult result) {

        // 自定义后置逻辑，如结果处理、通知等

    }

}

在定制模块的 META-INF/services/com.example.PaymentService 文件中配置自定义实现：

com.example.custom.CustomPaymentService

通过这种设计，标准产品的核心逻辑被封装在 delegate.processPayment(request) 中调用。定制模块可以在核心逻辑执行前后加入自定义操作。

5. 事件驱动机制

5.1 事件驱动机制概述

事件驱动机制是一种设计模式，它允许系统在特定事件发生时自动触发和处理相应的业务逻辑。在标准产品中，事件驱动机制用于在操作完成后通知其他模块，从而使定制模块可以监听并处理这些事件。

通过事件驱动机制，标准产品可以发布各种事件（如支付完成、订单生成等），而定制模块可以监听这些事件，并在事件发生时执行自定义逻辑。这种设计模式非常适合异步处理场景，使得系统的各个模块能够松耦合地协作。

5.2 事件发布

标准产品在完成某项操作后发布事件，通知系统中感兴趣的模块。事件类通常封装了操作的结果或状态，继承自 ApplicationEvent。

public class PaymentCompletedEvent extends ApplicationEvent {

    private final PaymentResult result;



    public PaymentCompletedEvent(Object source, PaymentResult result) {

        super(source);

        this.result = result;

    }



    public PaymentResult getResult() {

        return result;

    }

}

在标准产品的核心逻辑中，发布事件来通知系统其他部分。例如，在支付完成后发布 PaymentCompletedEvent 事件：

@Service

public class PaymentService {

    @Autowired

    private ApplicationEventPublisher publisher;



    public PaymentResult processPayment(PaymentRequest request) {

        // 执行核心支付逻辑

        PaymentResult result = new PaymentResult("SUCCESS");



        // 发布支付完成事件

        publisher.publishEvent(new PaymentCompletedEvent(this, result));



        return result;

    }

}

5.3 事件监听

定制模块通过监听这些事件，来执行自定义的业务逻辑。Spring提供了 ApplicationListener 接口和 @EventListener 注解来实现事件监听。

@Component

public class CustomPaymentListener implements ApplicationListener<PaymentCompletedEvent> {

    @Override

    public void onApplicationEvent(PaymentCompletedEvent event) {

        // 在支付完成后执行定制逻辑

        PaymentResult result = event.getResult();

        System.out.println("Custom processing after payment completion: " + result.getStatus());

    }

}

解释：CustomPaymentListener 不会自行执行。它是一个事件监听器，当且仅当 PaymentCompletedEvent 事件被发布时，Spring框架才会自动调用这个监听器的 onApplicationEvent 方法。因此，在 PaymentService 中调用 publisher.publishEvent(new PaymentCompletedEvent(this, result)); 时，CustomPaymentListener 的自定义逻辑才会被触发和执行。

5.4 事件驱动机制的优点

松耦合：事件驱动机制通过发布和监听事件实现模块间的松耦合，定制模块与标准产品无需直接依赖。
异步处理：事件可以异步处理，适用于需要在操作完成后执行的额外逻辑，如通知、日志记录等。
扩展性：通过监听不同的事件，定制模块可以灵活地扩展和插入不同的业务逻辑。

6. 系统协作与整合

模块加载顺序：系统启动时，首先加载标准产品的默认实现，然后通过SPI机制加载定制模块的实现。如果定制模块存在，它将覆盖标准实现，并可以通过调用标准实现来扩展功能。
插件管理：标准产品可以通过配置管理中心（如Nacos）动态管理定制模块的启用与禁用，定制模块作为可选插件动态加载到系统中。
测试与调试：通过单元测试、集成测试和运行时监控，确保标准产品与定制功能的正确协作，特别是要测试事件发布与监听的时序性和可靠性。

7. 优点与局限性

7.1 优点