开发文档
| 版本号 | 修改 | 修改时间 | 备注 |
|---|---|---|---|
| v1.0.0 | 王小琱 | 2024.06.XX | 初次修订 |
1. 项目简介
- 服务名称：
exchange-solidus-bridge-backend - 服务描述：交易上报服务，用于将交易数据上报到Solidus。
- 所属模块：交易上报服务。
- 负责人：王小琱（wang746277441@gmail.com）
2. 功能描述
- 支持文件上传，并记录上传历史。
- 查询上传历史。
3. 系统架构
3.1 主要技术栈
- 编程语言：Go / Protocol Buffers v3
- 服务框架：Go Micro / GORM
- 数据库：MySQL
- API接口：gRPC
- 监控：Prometheus
- 容器编排：Docker
备注：具体依赖版本详见go.mod文件。
3.2 架构图
3.3 架构概括
业务层（Business Layer）
- 业务系统通过 gRPC 接口调用本服务，实现交易上报功能。
服务层（Service Layer）
- Solidus Bridge Service 负责交易上报业务逻辑、与外部数据线控服务对接。
数据层（Data Layer）
- MySQL 存储交易上报记录。
3.4 业务流程
3.4.1 文件上传流程
3.4.2 查询文件列表流程
4. 依赖组件
| 组件 | 版本 | 说明 |
|---|---|---|
| MySQL | 8.x | 关系型数据库 |
| Solidus | - | 数据分析服务 |
5. 接口设计
见接口文档
使用
make doc可以重新生成接口文档。
6. 数据库设计
7. 项目部署
见部署文档
8. 错误码定义
| 错误码 | 错误信息 | 说明 |
|---|---|---|
| ErrSystem | 内部错误 | 内部服务调用失败 |
| ErrParam | 参数错误 | 请求参数校验失败 |
| ... | ... | ... |
9. FAQ
1. 文件上传失败怎么办？
- 检查文件名、类型是否为空。
- 检查与 Solidus 的网络连通性。
- 检查数据库连接是否正常。
2. 上传记录如何查询？
- 可通过 ListFiles 接口获取所有上传文件的路径和修改时间。
- 也可直接查询 upload_records 表。
3. 环境变量如何配置？
- 详见部署文档和 config_env.go，主要包括数据库、日志、合规服务等配置项。