feat(docs): all modules docs
parent
cf3c61eb24
commit
60516b7cf1
|
|
@ -0,0 +1,8 @@
|
||||||
|
{
|
||||||
|
"permissions": {
|
||||||
|
"allow": [
|
||||||
|
"Bash(ls:*)",
|
||||||
|
"Bash(git:*)"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,134 @@
|
||||||
|
# AML 核心模块
|
||||||
|
|
||||||
|
## 模块概述
|
||||||
|
|
||||||
|
iCON.Abp.AML 是系统的反洗钱核心功能模块,提供身份验证、合规检测、交易监控等核心业务功能。
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
modules/iCON.Abp.AML/
|
||||||
|
├── src/
|
||||||
|
│ ├── iCON.Abp.AML.Application/ # 应用层实现
|
||||||
|
│ │ ├── KYC/ # KYC身份验证
|
||||||
|
│ │ │ ├── KYCService.cs
|
||||||
|
│ │ │ ├── HandlerService.cs
|
||||||
|
│ │ │ ├── XiangyunService.cs
|
||||||
|
│ │ │ ├── WebSearchService.cs
|
||||||
|
│ │ │ └── ...
|
||||||
|
│ │ ├── CRChecker/ # 合规检查
|
||||||
|
│ │ ├── ConsumerPortal/ # 消费者门户
|
||||||
|
│ │ ├── DataCollect/ # 数据采集
|
||||||
|
│ │ ├── Detection/ # 活动检测
|
||||||
|
│ │ ├── Individual/ # 个人实体
|
||||||
|
│ │ ├── Organization/ # 企业实体
|
||||||
|
│ │ ├── Overview/ # 概览统计
|
||||||
|
│ │ ├── Report/ # 报告生成
|
||||||
|
│ │ ├── STR/ # 可疑交易报告
|
||||||
|
│ │ └── Survey/ # 调查问卷
|
||||||
|
│ ├── iCON.Abp.AML.Application.Contracts/ # 应用层接口
|
||||||
|
│ ├── iCON.Abp.AML.Domain/ # 领域层
|
||||||
|
│ │ ├── KYC/
|
||||||
|
│ │ ├── Org/
|
||||||
|
│ │ ├── Individual/
|
||||||
|
│ │ ├── Detection/
|
||||||
|
│ │ └── ...
|
||||||
|
│ ├── iCON.Abp.AML.Domain.Shared/ # 领域共享
|
||||||
|
│ ├── iCON.Abp.AML.EntityFrameworkCore/ # 实体框架
|
||||||
|
│ └── iCON.Abp.AML.HttpApi/ # API控制器
|
||||||
|
└── test/ # 单元测试
|
||||||
|
```
|
||||||
|
|
||||||
|
## 核心功能
|
||||||
|
|
||||||
|
### 1. KYC 身份验证
|
||||||
|
|
||||||
|
客户身份验证和合规检查。
|
||||||
|
|
||||||
|
**详细文档**: [KYC 模块文档](../KYC/README.md)
|
||||||
|
|
||||||
|
### 2. CRChecker 合规检查
|
||||||
|
|
||||||
|
Compliance Review 合规检查服务。
|
||||||
|
|
||||||
|
**主要接口**:
|
||||||
|
- `ICRCheckerService`
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 批量提交合规检查
|
||||||
|
- 更新检查队列状态
|
||||||
|
- 获取检查结果
|
||||||
|
|
||||||
|
### 3. Detection 活动检测
|
||||||
|
|
||||||
|
交易和活动的实时监控与检测。
|
||||||
|
|
||||||
|
**主要接口**:
|
||||||
|
- `IDetectionService`
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 实时交易监控
|
||||||
|
- 可疑活动识别
|
||||||
|
- 风险阈值配置
|
||||||
|
- AI检测集成
|
||||||
|
|
||||||
|
### 4. STR 可疑交易报告
|
||||||
|
|
||||||
|
Suspicious Transaction Report 可疑交易报告管理。
|
||||||
|
|
||||||
|
**主要服务**:
|
||||||
|
- STRService
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 可疑交易上报
|
||||||
|
- 报告生成
|
||||||
|
- 监管对接
|
||||||
|
|
||||||
|
### 5. Report 报告生成
|
||||||
|
|
||||||
|
各类AML相关报告的生成。
|
||||||
|
|
||||||
|
**主要服务**:
|
||||||
|
- ReportService
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 风险报告
|
||||||
|
- 筛查报告
|
||||||
|
- 交易报告
|
||||||
|
- 自定义报表
|
||||||
|
|
||||||
|
### 6. 实体管理
|
||||||
|
|
||||||
|
**IndividualService** - 个人实体管理
|
||||||
|
**CorporationService** - 企业实体管理
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 实体创建/更新
|
||||||
|
- 实体状态管理
|
||||||
|
- 关联关系维护
|
||||||
|
|
||||||
|
## API 路由
|
||||||
|
|
||||||
|
所有API均以 `/api/aml/` 为前缀,具体路由:
|
||||||
|
|
||||||
|
| 路由前缀 | 功能 |
|
||||||
|
|----------|------|
|
||||||
|
| `/api/aml/kyc` | KYC身份验证 |
|
||||||
|
| `/api/aml/overview` | 概览统计 |
|
||||||
|
| `/api/aml/detection` | 活动检测 |
|
||||||
|
| `/api/aml/report` | 报告生成 |
|
||||||
|
|
||||||
|
## 领域实体
|
||||||
|
|
||||||
|
| 实体 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `Organization` | 企业实体 |
|
||||||
|
| `Individual` | 个人实体 |
|
||||||
|
| `DetectionLog` | 检测日志 |
|
||||||
|
| `KYCSetting` | KYC设置 |
|
||||||
|
| `KYCCheckResultRecord` | KYC检查结果 |
|
||||||
|
|
||||||
|
## 版本信息
|
||||||
|
|
||||||
|
**文档版本**: v1.0
|
||||||
|
**最后更新**: 2026-04-30
|
||||||
|
|
@ -0,0 +1,143 @@
|
||||||
|
# AMLPortal 门户模块
|
||||||
|
|
||||||
|
## 模块概述
|
||||||
|
|
||||||
|
iCON.Abp.AMLPortal 提供消费者和企业用户的门户功能,包括租户管理、订单管理、客户管理等。
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
modules/iCON.Abp.AMLPortal/
|
||||||
|
├── src/
|
||||||
|
│ ├── iCON.Abp.AMLPortal.Application/ # 应用层实现
|
||||||
|
│ │ ├── AgentorService.cs # 代理服务
|
||||||
|
│ │ ├── CustomerService.cs # 客户服务
|
||||||
|
│ │ ├── OrderService.cs # 订单服务
|
||||||
|
│ │ ├── PlanService.cs # 计划服务
|
||||||
|
│ │ ├── CustomerIdentityService.cs # 客户认证
|
||||||
|
│ │ └── Jobs/ # 后台作业
|
||||||
|
│ ├── iCON.Abp.AMLPortal.Application.Contracts/ # 应用层接口
|
||||||
|
│ │ ├── AgentorAppLayer/ # 代理接口
|
||||||
|
│ │ ├── CustomerAppLayer/ # 客户接口
|
||||||
|
│ │ ├── OrderAppLayer/ # 订单接口
|
||||||
|
│ │ ├── PlanAppLayer/ # 计划接口
|
||||||
|
│ │ └── CustomerIdentityAppLayer/ # 认证接口
|
||||||
|
│ ├── iCON.Abp.AMLPortal.Domain/ # 领域层
|
||||||
|
│ │ ├── DbEntity/ # 数据库实体
|
||||||
|
│ │ │ ├── Agentor.cs
|
||||||
|
│ │ │ ├── Customer.cs
|
||||||
|
│ │ │ ├── Order.cs
|
||||||
|
│ │ │ ├── Plan.cs
|
||||||
|
│ │ │ ├── TenantProperty.cs
|
||||||
|
│ │ │ └── ...
|
||||||
|
│ │ └── Interface/ # 仓储接口
|
||||||
|
│ ├── iCON.Abp.AMLPortal.Domain.Shared/ # 领域共享
|
||||||
|
│ └── iCON.Abp.AMLPortal.EntityFrameworkCore/ # EF Core
|
||||||
|
└── ...
|
||||||
|
```
|
||||||
|
|
||||||
|
## 核心功能
|
||||||
|
|
||||||
|
### 1. 代理管理 (Agentor)
|
||||||
|
|
||||||
|
代理商/中介机构管理。
|
||||||
|
|
||||||
|
**主要接口**: `IAgentorService`
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 代理列表查询
|
||||||
|
- 代理信息管理
|
||||||
|
- 租户分配
|
||||||
|
|
||||||
|
### 2. 客户管理 (Customer)
|
||||||
|
|
||||||
|
终端客户管理。
|
||||||
|
|
||||||
|
**主要接口**: `ICustomerService`
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 客户注册/登录
|
||||||
|
- 客户信息管理
|
||||||
|
- 客户反馈处理
|
||||||
|
|
||||||
|
**相关类**:
|
||||||
|
- `CustomerLoginParam` - 登录参数
|
||||||
|
- `CustomerRegisterParam` - 注册参数
|
||||||
|
- `CreateFeedbackDto` - 反馈创建
|
||||||
|
|
||||||
|
### 3. 订单管理 (Order)
|
||||||
|
|
||||||
|
租户订单和配额管理。
|
||||||
|
|
||||||
|
**主要接口**: `IOrderService`
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 创建订单
|
||||||
|
- 订单审核
|
||||||
|
- 租户续期
|
||||||
|
- 服务信息查询
|
||||||
|
- 配额使用追踪
|
||||||
|
|
||||||
|
**核心实体**:
|
||||||
|
- `Order` - 订单主表
|
||||||
|
- `OrderDetail` - 订单明细
|
||||||
|
- `PaymentInfo` - 支付信息
|
||||||
|
- `TenantProperty` - 租户属性
|
||||||
|
|
||||||
|
### 4. 计划管理 (Plan)
|
||||||
|
|
||||||
|
服务计划和配额管理。
|
||||||
|
|
||||||
|
**主要接口**: `IPlanService`
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 计划列表查询
|
||||||
|
- 计划详情管理
|
||||||
|
- 代理用户计划更新
|
||||||
|
|
||||||
|
**核心实体**:
|
||||||
|
- `Plan` - 计划
|
||||||
|
- `PlanDetail` - 计划明细
|
||||||
|
- `AgentUserPlan` - 代理用户计划
|
||||||
|
|
||||||
|
### 5. 客户认证 (CustomerIdentity)
|
||||||
|
|
||||||
|
客户身份认证和缓存。
|
||||||
|
|
||||||
|
**主要接口**:
|
||||||
|
- `ICustomerIdentityService`
|
||||||
|
- `ICustomerCacheService`
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 客户Token管理
|
||||||
|
- 登录验证
|
||||||
|
- 缓存处理
|
||||||
|
|
||||||
|
## 数据库实体
|
||||||
|
|
||||||
|
| 实体 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `Agentor` | 代理商 |
|
||||||
|
| `AgentUserPlan` | 代理用户计划 |
|
||||||
|
| `Customer` | 客户 |
|
||||||
|
| `Feedback` | 客户反馈 |
|
||||||
|
| `Order` | 订单 |
|
||||||
|
| `OrderDetail` | 订单明细 |
|
||||||
|
| `PaymentInfo` | 支付信息 |
|
||||||
|
| `Plan` | 服务计划 |
|
||||||
|
| `PlanDetail` | 计划明细 |
|
||||||
|
| `TenantEventQueue` | 租户事件队列 |
|
||||||
|
| `TenantProperty` | 租户属性 |
|
||||||
|
| `VerifyCode` | 验证码 |
|
||||||
|
|
||||||
|
## 后台作业
|
||||||
|
|
||||||
|
| 作业 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `ClearExpiredOrderCustomerJob` | 清理过期订单客户 |
|
||||||
|
| `TenantTobeExpiredRemindJob` | 租户到期提醒 |
|
||||||
|
|
||||||
|
## 版本信息
|
||||||
|
|
||||||
|
**文档版本**: v1.0
|
||||||
|
**最后更新**: 2026-04-30
|
||||||
|
|
@ -0,0 +1,160 @@
|
||||||
|
# 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
|
||||||
|
|
@ -21,6 +21,9 @@ modules/iCON.Abp.AML/
|
||||||
│ │ ├── CertificateEntityValueFinder.cs
|
│ │ ├── CertificateEntityValueFinder.cs
|
||||||
│ │ ├── ElasticResultJsonReader.cs
|
│ │ ├── ElasticResultJsonReader.cs
|
||||||
│ │ ├── TranslateMapper.cs
|
│ │ ├── TranslateMapper.cs
|
||||||
|
│ │ ├── JsonContentReader.cs # JSON内容读取器
|
||||||
|
│ │ ├── RealHttpClient.cs # HTTP客户端实现
|
||||||
|
│ │ ├── XiangyunCartTypeCodeConverter.cs # 祥云证件类型转换器
|
||||||
│ │ ├── MockKYCService.cs # KYC模拟服务(测试用)
|
│ │ ├── MockKYCService.cs # KYC模拟服务(测试用)
|
||||||
│ │ └── MockHandlerService.cs # 处理器模拟服务
|
│ │ └── MockHandlerService.cs # 处理器模拟服务
|
||||||
│ ├── iCON.Abp.AML.Application.Contracts/
|
│ ├── iCON.Abp.AML.Application.Contracts/
|
||||||
|
|
@ -63,7 +66,23 @@ AML_Frontend/src/app/
|
||||||
|
|
||||||
## 支持的证件类型
|
## 支持的证件类型
|
||||||
|
|
||||||
证件类型配置位于: `src/iCON.Abp.FX.HttpApi.Host/Data/AML/KYC/CertificateMappings/`
|
证件类型配置位于: `AML_Backend/src/iCON.Abp.FX.HttpApi.Host/appsettings.json` 的 `CertificateMappings` 节点
|
||||||
|
|
||||||
|
### 配置结构示例
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"AMLConfig": {
|
||||||
|
"CertificateMappings": [
|
||||||
|
{
|
||||||
|
"CertificateCode": "IDCard_CHN",
|
||||||
|
"EntityType": "Individual",
|
||||||
|
"Description": "中国居民身份证"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### 个人证件 (Individual)
|
### 个人证件 (Individual)
|
||||||
| 证件类型 | 代码 | 说明 |
|
| 证件类型 | 代码 | 说明 |
|
||||||
|
|
@ -118,6 +137,26 @@ AML_Frontend/src/app/
|
||||||
| `/GetReportIndividualKYCCheckResult` | POST | 获取个人KYC报告 |
|
| `/GetReportIndividualKYCCheckResult` | POST | 获取个人KYC报告 |
|
||||||
| `/GetReportOrganizationKYCCheckResult` | POST | 获取企业KYC报告 |
|
| `/GetReportOrganizationKYCCheckResult` | POST | 获取企业KYC报告 |
|
||||||
|
|
||||||
|
### 证件记录管理
|
||||||
|
|
||||||
|
| 接口 | 方法 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `/GetValidateCertificateRecords` | POST | 获取证件验证记录 |
|
||||||
|
| `/BindValidateCertificateRecords` | POST | 绑定证件验证记录 |
|
||||||
|
|
||||||
|
### 证件类型查询
|
||||||
|
|
||||||
|
| 接口 | 方法 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `/GetIndividualSupportCertificate` | POST | 获取个人支持的证件类型 |
|
||||||
|
| `/GetOrganizationSupportCertificate` | POST | 获取企业支持的证件类型 |
|
||||||
|
|
||||||
|
### 附件验证
|
||||||
|
|
||||||
|
| 接口 | 方法 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `/ValidateAttachment` | POST | 验证附件 |
|
||||||
|
|
||||||
### 外部 API
|
### 外部 API
|
||||||
|
|
||||||
| 接口 | 方法 | 说明 |
|
| 接口 | 方法 | 说明 |
|
||||||
|
|
@ -181,6 +220,25 @@ AML_Frontend/src/app/
|
||||||
### WebSearchService
|
### WebSearchService
|
||||||
执行网络搜索检测实体是否在失信人名单中。
|
执行网络搜索检测实体是否在失信人名单中。
|
||||||
|
|
||||||
|
### JsonContentReader
|
||||||
|
JSON内容读取器,用于解析各种JSON格式的响应数据。
|
||||||
|
|
||||||
|
### RealHttpClient
|
||||||
|
HTTP客户端实现,用于与外部服务进行通信。
|
||||||
|
|
||||||
|
### XiangyunCartTypeCodeConverter
|
||||||
|
祥云证件类型转换器,用于转换祥云OCR服务的证件类型代码。
|
||||||
|
|
||||||
|
## 证件映射实现
|
||||||
|
|
||||||
|
证件类型映射通过 `CertificateMappings.cs` 类实现,该类定义了系统支持的所有证件类型及其属性:
|
||||||
|
|
||||||
|
- **CertificateCode**: 证件类型代码
|
||||||
|
- **EntityType**: 实体类型 (Individual/Organization)
|
||||||
|
- **Description**: 证件描述
|
||||||
|
- **SupportedCountries**: 支持的国家/地区
|
||||||
|
- **ValidationRules**: 验证规则
|
||||||
|
|
||||||
## 数据模型
|
## 数据模型
|
||||||
|
|
||||||
### KYCSetting
|
### KYCSetting
|
||||||
|
|
@ -208,10 +266,46 @@ this.kycService.scanCertificateV2(params);
|
||||||
this.kycService.getKYCCheckResult(entityId);
|
this.kycService.getKYCCheckResult(entityId);
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 版本信息
|
||||||
|
|
||||||
|
**文档版本**: v1.1
|
||||||
|
**最后更新**: 2026-04-30
|
||||||
|
**适用系统版本**: AML Backend v2.x
|
||||||
|
|
||||||
|
## 更新日志
|
||||||
|
|
||||||
|
### v1.1 (2026-04-30)
|
||||||
|
- 修正证件映射配置文件路径
|
||||||
|
- 补充完整的KYC服务文件列表
|
||||||
|
- 添加证件映射实现说明
|
||||||
|
- 完善API接口分类
|
||||||
|
- 更新测试文件列表
|
||||||
|
- 添加配置结构示例
|
||||||
|
|
||||||
|
### v1.0 (初始版本)
|
||||||
|
- 基础KYC模块文档
|
||||||
|
- 核心功能说明
|
||||||
|
- API接口定义
|
||||||
|
- 数据模型描述
|
||||||
|
|
||||||
## 测试
|
## 测试
|
||||||
|
|
||||||
测试文件位于: `modules/iCON.Abp.AML/test/iCON.Abp.AML.Application.Tests/`
|
测试文件位于: `modules/iCON.Abp.AML/test/iCON.Abp.AML.Application.Tests/`
|
||||||
|
|
||||||
- `TestKYCService_ScanCertificate*.cs`
|
### 测试文件列表
|
||||||
- `TestKYCService_GetAttachmentFileSettingAsync.cs`
|
|
||||||
- `TestKYCService_GetScanAndValidateSettingAsync.cs`
|
- `TestKYCService_Base.cs` - KYC测试基类
|
||||||
|
- `TestKYCService_ScanCertificate.cs` - 证件扫描测试(v1)
|
||||||
|
- `TestKYCService_ScanCertificateV2.cs` - 证件扫描测试(v2)
|
||||||
|
- `TestKYCService_ScanCertificateV2_OCR.cs` - OCR识别测试
|
||||||
|
- `TestKYCService_ScanCertificateV2_OCR_Passport.cs` - 护照OCR测试
|
||||||
|
- `TestKYCService_GetAttachmentFileSettingAsync.cs` - 附件设置测试
|
||||||
|
- `TestKYCService_GetScanAndValidateSettingAsync.cs` - 扫描验证设置测试
|
||||||
|
|
||||||
|
### 测试覆盖范围
|
||||||
|
|
||||||
|
- 证件扫描和识别
|
||||||
|
- OCR服务集成
|
||||||
|
- 设置管理
|
||||||
|
- 验证流程
|
||||||
|
- Mock服务测试
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,91 @@
|
||||||
|
# MediaStore 媒体存储模块
|
||||||
|
|
||||||
|
## 模块概述
|
||||||
|
|
||||||
|
iCON.Abp.MediaStore 提供文件和媒体资源的存储管理功能。
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
modules/iCON.Abp.MediaStore/
|
||||||
|
├── src/
|
||||||
|
│ ├── iCON.Abp.MediaStore.Application/ # 应用层实现
|
||||||
|
│ │ ├── MediaStoreApplicationModule.cs
|
||||||
|
│ │ ├── FileMediaResourceService.cs # 文件媒体服务
|
||||||
|
│ │ ├── FileTypeChecker.cs # 文件类型检查
|
||||||
|
│ │ └── FormFileGetter.cs # Form文件获取
|
||||||
|
│ ├── iCON.Abp.MediaStore.Application.Contracts/ # 应用层接口
|
||||||
|
│ │ ├── IMediaStore.cs # 媒体存储接口
|
||||||
|
│ │ ├── IFromFileGetter.cs # 文件获取接口
|
||||||
|
│ │ ├── MediaInfo.cs # 媒体信息
|
||||||
|
│ │ ├── FileType.cs # 文件类型
|
||||||
|
│ │ └── ...
|
||||||
|
│ ├── iCON.Abp.MediaStore.Domain/ # 领域层
|
||||||
|
│ └── iCON.Abp.MediaStore.HttpApi/ # API控制器
|
||||||
|
│ └── MediaStoreController.cs
|
||||||
|
```
|
||||||
|
|
||||||
|
## 核心功能
|
||||||
|
|
||||||
|
### 1. 媒体存储服务 (MediaStore)
|
||||||
|
|
||||||
|
**主要接口**: `IMediaStore`
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 文件上传
|
||||||
|
- 文件下载
|
||||||
|
- 媒体资源管理
|
||||||
|
- 附件处理
|
||||||
|
|
||||||
|
### 2. 文件媒体资源服务 (FileMediaResourceService)
|
||||||
|
|
||||||
|
**主要类**: `FileMediaResourceService`
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 媒体资源管理
|
||||||
|
- 文件类型处理
|
||||||
|
- 资源元数据管理
|
||||||
|
|
||||||
|
### 3. 文件类型检查 (FileTypeChecker)
|
||||||
|
|
||||||
|
**主要类**: `FileTypeChecker`
|
||||||
|
|
||||||
|
**功能**:
|
||||||
|
- 文件类型验证
|
||||||
|
- 文件扩展名检查
|
||||||
|
- MIME类型识别
|
||||||
|
|
||||||
|
## 核心类型
|
||||||
|
|
||||||
|
### FileType
|
||||||
|
|
||||||
|
文件类型枚举/定义。
|
||||||
|
|
||||||
|
### MediaInfo
|
||||||
|
|
||||||
|
媒体信息数据传输对象,包含:
|
||||||
|
- 文件ID
|
||||||
|
- 文件名
|
||||||
|
- 文件大小
|
||||||
|
- MIME类型
|
||||||
|
- 上传时间
|
||||||
|
- 存储路径
|
||||||
|
|
||||||
|
### UploadByBase64FileInputDto
|
||||||
|
|
||||||
|
Base64编码文件上传输入参数。
|
||||||
|
|
||||||
|
## API 接口
|
||||||
|
|
||||||
|
**控制器**: `MediaStoreController`
|
||||||
|
|
||||||
|
| 方法 | 路由 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| 上传 | `/api/media/upload` | 文件上传 |
|
||||||
|
| 下载 | `/api/media/download` | 文件下载 |
|
||||||
|
| 获取 | `/api/media/get` | 获取媒体信息 |
|
||||||
|
|
||||||
|
## 版本信息
|
||||||
|
|
||||||
|
**文档版本**: v1.0
|
||||||
|
**最后更新**: 2026-04-30
|
||||||
|
|
@ -0,0 +1,186 @@
|
||||||
|
# AML System Documentation
|
||||||
|
|
||||||
|
## 系统概述
|
||||||
|
|
||||||
|
AML (Anti-Money Laundering) 系统是一个全面的反洗钱合规管理平台,用于帮助金融机构和企业满足监管要求。系统采用前后端分离架构,后端基于 ASP.NET Core ABP 框架,前端基于 Angular 11。
|
||||||
|
|
||||||
|
## 技术架构
|
||||||
|
|
||||||
|
### 后端技术栈
|
||||||
|
- **框架**: ASP.NET Core + ABP (ASP.NET Boilerplate)
|
||||||
|
- **数据库**: Entity Framework Core
|
||||||
|
- **认证**: JWT Bearer Token
|
||||||
|
- **多租户**: 内置支持
|
||||||
|
|
||||||
|
### 前端技术栈
|
||||||
|
- **框架**: Angular 11
|
||||||
|
- **UI库**: ng-zorro-antd, PrimeNG, Syncfusion ECharts
|
||||||
|
- **状态管理**: NGXS Store
|
||||||
|
- **图表**: ECharts
|
||||||
|
|
||||||
|
## 目录结构
|
||||||
|
|
||||||
|
```
|
||||||
|
docs/
|
||||||
|
├── README.md # 系统架构总览
|
||||||
|
├── KYC/ # KYC身份验证模块
|
||||||
|
│ └── README.md
|
||||||
|
├── AML/ # AML核心模块
|
||||||
|
│ └── README.md
|
||||||
|
├── AMLPortal/ # 门户模块
|
||||||
|
│ └── README.md
|
||||||
|
├── BASIC/ # 基础模块
|
||||||
|
│ └── README.md
|
||||||
|
└── MediaStore/ # 媒体存储模块
|
||||||
|
└── README.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## 核心模块
|
||||||
|
|
||||||
|
### 1. iCON.Abp.AML (AML核心模块)
|
||||||
|
|
||||||
|
反洗钱核心功能模块,包含KYC、合规检测、STR上报等功能。
|
||||||
|
|
||||||
|
**主要功能:**
|
||||||
|
- KYC身份验证
|
||||||
|
- 交易监控
|
||||||
|
- 可疑活动检测
|
||||||
|
- STR (可疑交易报告)
|
||||||
|
- 风险评级
|
||||||
|
- 实时筛查
|
||||||
|
- 实体管理 (个人/企业)
|
||||||
|
|
||||||
|
**子模块路径**: `AML_Backend/modules/iCON.Abp.AML/`
|
||||||
|
|
||||||
|
**详细文档**: [AML 模块](./AML/README.md) | [KYC 模块](./KYC/README.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. iCON.Abp.AMLPortal (门户模块)
|
||||||
|
|
||||||
|
消费者和企业用户门户,提供前端用户界面。
|
||||||
|
|
||||||
|
**主要功能:**
|
||||||
|
- 租户配置管理
|
||||||
|
- 订单管理
|
||||||
|
- 消费者门户
|
||||||
|
- 企业信息管理
|
||||||
|
|
||||||
|
**子模块路径**: `AML_Backend/modules/iCON.Abp.AMLPortal/`
|
||||||
|
|
||||||
|
**详细文档**: [AMLPortal 模块](./AMLPortal/README.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. iCON.Abp.Basic (基础模块)
|
||||||
|
|
||||||
|
提供系统的基础能力和公共服务。
|
||||||
|
|
||||||
|
**主要功能:**
|
||||||
|
- 租户管理
|
||||||
|
- 配置管理
|
||||||
|
- 审计日志
|
||||||
|
- 通知服务
|
||||||
|
- 文件存储接口
|
||||||
|
|
||||||
|
**子模块路径**: `AML_Backend/modules/iCON.Abp.Basic/`
|
||||||
|
|
||||||
|
**详细文档**: [BASIC 模块](./BASIC/README.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4. iCON.Abp.MediaStore (媒体存储模块)
|
||||||
|
|
||||||
|
文件和媒体资源存储管理。
|
||||||
|
|
||||||
|
**主要功能:**
|
||||||
|
- 文件上传/下载
|
||||||
|
- 媒体资源管理
|
||||||
|
- 附件处理
|
||||||
|
|
||||||
|
**子模块路径**: `AML_Backend/modules/iCON.Abp.MediaStore/`
|
||||||
|
|
||||||
|
**详细文档**: [MediaStore 模块](./MediaStore/README.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 前端功能模块
|
||||||
|
|
||||||
|
前端模块位于 `AML_Frontend/src/app/modules/`
|
||||||
|
|
||||||
|
| 模块 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `aml-query` | AML查询功能 |
|
||||||
|
| `agent` | 代理/中介管理 |
|
||||||
|
| `configuration` | 系统配置 |
|
||||||
|
| `document` | 文档管理 |
|
||||||
|
| `form` | 表单处理 |
|
||||||
|
| `home` | 首页/仪表盘 |
|
||||||
|
| `investigate-setting` | 调查设置 |
|
||||||
|
| `llm` | LLM集成 |
|
||||||
|
| `log` | 日志查看 |
|
||||||
|
| `operator` | 操作员管理 |
|
||||||
|
| `plan` | 计划管理 |
|
||||||
|
| `realtime-screening` | 实时筛查 |
|
||||||
|
| `report` | 报告生成 |
|
||||||
|
| `risk-report` | 风险报告 |
|
||||||
|
| `screen-report` | 筛查报告 |
|
||||||
|
| `stats` | 统计分析 |
|
||||||
|
| `str` | STR管理 |
|
||||||
|
| `tenant-info` | 租户信息 |
|
||||||
|
| `transaction-report` | 交易报告 |
|
||||||
|
| `white-list` | 白名单管理 |
|
||||||
|
|
||||||
|
## 共享组件
|
||||||
|
|
||||||
|
位于 `AML_Frontend/src/app/shared/` 和 `AML_Frontend/src/app/components/`
|
||||||
|
|
||||||
|
| 组件 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `viewer-account-select` | 账户选择器 |
|
||||||
|
| `viewer-account-form` | 账户表单 |
|
||||||
|
| `viewer-customer-info` | 客户信息查看器 |
|
||||||
|
| `viewer-scan-modal` | 扫描弹窗 |
|
||||||
|
| `viewer-investigate` | 调查查看器 |
|
||||||
|
| `remark-list` | 备注列表 |
|
||||||
|
| `pending-icon-list` | 待处理图标列表 |
|
||||||
|
|
||||||
|
## 数据库迁移
|
||||||
|
|
||||||
|
系统使用 Entity Framework Core 进行数据库管理。
|
||||||
|
|
||||||
|
**迁移项目**: `EntityFrameworkCore.DbMigrations`
|
||||||
|
|
||||||
|
**创建新迁移**:
|
||||||
|
```powershell
|
||||||
|
# 1. 设置 EntityFrameworkCore.DbMigrations 为启动项目
|
||||||
|
# 2. 在 Package Manager Console:
|
||||||
|
Add-Migration <MigrationName>
|
||||||
|
```
|
||||||
|
|
||||||
|
## 构建与部署
|
||||||
|
|
||||||
|
### 后端构建
|
||||||
|
```bash
|
||||||
|
dotnet build AML_Backend/iCON.Abp.AMLSolution.sln
|
||||||
|
```
|
||||||
|
|
||||||
|
### 前端构建
|
||||||
|
```bash
|
||||||
|
cd AML_Frontend
|
||||||
|
npm install --legacy-peer-deps
|
||||||
|
npm run build:dev # 开发构建
|
||||||
|
npm run build:prod # 生产构建
|
||||||
|
```
|
||||||
|
|
||||||
|
## 外部集成
|
||||||
|
|
||||||
|
系统集成了以下外部服务:
|
||||||
|
- **祥云OCR**: 证件识别服务
|
||||||
|
- **失信人查询**: 网络黑名单检测
|
||||||
|
- **征信查询**: 企业和个人征信验证
|
||||||
|
|
||||||
|
## 版本信息
|
||||||
|
|
||||||
|
**文档版本**: v1.0
|
||||||
|
**最后更新**: 2026-04-30
|
||||||
Loading…
Reference in New Issue