feat(docs): 添加实时消息模块文档

aspnet-core/modules/realtime-message/LINGYUN.Abp.IM.SignalR/README.EN.md

@@ -0,0 +1,35 @@
+# LINGYUN.Abp.IM.SignalR
+
+Instant messaging module implemented based on SignalR.
+
+## Features
+
+* Message sender provider implemented with SignalR
+* Integration with ABP SignalR module
+* Multi-language support
+
+## Dependencies
+
+* [LINGYUN.Abp.IM](../LINGYUN.Abp.IM/README.EN.md)
+* `AbpAspNetCoreSignalRModule`
+
+## Installation
+
+1. First, install the LINGYUN.Abp.IM.SignalR package to your project:
+
+```bash
+dotnet add package LINGYUN.Abp.IM.SignalR
+```
+
+2. Add `AbpIMSignalRModule` to your module's dependency list:
+
+```csharp
+[DependsOn(typeof(AbpIMSignalRModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## More
+
+[中文文档](README.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.IM.SignalR/README.md

@@ -0,0 +1,35 @@
+# LINGYUN.Abp.IM.SignalR
+
+基于 SignalR 实现的即时通讯模块。
+
+## 功能特性
+
+* 基于 SignalR 实现的消息发送者提供程序
+* 集成 ABP SignalR 模块
+* 多语言支持
+
+## 依赖模块
+
+* [LINGYUN.Abp.IM](../LINGYUN.Abp.IM/README.md)
+* `AbpAspNetCoreSignalRModule`
+
+## 配置使用
+
+1. 首先，需要安装 LINGYUN.Abp.IM.SignalR 到你的项目中：
+
+```bash
+dotnet add package LINGYUN.Abp.IM.SignalR
+```
+
+2. 添加 `AbpIMSignalRModule` 到你的模块的依赖列表：
+
+```csharp
+[DependsOn(typeof(AbpIMSignalRModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## 更多
+
+[English document](README.EN.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.IM/README.EN.md

@@ -0,0 +1,25 @@
+# LINGYUN.Abp.IM
+
+The foundation module for instant messaging.
+
+## Features
+
+* Provides instant messaging infrastructure
+* Provides message sender provider interface
+* Extensible message sender providers
+
+## Configuration
+
+The module uses `AbpIMOptions` configuration class:
+
+```csharp
+Configure<AbpIMOptions>(options =>
+{
+    // Add custom message sender provider
+    options.Providers.Add<CustomMessageSenderProvider>();
+});
+```
+
+## More
+
+[中文文档](README.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.IM/README.md

@@ -0,0 +1,25 @@
+# LINGYUN.Abp.IM
+
+即时通讯模块的基础模块。
+
+## 功能特性
+
+* 提供即时通讯基础设施
+* 提供消息发送者提供程序接口
+* 可扩展的消息发送者提供程序
+
+## 配置使用
+
+模块配置使用 `AbpIMOptions` 选项类:
+
+```csharp
+Configure<AbpIMOptions>(options =>
+{
+    // 添加自定义消息发送者提供程序
+    options.Providers.Add<CustomMessageSenderProvider>();
+});
+```
+
+## 更多
+
+[English document](README.EN.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Application.Contracts/README.EN.md

@@ -0,0 +1,35 @@
+# LINGYUN.Abp.MessageService.Application.Contracts
+
+Message service application layer contracts module.
+
+## Features
+
+* Defines application layer interfaces for message service
+* Defines DTOs for message service
+* Provides multi-language resources
+* Supports virtual file system
+
+## Dependencies
+
+* [LINGYUN.Abp.MessageService.Domain.Shared](../LINGYUN.Abp.MessageService.Domain.Shared/README.EN.md)
+
+## Installation
+
+1. First, install the LINGYUN.Abp.MessageService.Application.Contracts package to your project:
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.Application.Contracts
+```
+
+2. Add `AbpMessageServiceApplicationContractsModule` to your module's dependency list:
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceApplicationContractsModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## More
+
+[中文文档](README.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Application.Contracts/README.md

@@ -0,0 +1,35 @@
+# LINGYUN.Abp.MessageService.Application.Contracts
+
+消息服务应用层契约模块。
+
+## 功能特性
+
+* 定义消息服务的应用层接口
+* 定义消息服务的 DTO
+* 提供多语言资源
+* 支持虚拟文件系统
+
+## 依赖模块
+
+* [LINGYUN.Abp.MessageService.Domain.Shared](../LINGYUN.Abp.MessageService.Domain.Shared/README.md)
+
+## 配置使用
+
+1. 首先，需要安装 LINGYUN.Abp.MessageService.Application.Contracts 到你的项目中：
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.Application.Contracts
+```
+
+2. 添加 `AbpMessageServiceApplicationContractsModule` 到你的模块的依赖列表：
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceApplicationContractsModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## 更多
+
+[English document](README.EN.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Application/README.EN.md

@@ -0,0 +1,35 @@
+# LINGYUN.Abp.MessageService.Application
+
+Message service application layer module.
+
+## Features
+
+* Implements application layer interfaces for message service
+* Implements business logic for message service
+* Supports automatic object mapping
+
+## Dependencies
+
+* [LINGYUN.Abp.MessageService.Application.Contracts](../LINGYUN.Abp.MessageService.Application.Contracts/README.EN.md)
+* [LINGYUN.Abp.MessageService.Domain](../LINGYUN.Abp.MessageService.Domain/README.EN.md)
+
+## Installation
+
+1. First, install the LINGYUN.Abp.MessageService.Application package to your project:
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.Application
+```
+
+2. Add `AbpMessageServiceApplicationModule` to your module's dependency list:
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceApplicationModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## More
+
+[中文文档](README.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Application/README.md

@@ -0,0 +1,35 @@
+# LINGYUN.Abp.MessageService.Application
+
+消息服务应用层模块。
+
+## 功能特性
+
+* 实现消息服务的应用层接口
+* 实现消息服务的业务逻辑
+* 支持自动对象映射
+
+## 依赖模块
+
+* [LINGYUN.Abp.MessageService.Application.Contracts](../LINGYUN.Abp.MessageService.Application.Contracts/README.md)
+* [LINGYUN.Abp.MessageService.Domain](../LINGYUN.Abp.MessageService.Domain/README.md)
+
+## 配置使用
+
+1. 首先，需要安装 LINGYUN.Abp.MessageService.Application 到你的项目中：
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.Application
+```
+
+2. 添加 `AbpMessageServiceApplicationModule` 到你的模块的依赖列表：
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceApplicationModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## 更多
+
+[English document](README.EN.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Domain.Shared/README.EN.md

@@ -0,0 +1,35 @@
+# LINGYUN.Abp.MessageService.Domain.Shared
+
+Message service domain shared layer module.
+
+## Features
+
+* Defines message service infrastructure
+* Provides multi-language resources
+* Defines exception localization
+* Defines error codes
+
+## Dependencies
+
+* `AbpLocalizationModule`
+
+## Installation
+
+1. First, install the LINGYUN.Abp.MessageService.Domain.Shared package to your project:
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.Domain.Shared
+```
+
+2. Add `AbpMessageServiceDomainSharedModule` to your module's dependency list:
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceDomainSharedModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## More
+
+[中文文档](README.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Domain.Shared/README.md

@@ -0,0 +1,35 @@
+# LINGYUN.Abp.MessageService.Domain.Shared
+
+消息服务领域共享层模块。
+
+## 功能特性
+
+* 定义消息服务的基础设施
+* 提供多语言资源
+* 定义异常本地化
+* 定义错误代码
+
+## 依赖模块
+
+* `AbpLocalizationModule`
+
+## 配置使用
+
+1. 首先，需要安装 LINGYUN.Abp.MessageService.Domain.Shared 到你的项目中：
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.Domain.Shared
+```
+
+2. 添加 `AbpMessageServiceDomainSharedModule` 到你的模块的依赖列表：
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceDomainSharedModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## 更多
+
+[English document](README.EN.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Domain/README.EN.md

@@ -0,0 +1,40 @@
+# LINGYUN.Abp.MessageService.Domain
+
+Message service domain layer module.
+
+## Features
+
+* Implements message service domain logic
+* Integrates object extension functionality
+* Integrates caching functionality
+* Integrates notification functionality
+* Supports auto mapping
+* Supports multi-language
+
+## Dependencies
+
+* `AbpAutoMapperModule`
+* `AbpCachingModule`
+* `AbpNotificationsModule`
+* [LINGYUN.Abp.MessageService.Domain.Shared](../LINGYUN.Abp.MessageService.Domain.Shared/README.EN.md)
+
+## Installation
+
+1. First, install the LINGYUN.Abp.MessageService.Domain package to your project:
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.Domain
+```
+
+2. Add `AbpMessageServiceDomainModule` to your module's dependency list:
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceDomainModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## More
+
+[中文文档](README.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.Domain/README.md

@@ -0,0 +1,40 @@
+# LINGYUN.Abp.MessageService.Domain
+
+消息服务领域层模块。
+
+## 功能特性
+
+* 实现消息服务的领域逻辑
+* 集成对象扩展功能
+* 集成缓存功能
+* 集成通知功能
+* 支持自动映射
+* 支持多语言
+
+## 依赖模块
+
+* `AbpAutoMapperModule`
+* `AbpCachingModule`
+* `AbpNotificationsModule`
+* [LINGYUN.Abp.MessageService.Domain.Shared](../LINGYUN.Abp.MessageService.Domain.Shared/README.md)
+
+## 配置使用
+
+1. 首先，需要安装 LINGYUN.Abp.MessageService.Domain 到你的项目中：
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.Domain
+```
+
+2. 添加 `AbpMessageServiceDomainModule` 到你的模块的依赖列表：
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceDomainModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## 更多
+
+[English document](README.EN.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.EntityFrameworkCore/README.EN.md

@@ -0,0 +1,58 @@
+# LINGYUN.Abp.MessageService.EntityFrameworkCore
+
+EntityFrameworkCore implementation module for message service.
+
+## Features
+
+* Implements data access layer for message service
+* Provides default repository implementations
+* Implements repositories for the following entities:
+  * ChatGroup
+  * UserChatGroup
+  * UserChatCard
+  * UserChatSetting
+  * UserChatFriend
+
+## Dependencies
+
+* [LINGYUN.Abp.MessageService.Domain](../LINGYUN.Abp.MessageService.Domain/README.EN.md)
+* `AbpEntityFrameworkCoreModule`
+
+## Installation
+
+1. First, install the LINGYUN.Abp.MessageService.EntityFrameworkCore package to your project:
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.EntityFrameworkCore
+```
+
+2. Add `AbpMessageServiceEntityFrameworkCoreModule` to your module's dependency list:
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceEntityFrameworkCoreModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+3. Add message service related DbSet to your DbContext:
+
+```csharp
+public class YourDbContext : AbpDbContext<YourDbContext>, IMessageServiceDbContext
+{
+    public DbSet<ChatGroup> ChatGroups { get; set; }
+    public DbSet<UserChatGroup> UserChatGroups { get; set; }
+    public DbSet<UserChatCard> UserChatCards { get; set; }
+    public DbSet<UserChatSetting> UserChatSettings { get; set; }
+    public DbSet<UserChatFriend> UserChatFriends { get; set; }
+    
+    public YourDbContext(DbContextOptions<YourDbContext> options) 
+        : base(options)
+    {
+    }
+}
+```
+
+## More
+
+[中文文档](README.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.EntityFrameworkCore/README.md

@@ -0,0 +1,58 @@
+# LINGYUN.Abp.MessageService.EntityFrameworkCore
+
+消息服务的 EntityFrameworkCore 实现模块。
+
+## 功能特性
+
+* 实现消息服务的数据访问层
+* 提供默认仓储实现
+* 实现以下实体的仓储：
+  * ChatGroup - 聊天组
+  * UserChatGroup - 用户聊天组
+  * UserChatCard - 用户聊天卡片
+  * UserChatSetting - 用户聊天设置
+  * UserChatFriend - 用户聊天好友
+
+## 依赖模块
+
+* [LINGYUN.Abp.MessageService.Domain](../LINGYUN.Abp.MessageService.Domain/README.md)
+* `AbpEntityFrameworkCoreModule`
+
+## 配置使用
+
+1. 首先，需要安装 LINGYUN.Abp.MessageService.EntityFrameworkCore 到你的项目中：
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.EntityFrameworkCore
+```
+
+2. 添加 `AbpMessageServiceEntityFrameworkCoreModule` 到你的模块的依赖列表：
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceEntityFrameworkCoreModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+3. 在你的 DbContext 中添加消息服务相关的 DbSet：
+
+```csharp
+public class YourDbContext : AbpDbContext<YourDbContext>, IMessageServiceDbContext
+{
+    public DbSet<ChatGroup> ChatGroups { get; set; }
+    public DbSet<UserChatGroup> UserChatGroups { get; set; }
+    public DbSet<UserChatCard> UserChatCards { get; set; }
+    public DbSet<UserChatSetting> UserChatSettings { get; set; }
+    public DbSet<UserChatFriend> UserChatFriends { get; set; }
+    
+    public YourDbContext(DbContextOptions<YourDbContext> options) 
+        : base(options)
+    {
+    }
+}
+```
+
+## 更多
+
+[English document](README.EN.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.HttpApi.Client/README.EN.md

@@ -0,0 +1,46 @@
+# LINGYUN.Abp.MessageService.HttpApi.Client
+
+Message service HTTP API client module.
+
+## Features
+
+* Provides HTTP client proxies for message service
+* Automatic HTTP client proxy service registration
+
+## Dependencies
+
+* [LINGYUN.Abp.MessageService.Application.Contracts](../LINGYUN.Abp.MessageService.Application.Contracts/README.EN.md)
+* `AbpHttpClientModule`
+
+## Installation
+
+1. First, install the LINGYUN.Abp.MessageService.HttpApi.Client package to your project:
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.HttpApi.Client
+```
+
+2. Add `AbpMessageServiceHttpApiClientModule` to your module's dependency list:
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceHttpApiClientModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+3. Configure remote service URL:
+
+```json
+{
+  "RemoteServices": {
+    "AbpMessageService": {
+      "BaseUrl": "http://your-service-url"
+    }
+  }
+}
+```
+
+## More
+
+[中文文档](README.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.HttpApi.Client/README.md

@@ -0,0 +1,46 @@
+# LINGYUN.Abp.MessageService.HttpApi.Client
+
+消息服务 HTTP API 客户端模块。
+
+## 功能特性
+
+* 提供消息服务的 HTTP 客户端代理
+* 自动注册 HTTP 客户端代理服务
+
+## 依赖模块
+
+* [LINGYUN.Abp.MessageService.Application.Contracts](../LINGYUN.Abp.MessageService.Application.Contracts/README.md)
+* `AbpHttpClientModule`
+
+## 配置使用
+
+1. 首先，需要安装 LINGYUN.Abp.MessageService.HttpApi.Client 到你的项目中：
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.HttpApi.Client
+```
+
+2. 添加 `AbpMessageServiceHttpApiClientModule` 到你的模块的依赖列表：
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceHttpApiClientModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+3. 配置远程服务地址：
+
+```json
+{
+  "RemoteServices": {
+    "AbpMessageService": {
+      "BaseUrl": "http://your-service-url"
+    }
+  }
+}
+```
+
+## 更多
+
+[English document](README.EN.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.HttpApi/README.EN.md

@@ -0,0 +1,35 @@
+# LINGYUN.Abp.MessageService.HttpApi
+
+Message service HTTP API module.
+
+## Features
+
+* Provides HTTP API interfaces for message service
+* Supports MVC data annotation localization
+* Automatic API controller registration
+
+## Dependencies
+
+* [LINGYUN.Abp.MessageService.Application.Contracts](../LINGYUN.Abp.MessageService.Application.Contracts/README.EN.md)
+* `AbpAspNetCoreMvcModule`
+
+## Installation
+
+1. First, install the LINGYUN.Abp.MessageService.HttpApi package to your project:
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.HttpApi
+```
+
+2. Add `AbpMessageServiceHttpApiModule` to your module's dependency list:
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceHttpApiModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## More
+
+[中文文档](README.md)

aspnet-core/modules/realtime-message/LINGYUN.Abp.MessageService.HttpApi/README.md

@@ -0,0 +1,35 @@
+# LINGYUN.Abp.MessageService.HttpApi
+
+消息服务 HTTP API 模块。
+
+## 功能特性
+
+* 提供消息服务的 HTTP API 接口
+* 支持 MVC 数据注解本地化
+* 自动注册 API 控制器
+
+## 依赖模块
+
+* [LINGYUN.Abp.MessageService.Application.Contracts](../LINGYUN.Abp.MessageService.Application.Contracts/README.md)
+* `AbpAspNetCoreMvcModule`
+
+## 配置使用
+
+1. 首先，需要安装 LINGYUN.Abp.MessageService.HttpApi 到你的项目中：
+
+```bash
+dotnet add package LINGYUN.Abp.MessageService.HttpApi
+```
+
+2. 添加 `AbpMessageServiceHttpApiModule` 到你的模块的依赖列表：
+
+```csharp
+[DependsOn(typeof(AbpMessageServiceHttpApiModule))]
+public class YourModule : AbpModule
+{
+}
+```
+
+## 更多
+
+[English document](README.EN.md)