139 lines
3.3 KiB
Markdown
139 lines
3.3 KiB
Markdown
# 工作文档目录
|
||
|
||
本目录包含QAUP项目的工作文档、设计方案和配置说明。
|
||
|
||
---
|
||
|
||
## 📋 文档列表
|
||
|
||
### 配置管理相关
|
||
|
||
#### 1. [配置文件重构说明](./20250110_配置文件重构说明.md) ⭐ **主文档**
|
||
|
||
**状态**: 🔄 配置文件已完成，启动脚本待更新
|
||
|
||
**内容**:
|
||
- 配置文件重构完整说明
|
||
- 开发/生产环境配置分离方案
|
||
- 环境变量支持方案
|
||
- 使用指南和FAQ
|
||
|
||
**适用场景**:
|
||
- 了解配置文件结构
|
||
- 开发环境配置说明
|
||
- 生产环境部署指南
|
||
|
||
#### 2. [环境变量配置方案](./20250110_环境变量配置方案.md)
|
||
|
||
**状态**: ✅ 完整方案文档
|
||
|
||
**内容**:
|
||
- 环境变量原理和使用方式
|
||
- 启动脚本修改详细步骤
|
||
- `.env` 文件管理最佳实践
|
||
- 故障排查指南
|
||
|
||
**适用场景**:
|
||
- 生产环境部署
|
||
- 配置修改操作
|
||
- 启动脚本更新参考
|
||
|
||
### 功能设计相关
|
||
|
||
#### 3. [任务清单接口设计方案](./20250110_任务清单接口设计方案.md)
|
||
|
||
**状态**: 📝 设计方案（待实施）
|
||
|
||
**内容**:
|
||
- 任务清单接口API设计
|
||
- 数据结构定义
|
||
- Mock服务实现方案
|
||
- 5个任务模板示例
|
||
|
||
**适用场景**:
|
||
- 无人车任务管理功能开发
|
||
- Mock服务扩展
|
||
|
||
---
|
||
|
||
## 🚀 快速导航
|
||
|
||
### 场景1: 开发环境配置
|
||
|
||
1. 阅读 [配置文件重构说明 - 开发环境](./20250110_配置文件重构说明.md#开发环境)
|
||
2. 在IDEA中直接启动即可（默认使用dev配置）
|
||
|
||
### 场景2: 生产环境部署
|
||
|
||
1. 阅读 [配置文件重构说明 - 生产环境](./20250110_配置文件重构说明.md#生产环境)
|
||
2. 参考 [环境变量配置方案](./20250110_环境变量配置方案.md) 更新启动脚本
|
||
3. 创建 `.env` 文件并配置环境变量
|
||
4. 启动应用
|
||
|
||
### 场景3: 修改生产环境配置
|
||
|
||
1. 编辑 `.env` 文件
|
||
2. 执行 `./qaup.sh restart`
|
||
3. 无需重新打包jar
|
||
|
||
### 场景4: 实现任务清单功能
|
||
|
||
1. 阅读 [任务清单接口设计方案](./20250110_任务清单接口设计方案.md)
|
||
2. 按照方案实施
|
||
|
||
---
|
||
|
||
## ⚠️ 当前待完成工作
|
||
|
||
### 高优先级
|
||
|
||
1. **更新启动脚本 qaup.sh**
|
||
- 添加环境变量加载功能
|
||
- 添加 profile 指定
|
||
- 参考: [环境变量配置方案 - Step 2](./20250110_环境变量配置方案.md#step-2-修改启动脚本-qaupsh)
|
||
|
||
2. **测试验证配置重构**
|
||
- 开发环境启动测试
|
||
- 生产环境打包测试
|
||
- 环境变量加载测试
|
||
|
||
### 中优先级
|
||
|
||
3. **更新项目文档**
|
||
- 更新 `README.md`
|
||
- 更新 `CLAUDE.md`
|
||
- 添加部署文档
|
||
|
||
4. **实现任务清单接口**
|
||
- 在 `mock_unmanned_vehicle.py` 中实现
|
||
- 测试验证
|
||
|
||
---
|
||
|
||
## 📚 相关资源
|
||
|
||
### 项目文档
|
||
|
||
- [CLAUDE.md](../../CLAUDE.md) - 项目总体说明
|
||
- [README.md](../../README.md) - 项目介绍
|
||
|
||
### Spring Boot官方文档
|
||
|
||
- [外部化配置](https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config)
|
||
- [配置属性](https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html)
|
||
|
||
---
|
||
|
||
## 📝 文档版本记录
|
||
|
||
| 日期 | 文档 | 版本 | 说明 |
|
||
|-----|------|------|------|
|
||
| 2025-01-10 | 配置文件重构说明 | v1.0 | 初版 |
|
||
| 2025-01-10 | 环境变量配置方案 | v1.0 | 初版 |
|
||
| 2025-01-10 | 任务清单接口设计方案 | v1.0 | 初版 |
|
||
|
||
---
|
||
|
||
**最后更新**: 2025-01-10
|
||
**维护者**: QAUP Team
|