# XINxiangqin 项目快速参考手册

> 快速查找项目关键信息，方便日常开发使用

---

## 🚀 快速启动

### 启动顺序
```
1. MySQL + Redis + MinIO
2. common模块
3. Essential(1005) → HomePage(8081) → Dynamic(8086) → WebSocket(1004) → RandomMatch(1003) → Recommend(8089) → Admin(8088)
4. Gateway(8083) - 最后启动
5. 前端: marriageAdmin-vue (npm run dev)
```

---

## 📍 服务端口速查

| 服务 | 端口 | 说明 |
|------|------|------|
| Gateway | 8083 | 统一入口 |
| HomePage | 8081 | 首页 |
| Dynamic | 8086 | 动态 |
| WebSocket | 1004 | 聊天 |
| RandomMatch | 1003 | 匹配 |
| Essential | 1005 | 用户基础 |
| Recommend | 8089 | 推荐 |
| Admin | 8088 | 管理端 |

---

## 🔗 常用路由速查

| 路由 | 服务 | 说明 |
|------|------|------|
| `/admin/**` | Admin(8088) | 管理端 |
| `/api/admin/**` | Admin(8088) | 管理API |
| `/api/user/**` | Essential(1005) | 用户服务 |
| `/api/dynamic/**` | Dynamic(8086) | 动态服务 |
| `/api/chat/**` | WebSocket(1004) | 聊天API |
| `/ws/chat/**` | WebSocket(1004) | WebSocket |
| `/match/**` | RandomMatch(1003) | 匹配服务 |
| `/api/recommend/**` | Recommend(8089) | 推荐服务 |
| `/api/course/**` | HomePage(8081) | 课程服务 |

---

## 📁 关键文件位置

### 配置文件
- 网关路由: `gateway/src/main/resources/application.yml`
- 小程序API: `LiangZhiYUMao/config/api-config.js`
- 管理后台API: `marriageAdmin-vue/src/config/api.js`
- 小程序路由: `LiangZhiYUMao/pages.json`
- 管理后台路由: `marriageAdmin-vue/src/router/index.js`

### 核心代码
- 公共实体: `common/src/main/java/com/zhentao/pojo/`
- 小程序API封装: `LiangZhiYUMao/utils/api.js`
- 管理后台请求: `marriageAdmin-vue/src/utils/request.js`

---

## 🔑 第三方API配置

### 天行数据API
- 配置文件: `LiangZhiYUMao/config/api-config.js`
- API Key: `TIANAPI_CONFIG.API_KEY`
- 用途: 星座、生肖、八字

### 极速数据API
- 配置文件: `LiangZhiYUMao/config/api-config.js`
- API Key: `BAZI_API_CONFIG.JISU_API.API_KEY`
- 用途: 专业八字排盘

---

## 🗄️ 核心数据表

| 表名 | 说明 | 位置 |
|------|------|------|
| `users` | 用户主表 | Essential服务 |
| `user_profile` | 用户扩展信息 | Essential服务 |
| `user_dynamics` | 用户动态 | Dynamic服务 |
| `chat_messages` | 聊天消息 | WebSocket服务 |
| `activities` | 活动 | HomePage服务 |
| `matchmakers` | 红娘 | HomePage服务 |
| `admin_users` | 管理员 | Admin服务 |

---

## 🐛 常见问题排查

| 问题 | 检查项 |
|------|--------|
| 跨域 | 网关CORS配置 |
| 路由404 | 网关路由顺序 |
| Token失效 | Redis连接 |
| API失败 | 服务端口+路由 |
| 文件上传 | MinIO配置 |

---

## 📝 代码规范

### 后端
- Controller层: RESTful风格
- Service层: 业务逻辑
- Mapper层: 数据访问
- 统一响应: `{code, message, data}`

### 前端
- 小程序: uni-app规范
- 管理后台: Vue3 Composition API
- API调用: 统一封装

---

## 🔐 安全机制

- 手机号: AES-256加密
- 密码: bcrypt哈希
- Token: JWT + Redis
- CORS: 网关统一处理

---

## 📊 项目规模

- 后端服务: 8个微服务 + 1个网关
- 前端页面: 小程序50+，管理后台30+
- 数据库表: 30+
- API接口: 200+

---

## 🎯 修改建议优先级

### 高优先级 🔴
1. 统一异常处理
2. API版本控制
3. 参数校验统一
4. 日志规范统一

### 中优先级 🟡
1. 服务注册发现（Nacos）
2. 配置中心（Nacos Config）
3. API文档（Swagger）

### 低优先级 🟢
1. 监控体系
2. 测试覆盖
3. 功能扩展

---

## 📚 相关文档

- `项目全面分析报告.md` - 详细分析
- `项目架构分析报告.md` - 架构分析
- `技术栈快速参考.md` - 技术栈

---

**最后更新**: 2025-01-27