161 lines
3.8 KiB
Markdown
161 lines
3.8 KiB
Markdown
# Basic 基础模块
|
|
|
|
## 模块概述
|
|
|
|
iCON.Abp.Basic 提供系统的基础能力和公共服务，包括租户管理、配置管理、消息服务等。
|
|
|
|
## 目录结构
|
|
|
|
```
|
|
modules/iCON.Abp.Basic/
|
|
├── src/
|
|
│ ├── iCON.Abp.Basic.Application/ # 应用层实现
|
|
│ │ ├── CategoryService.cs # 分类服务
|
|
│ │ ├── EmailMessageService.cs # 邮件服务
|
|
│ │ ├── TokenService.cs # Token服务
|
|
│ │ ├── TemplateMessageService.cs # 模板消息
|
|
│ │ ├── RabbitMQService.cs # 消息队列
|
|
│ │ └── Jobs/ # 后台作业
|
|
│ ├── iCON.Abp.Basic.Application.Contracts/ # 应用层接口
|
|
│ │ ├── Dtos/ # 数据传输对象
|
|
│ │ │ ├── CatAppLayer/ # 分类相关DTO
|
|
│ │ │ └── ...
|
|
│ │ └── Interface/ # 服务接口
|
|
│ ├── iCON.Abp.Basic.Domain.Shared/ # 领域共享
|
|
│ │ ├── Enums.cs # 枚举定义
|
|
│ │ ├── AppConfig.cs # 应用配置
|
|
│ │ ├── Constant.cs # 常量定义
|
|
│ │ └── Helpers/ # 帮助类
|
|
│ ├── iCON.Abp.Basic.Domain/ # 领域层
|
|
│ └── iCON.Abp.Basic.HttpApi/ # API层
|
|
│ ├── Attributes/ # 自定义特性
|
|
│ └── Middlewares/ # 中间件
|
|
```
|
|
|
|
## 核心功能
|
|
|
|
### 1. 分类服务 (Category)
|
|
|
|
系统分类和目录管理。
|
|
|
|
**主要接口**: `ICategoryService`
|
|
|
|
**功能**:
|
|
- 分类 CRUD
|
|
- 分类翻译
|
|
- 快速输入管理
|
|
- AML文档管理
|
|
|
|
**核心DTO**:
|
|
- `CategoryDto`
|
|
- `CategoryTranslationDto`
|
|
- `CreateCategoryDto`
|
|
|
|
### 2. Token 服务
|
|
|
|
身份认证和Token管理。
|
|
|
|
**主要接口**:
|
|
- `ITokenService`
|
|
- `IAbpTokenService`
|
|
|
|
**功能**:
|
|
- Token生成
|
|
- Token验证
|
|
- JWT Payload处理
|
|
|
|
### 3. 消息服务
|
|
|
|
#### 邮件服务 (EmailMessageService)
|
|
|
|
**主要接口**: `IEmailMessageService`
|
|
|
|
**功能**:
|
|
- 邮件发送
|
|
- 邮件模板
|
|
- 队列处理
|
|
|
|
#### 模板消息服务 (TemplateMessageService)
|
|
|
|
**主要接口**: `ITemplateMessageService`
|
|
|
|
**功能**:
|
|
- 模板消息发送
|
|
- 消息格式化
|
|
|
|
### 4. 消息队列 (RabbitMQ)
|
|
|
|
RabbitMQ 消息队列服务。
|
|
|
|
**主要接口**:
|
|
- `IRabbitMQService`
|
|
- `RabbitMQConsumerService`
|
|
|
|
**功能**:
|
|
- 消息发布
|
|
- 消息消费
|
|
- 队列管理
|
|
|
|
### 5. 用户服务 (IdentityUserAppCustomService)
|
|
|
|
**主要接口**: `IIdentityUserAppCustomService`
|
|
|
|
**功能**:
|
|
- 用户管理
|
|
- 用户树结构查询
|
|
|
|
## HTTP 特性
|
|
|
|
### 自定义特性
|
|
|
|
| 特性 | 说明 |
|
|
|------|------|
|
|
| `AbpAutoAuthAttribute` | 自动认证 |
|
|
| `ConcurrentLoginAttribute` | 并发登录限制 |
|
|
| `CustomerAuthAttribute` | 客户认证 |
|
|
| `UserHostLimitAttribute` | 用户主机限制 |
|
|
|
|
### 中间件
|
|
|
|
| 中间件 | 说明 |
|
|
|--------|------|
|
|
| `AbpAutoAuthMiddleware` | 自动认证中间件 |
|
|
| `ConcurrentLoginMiddleware` | 并发登录中间件 |
|
|
| `CustomerAuthMiddleware` | 客户认证中间件 |
|
|
| `UserHostLimitMiddleware` | 用户限制中间件 |
|
|
|
|
## 后台作业
|
|
|
|
| 作业 | 说明 |
|
|
|------|------|
|
|
| `EmailQueueJob` | 邮件队列处理 |
|
|
| `ReportJob` | 报告生成作业 |
|
|
| `SendInvoiceJob` | 发票发送作业 |
|
|
| `TenantEventQueueJob` | 租户事件队列 |
|
|
|
|
## 枚举定义
|
|
|
|
位于 `Enums.cs`:
|
|
|
|
| 枚举 | 说明 |
|
|
|------|------|
|
|
| `RatingEnum` | 评级枚举 |
|
|
| `ObjectTypeEnum` | 对象类型枚举 |
|
|
| `EntityStatusEnum` | 实体状态枚举 |
|
|
| ... | ... |
|
|
|
|
## 帮助类
|
|
|
|
位于 `Helpers/`:
|
|
|
|
| 类 | 说明 |
|
|
|----|------|
|
|
| `AmountHelper` | 金额处理 |
|
|
| `CommonFunctions` | 通用函数 |
|
|
| `Md5Helper` | MD5加密 |
|
|
|
|
## 版本信息
|
|
|
|
**文档版本**: v1.0
|
|
**最后更新**: 2026-04-30
|