ken.li
3525aee49e
新增中间件相关文档包括 RocketMQ、Nacos、PowerJob 的部署指南和故障分析文档，完善 Keepalived 和 MySQL 的文档内容。新增内部通讯技能模板和示例文件，包括 3P更新、公司通讯、FAQ回答等格式指南。优化服务文档结构，补充 FIX 引擎高可用架构说明。新增中间件综合指南，详细说明高可用部署方案和灾备转换原理。 新增 RocketMQ 5.3.2 集群部署文档，包含 Controller 模式详解和详细配置说明。新增 Nacos 和 PowerJob 部署文档，补充服务依赖和关键配置。更新 MySQL 故障分析文档，优化复制冲突解决流程。新增内部通讯技能模板文件，规范公司内部通讯格式。 docs: 补充服务文档和中间件 TODO 列表 新增 g3fo-exchange-fix-engine-service 服务文档，详细说明服务职责和关键配置。新增中间件 TODO 列表，跟踪待补充的文档内容。更新 Keepalived 部署文档，新增主库抢占前置检查脚本和配置说明。优化中间件文档结构，补充常见问题和性能优化建议。 style: 统一文档格式和代码块样式 统一所有文档的代码块格式和标题层级。优化表格显示样式，增强可读性。规范环境变量和配置项的显示方式。调整文档结构，确保逻辑清晰。修复部分拼写错误和格式问题。 chore: 新增 LICENSE 文件 新增内部通讯技能的 Apache 2.0 LICENSE 文件。补充文档版权信息。更新文件头部的元数据描述。规范文件命名和目录结构。
32 lines
1.9 KiB
Markdown
32 lines
1.9 KiB
Markdown
# Service Name: g3fo-exchange-fix-engine-service
|
|
|
|
## 1. Overview
|
|
g3fo-exchange-fix-engine-service 是 g3fo 系统的 FIX 协议接入引擎。它负责与外部交易所或交易对手建立 FIX 连接，进行消息的编码、解码、序列号维护以及消息的持久化存储。
|
|
|
|
## 2. Key Responsibilities
|
|
- **会话管理**: 维护与外部实体的 FIX 会话，处理 Logon, Logout, Heartbeat, ResendRequest 等协议级消息。
|
|
- **消息路由**: 将接收到的 FIX 消息转换为内部业务格式并转发给下游服务，同时将下游服务的指令转换为 FIX 消息发送给外部。
|
|
- **消息持久化**: 记录所有发送和接收的 FIX 消息，确保在异常重启后能够恢复会话状态。
|
|
- **高可用 (HA)**: 支持基于 Redis 选举和 MySQL 共享存储的多实例部署。
|
|
|
|
## 3. Key Data Entities
|
|
- **FIX 消息存储**: 存储在 MySQL 中的 `messages` 表（基于 JdbcStore）。
|
|
- **FIX 会话状态**: 存储在 MySQL 中的 `sessions` 表。
|
|
|
|
## 4. Dependencies
|
|
- **Upstream**: `g3fo-trade-service` (发送交易指令)
|
|
- **Downstream**: 外部交易所 FIX Gateway
|
|
- **Middleware**:
|
|
- **MySQL**: 用于消息持久化。
|
|
- **Redis**: 用于分布式锁选举。
|
|
- **RocketMQ**: 用于与其他微服务通信。
|
|
|
|
## 5. Critical Configurations
|
|
- **QuickFIX/J 配置**: `quick-fix-client.yml` 中定义的会话参数、存储类型、选举参数等。
|
|
- **Nacos**: 动态配置中心，存储服务运行参数。
|
|
|
|
## 6. Common Operations / Troubleshooting
|
|
- **高可用架构说明**: 详细的 HA 方案请参考 [FIX Engine 高可用 (HA) 架构方案说明文档](./fix-engine/ha-architecture.md)。
|
|
- **日志监控**: 重点关注 `LeaderElectionService` 的选举日志和 `quickfix.JdbcStore` 的数据库操作日志。
|
|
- **会话重置**: 手动重置序列号通常需要清理数据库中的 `sessions` 表对应记录并重启服务。
|