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.
3165 Commits
72 Branches
54 Tags
77 MiB
 
 
 
 
 
 
Tree: f6e753eaeb
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f6e753eaeb'
${ noResults }
abp-next-admin2/docs/wiki/扩展开发/插件开发/插件通信协议/插件通信协议.md

12 KiB
Raw Blame History

插件通信协议

**本文档引用的文件** - [AbpDaprClientModule.cs](file://aspnet-core/framework/dapr/LINGYUN.Abp.Dapr.Client/LINGYUN/Abp/Dapr/Client/AbpDaprClientModule.cs) - [DynamicDaprClientProxyInterceptor.cs](file://aspnet-core/framework/dapr/LINGYUN.Abp.Dapr.Client/LINGYUN/Abp/Dapr/Client/DynamicProxying/DynamicDaprClientProxyInterceptor.cs) - [AbpCapEventBusModule.cs](file://aspnet-core/framework/common/LINGYUN.Abp.EventBus.CAP/LINGYUN/Abp/EventBus/CAP/AbpCapEventBusModule.cs) - [AbpCAPEventBusOptions.cs](file://aspnet-core/framework/common/LINGYUN.Abp.EventBus.CAP/LINGYUN/Abp/EventBus/CAP/AbpCAPEventBusOptions.cs) - [DynamicDaprActorProxyInterceptor.cs](file://aspnet-core/framework/dapr/LINGYUN.Abp.Dapr.Actors/LINGYUN/Abp/Dapr/Actors/DynamicProxying/DynamicDaprActorProxyInterceptor.cs) - [DaprHttpClientHandler.cs](file://aspnet-core/framework/dapr/LINGYUN.Abp.Dapr.Actors/LINGYUN/Abp/Dapr/Actors/DynamicProxying/DaprHttpClientHandler.cs) - [AbpDaprActorCallException.cs](file://aspnet-core/framework/dapr/LINGYUN.Abp.Dapr.Actors/LINGYUN/Abp/Dapr/Actors/AbpDaprActorCallException.cs) - [AbpDaprModule.cs](file://aspnet-core/framework/dapr/LINGYUN.Abp.Dapr/LINGYUN/Abp/Dapr/AbpDaprModule.cs) - [AbpDaprActorsModule.cs](file://aspnet-core/framework/dapr/LINGYUN.Abp.Dapr.Actors/LINGYUN/Abp/Dapr/Actors/AbpDaprActorsModule.cs) - [AbpDaprClientProxyOptions.cs](file://aspnet-core/framework/dapr/LINGYUN.Abp.Dapr.Client/LINGYUN/Abp/Dapr/Client/ClientProxying/AbpDaprClientProxyOptions.cs) - [DaprRemoteServiceConfigurationExtensions.cs](file://aspnet-core/framework/dapr/LINGYUN.Abp.Dapr.Client/LINGYUN/Abp/Dapr/Client/DaprRemoteServiceConfigurationExtensions.cs)

目录

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

引言

本文档详细说明了ABP Next Admin项目中插件间的通信机制，重点阐述基于Dapr和CAP事件总线的分布式通信模式。文档涵盖了服务调用、事件发布订阅、状态管理等关键方面，提供了同步与异步通信的最佳实践、接口定义和消息格式规范。通过分析实际代码实现，解释了服务发现、负载均衡和故障恢复机制。

项目结构

该项目采用微服务架构，通过Dapr和CAP实现插件间的通信。核心通信功能分布在aspnet-core/framework/dapr和aspnet-core/framework/common/LINGYUN.Abp.EventBus.CAP目录中。Dapr相关模块提供了服务间调用和Actor模型支持，而CAP事件总线则负责事件驱动的异步通信。

graph TD
subgraph "通信框架"
Dapr["Dapr 服务调用"]
Actor["Dapr Actor"]
CAP["CAP 事件总线"]
end
subgraph "核心模块"
Client["Dapr 客户端代理"]
Proxy["动态代理拦截器"]
Config["配置管理"]
Error["错误处理"]
end
Dapr --> Client
Actor --> Proxy
CAP --> Config
Client --> Proxy
Proxy --> Error

图示来源

  • AbpDaprClientModule.cs
  • DynamicDaprClientProxyInterceptor.cs
  • AbpCapEventBusModule.cs

本节来源

  • AbpDaprModule.cs
  • AbpCapEventBusModule.cs

核心组件

系统的核心通信组件包括基于Dapr的服务调用代理、Dapr Actor集成和CAP事件总线。Dapr客户端代理通过动态拦截器实现透明的服务调用，而CAP事件总线则提供了可靠的事件发布订阅机制。这些组件共同构成了插件间通信的基础。

本节来源

  • AbpDaprClientModule.cs
  • AbpCapEventBusModule.cs

架构概述

系统采用分层架构，上层应用通过代理透明地调用底层服务。Dapr提供服务发现和调用能力，CAP处理事件驱动的异步通信。这种架构实现了插件间的松耦合，支持独立部署和扩展。

graph LR
A[应用插件] --> B[Dapr 客户端代理]
B --> C[Dapr 运行时]
C --> D[目标服务]
A --> E[CAP 生产者]
E --> F[消息队列]
F --> G[CAP 消费者]
G --> H[目标插件]
style A fill:#f9f,stroke:#333
style D fill:#f9f,stroke:#333
style H fill:#f9f,stroke:#333

图示来源

  • AbpDaprClientModule.cs
  • AbpCapEventBusModule.cs

详细组件分析

Dapr 客户端代理分析

Dapr客户端代理通过动态拦截器实现服务调用的透明化。当应用调用远程服务时，拦截器会自动处理服务发现、请求构建和响应解析。

动态代理拦截器

classDiagram
class DynamicDaprClientProxyInterceptor~TService~ {
+ILogger<DynamicDaprClientProxyInterceptor<TService>> Logger
+DynamicDaprProxyInterceptorClientProxy<TService> InterceptorClientProxy
+AbpDaprClientProxyOptions ClientProxyOptions
+IRemoteServiceConfigurationProvider RemoteServiceConfigurationProvider
+IDaprApiDescriptionFinder ApiDescriptionFinder
+InterceptAsync(IAbpMethodInvocation invocation) Task
+GetActionApiDescriptionModel(IAbpMethodInvocation invocation) ActionApiDescriptionModel
+CallRequestAsync<T>(ClientProxyRequestContext context) T
+GetResultAsync(Task task, Type resultType) object
}
class DynamicDaprActorProxyInterceptor~TService~ {
+ICurrentTenant CurrentTenant
+AbpSystemTextJsonSerializerOptions JsonSerializerOptions
+AbpDaprActorProxyOptions DaprActorProxyOptions
+IProxyHttpClientFactory HttpClientFactory
+IRemoteServiceHttpClientAuthenticator ClientAuthenticator
+IRemoteServiceConfigurationProvider RemoteServiceConfigurationProvider
+ILogger<DynamicDaprActorProxyInterceptor<TService>> Logger
+InterceptAsync(IAbpMethodInvocation invocation) Task
+MakeRequestAsync(IAbpMethodInvocation invocation) Task
+AddHeaders(DaprHttpClientHandler handler) void
}
DynamicDaprClientProxyInterceptor --> DynamicDaprActorProxyInterceptor : "继承"

图示来源

  • DynamicDaprClientProxyInterceptor.cs
  • DynamicDaprActorProxyInterceptor.cs

服务调用流程

sequenceDiagram
participant Client as "客户端应用"
participant Interceptor as "代理拦截器"
participant Config as "配置提供者"
participant ApiFinder as "API描述查找器"
participant DaprClient as "Dapr客户端"
participant RemoteService as "远程服务"
Client->>Interceptor : 调用远程方法
Interceptor->>Config : 获取服务配置
Config-->>Interceptor : 返回配置
Interceptor->>ApiFinder : 查找API描述
ApiFinder-->>Interceptor : 返回API描述
Interceptor->>DaprClient : 构建请求
DaprClient->>RemoteService : 发送请求
RemoteService-->>DaprClient : 返回响应
DaprClient-->>Interceptor : 返回结果
Interceptor-->>Client : 返回调用结果

图示来源

  • DynamicDaprClientProxyInterceptor.cs
  • DaprRemoteServiceConfigurationExtensions.cs

CAP 事件总线分析

CAP事件总线提供了可靠的事件发布订阅机制，确保消息的最终一致性。

事件总线配置

classDiagram
class AbpCAPEventBusModule {
+ConfigureServices(ServiceConfigurationContext context) void
}
class AbpCAPEventBusOptions {
+bool NotifyFailedCallback
}
class FailedThresholdCallbackNotifier {
+NotifyAsync(AbpCAPExecutionFailedException failed) Task
}
AbpCAPEventBusModule --> AbpCAPEventBusOptions : "使用"
AbpCAPEventBusModule --> FailedThresholdCallbackNotifier : "注入"

图示来源

  • AbpCapEventBusModule.cs
  • AbpCAPEventBusOptions.cs

本节来源

  • DynamicDaprClientProxyInterceptor.cs
  • DynamicDaprActorProxyInterceptor.cs
  • AbpCapEventBusModule.cs

依赖分析

系统组件间存在明确的依赖关系，确保了通信机制的稳定性和可扩展性。

graph TD
A[AbpDaprModule] --> B[AbpJsonModule]
C[AbpDaprClientModule] --> D[AbpHttpClientModule]
E[AbpDaprActorsModule] --> D[AbpHttpClientModule]
F[AbpCapEventBusModule] --> G[AbpEventBusModule]
C --> H[DynamicDaprClientProxyInterceptor]
E --> I[DynamicDaprActorProxyInterceptor]
F --> J[FailedThresholdCallbackNotifier]
style A fill:#e6f3ff,stroke:#333
style C fill:#e6f3ff,stroke:#333
style E fill:#e6f3ff,stroke:#333
style F fill:#e6f3ff,stroke:#333

图示来源

  • AbpDaprModule.cs
  • AbpDaprClientModule.cs
  • AbpDaprActorsModule.cs
  • AbpCapEventBusModule.cs

本节来源

  • AbpDaprModule.cs
  • AbpDaprClientModule.cs
  • AbpDaprActorsModule.cs
  • AbpCapEventBusModule.cs

性能考虑

系统在设计时考虑了性能优化，通过连接池、异步调用和消息批处理等机制提高通信效率。Dapr的边车模式减少了直接网络连接的开销，而CAP的批量发布机制降低了消息队列的压力。

故障排除指南

当通信出现问题时，应首先检查服务配置和网络连接。对于Dapr调用失败，需要验证AppId配置和Dapr运行时状态；对于CAP事件丢失，应检查消息队列的健康状况和消费者处理逻辑。

本节来源

  • AbpDaprActorCallException.cs
  • AbpCapEventBusModule.cs

结论

ABP Next Admin项目通过Dapr和CAP实现了强大的插件间通信能力。Dapr提供了同步服务调用和Actor模型支持，而CAP确保了异步事件的可靠传递。这种组合既满足了实时交互的需求，又保证了系统的最终一致性，为微服务架构下的插件化开发提供了坚实的基础。