Delphi Event Bus (DEB) 使用教程

1. 项目介绍

Delphi Event Bus (DEB) 是一个为 Delphi 平台设计的发布/订阅事件总线框架。DEB 旨在解耦应用程序的不同部分/层，同时仍然允许它们高效地通信。该框架受到 Android 平台 EventBus 框架的启发，具有以下特点：

• 易于学习和使用：DEB 遵循 KISS（保持简单，愚蠢）和“约定优于配置”的设计原则，使用默认的 TEventBus 实例即可立即开始发送和接收事件。
• 解耦设计：DEB 设计用于解耦应用程序的不同部分/层。
• 事件驱动：支持基于属性的 API，只需在订阅者方法上添加 Subscribe 属性即可接收特定事件。
• 多线程支持：支持不同的交付模式，可以选择在主线程或后台线程中交付事件，无论事件从何处发布，EventBus 都会管理线程同步。
• 单元测试和线程安全：DEB 经过单元测试，确保线程安全。

2. 项目快速启动

2.1 安装 DEB

首先，克隆 DEB 项目到本地：

git clone https://github.com/spinettaro/delphi-event-bus.git

2.2 定义事件

定义一个事件接口：

IEvent = interface(IInterface)
  ['{3522E1C5-547F-4AB6-A799-5B3D3574D2FA}']
  // 可以在这里添加额外信息
end;

2.3 准备订阅者

声明订阅方法并注册订阅者：

type
  TMySubscriber = class
  public
    [Subscribe]
    procedure OnEvent(AEvent: IAnyTypeOfEvent);
  end;

procedure TMySubscriber.OnEvent(AEvent: IAnyTypeOfEvent);
begin
  // 处理事件
end;

var
  Subscriber: TMySubscriber;
begin
  Subscriber := TMySubscriber.Create;
  GlobalEventBus.RegisterSubscriberForEvents(Subscriber);
end;

2.4 发布事件

发布事件到事件总线：

var
  LEvent: IAnyTypeOfEvent;
begin
  LEvent := TMyEvent.Create;
  GlobalEventBus.Post(LEvent);
end;

3. 应用案例和最佳实践

3.1 应用案例

DEB 适用于需要解耦不同模块的应用程序，例如：

• 多层架构：在多层架构中，DEB 可以帮助解耦 UI 层、业务逻辑层和数据访问层。
• 事件驱动系统：在事件驱动的系统中，DEB 可以用于处理各种异步事件。

3.2 最佳实践

• 事件命名规范：建议为事件定义清晰的命名规范，以便于管理和维护。
• 线程模式选择：根据事件的性质选择合适的线程模式（主线程或后台线程）。
• 单元测试：确保对订阅者和发布者进行充分的单元测试，以验证事件处理的正确性。

4. 典型生态项目

DEB 可以与其他 Delphi 生态项目结合使用，例如：

• FireMonkey：DEB 可以与 FireMonkey 框架结合，用于跨平台应用程序的事件管理。
• VCL：DEB 同样适用于 VCL 应用程序，帮助解耦不同组件之间的通信。
• Spring4D：DEB 可以与 Spring4D 框架结合，提供更强大的依赖注入和事件管理功能。

通过以上模块的介绍和示例，您可以快速上手并应用 Delphi Event Bus (DEB) 框架。