tsai
/
abp-next-admin2
mirror of https://github.com/colinin/abp-next-admin.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
这是基于vue-vben-admin 模板适用于abp vNext的前端管理项目
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2888 Commits
72 Branches
54 Tags
77 MiB
 
 
 
 
 
 
Tree: ac7a940a9e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ac7a940a9e'
${ noResults }
abp-next-admin2/docs/wiki/扩展开发/插件开发/插件通信协议/发布订阅模式.md

14 KiB
Raw Blame History

发布订阅模式

**本文档中引用的文件** - [CAPDistributedEventBus.cs](file://aspnet-core/framework/common/LINGYUN.Abp.EventBus.CAP/LINGYUN/Abp/EventBus/CAP/CAPDistributedEventBus.cs) - [AbpCAPConsumerServiceSelector.cs](file://aspnet-core/framework/common/LINGYUN.Abp.EventBus.CAP/LINGYUN/Abp/EventBus/CAP/AbpCAPConsumerServiceSelector.cs) - [CustomDistributedEventSubscriber.cs](file://aspnet-core/framework/common/LINGYUN.Abp.EventBus.CAP/LINGYUN/Abp/EventBus/CAP/CustomDistributedEventSubscriber.cs) - [AbpCAPHeaders.cs](file://aspnet-core/framework/common/LINGYUN.Abp.EventBus.CAP/LINGYUN/Abp/EventBus/CAP/AbpCAPHeaders.cs) - [DefaultDaprClientFactory.cs](file://aspnet-core/framework/dapr/LINGYUN.Abp.Dapr/Dapr/Client/DefaultDaprClientFactory.cs) - [ChatMessageEventHandler.cs](file://aspnet-core/services/LY.AIO.Applications.Single/EventBus/Distributed/ChatMessageEventHandler.cs) - [README.md](file://aspnet-core/modules/webhooks/LINGYUN.Abp.WebhooksManagement.Dapr.Client/README.md)

目录

  1. 简介
  2. 项目结构概览
  3. 核心组件分析
  4. 架构概览
  5. 详细组件分析
  6. 依赖关系分析
  7. 性能考虑
  8. 故障排除指南
  9. 结论

简介

本文档详细介绍了ABP Next Admin框架中实现的发布订阅模式，重点比较了Dapr发布订阅和CAP事件总线两种不同的实现方式。该系统采用了事件驱动架构，支持分布式事件处理、消息路由、主题订阅等高级功能。

发布订阅模式是一种广泛使用的软件设计模式，它允许应用程序组件之间进行松耦合的通信。在ABP Next Admin框架中，这种模式被用于实现微服务之间的解耦通信，支持多种消息传输协议和事件处理策略。

项目结构概览

ABP Next Admin项目采用模块化架构，发布订阅功能主要分布在以下模块中：

graph TB
subgraph "框架层"
EventBusCAP[EventBus.CAP]
Dapr[Dapr模块]
end
subgraph "业务模块"
Webhooks[Webhooks管理]
Identity[身份认证]
Notifications[通知服务]
RealtimeMessage[实时消息]
end
subgraph "基础设施"
EventBus[事件总线]
MessageQueue[消息队列]
DaprSidecar[Dapr边车]
end
EventBusCAP --> EventBus
Dapr --> DaprSidecar
Webhooks --> EventBus
Identity --> EventBus
Notifications --> EventBus
RealtimeMessage --> EventBus

图表来源

  • CAPDistributedEventBus.cs
  • DefaultDaprClientFactory.cs

章节来源

  • CAPDistributedEventBus.cs
  • DefaultDaprClientFactory.cs

核心组件分析

CAP分布式事件总线

CAP（Cloud Events Application Protocol）是一个轻量级的消息中间件，专门用于处理分布式系统中的事件发布和订阅。

classDiagram
class CAPDistributedEventBus {
+ICapPublisher CapPublisher
+ICustomDistributedEventSubscriber CustomDistributedEventSubscriber
+ConcurrentDictionary~Type,IEventHandlerFactory[]~ HandlerFactories
+ConcurrentDictionary~string,Type~ EventTypes
+PublishToEventBusAsync(Type, object) Task
+PublishToCapAsync(string, object, Guid?, string) Task
+ProcessFromInboxAsync(IncomingEventInfo, InboxConfig) Task
}
class ICapPublisher {
<<interface>>
+PublishAsync(string, object, Dictionary~string,string~, CancellationToken) Task
}
class ICustomDistributedEventSubscriber {
<<interface>>
+Subscribe(Type, IEventHandlerFactory) void
+UnSubscribe(Type, IEventHandlerFactory) void
}
class AbpCAPConsumerServiceSelector {
+CapOptions CapOptions
+FindConsumersFromInterfaceTypes(IServiceProvider) IEnumerable~ConsumerExecutorDescriptor~
+GetHandlerDescription(Type, Type) IEnumerable~ConsumerExecutorDescriptor~
}
CAPDistributedEventBus --> ICapPublisher
CAPDistributedEventBus --> ICustomDistributedEventSubscriber
AbpCAPConsumerServiceSelector --> ICapPublisher

图表来源

  • CAPDistributedEventBus.cs
  • AbpCAPConsumerServiceSelector.cs

Dapr客户端工厂

Dapr提供了强大的服务调用和发布订阅功能，通过统一的API接口简化了微服务间的通信。

classDiagram
class DefaultDaprClientFactory {
+ConcurrentDictionary~string,Lazy~DaprClient~~ _daprClients
+ConcurrentDictionary~string,JsonSerializerOptions~ _jsonSerializerOptions
+CreateClient(string) DaprClient
+InternalCreateDaprClient(string) DaprClient
+CreateJsonSerializerOptions(string) JsonSerializerOptions
}
class DaprClientFactoryOptions {
+string DaprApiToken
+string HttpEndpoint
+string GrpcEndpoint
+GrpcChannelOptions GrpcChannelOptions
+JsonSerializerOptions JsonSerializerOptions
+Action[]DaprClient~~ DaprClientActions
+Action[]DaprClientBuilder~~ DaprClientBuilderActions
}
class IDaprClientFactory {
<<interface>>
+CreateClient(string) DaprClient
}
DefaultDaprClientFactory --> IDaprClientFactory
DefaultDaprClientFactory --> DaprClientFactoryOptions

图表来源

  • DefaultDaprClientFactory.cs

章节来源

  • CAPDistributedEventBus.cs
  • DefaultDaprClientFactory.cs

架构概览

ABP Next Admin的发布订阅架构采用了混合模式，同时支持CAP和Dapr两种不同的实现：

graph TB
subgraph "应用层"
App[业务应用]
EventHandler[事件处理器]
end
subgraph "事件总线层"
LocalBus[本地事件总线]
DistributedBus[分布式事件总线]
end
subgraph "消息传输层"
CAP[CAP事件总线]
Dapr[Dapr服务调用]
MQ[消息队列]
end
subgraph "传输协议层"
HTTP[HTTP/HTTPS]
GRPC[gRPC]
TCP[TCP]
end
App --> LocalBus
App --> DistributedBus
LocalBus --> EventHandler
DistributedBus --> CAP
DistributedBus --> Dapr
CAP --> MQ
Dapr --> HTTP
Dapr --> GRPC
MQ --> TCP

图表来源

  • CAPDistributedEventBus.cs
  • DefaultDaprClientFactory.cs

详细组件分析

事件发布流程

事件发布是发布订阅模式的核心功能之一，以下是CAP事件总线的发布流程：

sequenceDiagram
participant App as 应用程序
participant EventBus as 分布式事件总线
participant CAP as CAP发布器
participant Queue as 消息队列
participant Subscriber as 事件订阅者
App->>EventBus : PublishAsync(eventData)
EventBus->>EventBus : EventNameAttribute.GetNameOrDefault()
EventBus->>EventBus : PublishToCapAsync()
EventBus->>CAP : PublishAsync(eventName, eventData, headers)
CAP->>Queue : 存储消息
Queue->>Subscriber : 推送消息
Subscriber->>Subscriber : 处理事件

图表来源

  • CAPDistributedEventBus.cs

事件订阅机制

事件订阅通过自定义的事件订阅者实现，支持动态订阅和取消订阅：

flowchart TD
Start([开始订阅]) --> CheckType{检查事件类型}
CheckType --> |有效| RegisterHandler[注册事件处理器]
CheckType --> |无效| ReturnError[返回错误]
RegisterHandler --> SetTopic[设置主题属性]
SetTopic --> AddToRegistry[添加到注册表]
AddToRegistry --> StartListening[开始监听消息]
StartListening --> End([订阅完成])
ReturnError --> End

图表来源

  • CustomDistributedEventSubscriber.cs

Dapr服务调用

Dapr提供了统一的服务调用接口，简化了微服务间的通信：

sequenceDiagram
participant Client as 客户端应用
participant Factory as Dapr客户端工厂
participant Builder as Dapr客户端构建器
participant Sidecar as Dapr边车
participant Service as 目标服务
Client->>Factory : CreateClient(appId)
Factory->>Factory : GetOrAdd(client)
Factory->>Builder : Build()
Builder->>Sidecar : 配置连接
Client->>Sidecar : InvokeMethodAsync()
Sidecar->>Service : 转发请求
Service-->>Sidecar : 返回响应
Sidecar-->>Client : 返回结果

图表来源

  • DefaultDaprClientFactory.cs

章节来源

  • CAPDistributedEventBus.cs
  • CustomDistributedEventSubscriber.cs
  • DefaultDaprClientFactory.cs

主题定义和消息格式

系统支持灵活的主题定义和消息格式配置：

classDiagram
class AbpCAPHeaders {
+string ClientId
+string UserId
+string TenantId
+string MessageId
+string CorrelationId
}
class TopicAttribute {
+string Name
+string Group
+bool EnableGroup
+int Concurrency
}
class EventNameAttribute {
+string Name
+GetNameOrDefault(Type) string
}
AbpCAPHeaders --> TopicAttribute : "消息头"
EventNameAttribute --> TopicAttribute : "事件名称"

图表来源

  • AbpCAPHeaders.cs

消息序列化和内容类型处理

系统支持多种消息序列化方式和内容类型：

flowchart LR
Message[原始消息] --> Serializer[JSON序列化器]
Serializer --> Headers[消息头处理]
Headers --> Transport[传输协议]
Transport --> Deserializer[反序列化器]
Deserializer --> Handler[事件处理器]
subgraph "序列化选项"
JSON[JSON序列化]
Binary[二进制序列化]
Protobuf[Protobuf序列化]
end
Serializer --> JSON
Serializer --> Binary
Serializer --> Protobuf

章节来源

  • CAPDistributedEventBus.cs
  • AbpCAPHeaders.cs

依赖关系分析

系统的依赖关系展现了清晰的分层架构：

graph TB
subgraph "外部依赖"
CAP[DotNetCore.CAP]
DaprClient[Dapr.Client]
ABP[ABP框架]
end
subgraph "内部模块"
EventBusCAP[EventBus.CAP]
DaprModule[Dapr模块]
CommonModule[通用模块]
end
subgraph "业务模块"
WebhooksModule[Webhooks模块]
IdentityModule[身份模块]
NotificationModule[通知模块]
end
EventBusCAP --> CAP
EventBusCAP --> ABP
DaprModule --> DaprClient
DaprModule --> ABP
WebhooksModule --> EventBusCAP
WebhooksModule --> DaprModule
IdentityModule --> EventBusCAP
NotificationModule --> EventBusCAP

图表来源

  • CAPDistributedEventBus.cs
  • DefaultDaprClientFactory.cs

章节来源

  • CAPDistributedEventBus.cs
  • DefaultDaprClientFactory.cs

性能考虑

消息处理优化

系统采用了多种性能优化策略：

  1. 并发处理：支持多线程并发处理事件
  2. 批量处理：支持批量发布和处理消息
  3. 缓存机制：缓存事件处理器和主题信息
  4. 连接池：复用Dapr客户端连接

QoS保证

系统提供了多种服务质量保证机制：

  • 消息持久化：确保消息不会丢失
  • 重试机制：自动重试失败的处理
  • 死信队列：处理无法正常处理的消息
  • 监控告警：实时监控消息处理状态

故障排除指南

常见问题和解决方案

  1. 事件订阅失败

    • 检查事件处理器是否正确注册
    • 验证主题名称是否匹配
    • 确认网络连接是否正常

  2. 消息重复发送

    • 检查消息ID去重机制
    • 验证事务处理逻辑
    • 查看重试配置

  3. 性能问题

    • 监控消息处理延迟
    • 优化事件处理器实现
    • 调整并发度配置

章节来源

  • CAPDistributedEventBus.cs

结论

ABP Next Admin框架中的发布订阅模式实现了高度灵活和可扩展的事件驱动架构。通过同时支持CAP和Dapr两种不同的实现方式，系统能够适应不同的应用场景和技术需求。

主要优势

  1. 灵活性：支持多种消息传输协议和事件处理策略
  2. 可扩展性：模块化设计便于功能扩展
  3. 可靠性：提供完善的错误处理和恢复机制
  4. 性能：优化的并发处理和缓存机制

最佳实践建议

  1. 合理选择传输协议：根据具体需求选择CAP或Dapr
  2. 优化事件设计：保持事件的简洁性和稳定性
  3. 监控和调试：建立完善的监控体系
  4. 安全考虑：确保消息传输的安全性

通过深入理解这些组件和架构设计，开发者可以更好地利用发布订阅模式构建高性能、高可靠性的分布式系统。