feat(phase1): 完成全局完善和基础设施文档
Task 6.1: 统一异常处理
- 创建 GlobalExceptionHandler:Spring 全局异常拦截器
- SessionNotFoundException: 404 会话未找到
- DocumentProcessException: 400 文档处理异常
- MaxUploadSizeExceededException: 400 文件大小超限
- IllegalArgumentException: 400 参数错误
- Exception: 500 系统异常兜底
- 统一响应格式:Result<T> + HTTP 状态码
Task 6.2: Docker Compose 配置
- 创建 docker-compose.yml:本地开发环境一键启动
- MySQL 8.0: 数据持久化,端口 3306
- Redis 7: 会话缓存,端口 6379
- Milvus Standalone: 向量索引,端口 19530
- etcd: 元数据存储
- MinIO: 对象存储
- 数据卷持久化:mysql-data, redis-data, milvus-data
- 健康检查:自动重启机制
Task 6.3: 更新 README.md
- 新增 Phase 1 专属章节:
- 架构概览(已完成功能清单)
- 本地开发环境(前置要求、快速开始)
- 数据库迁移(Flyway 脚本说明)
- API 文档(文档管理接口示例)
- 项目结构(分层架构说明)
- 待办事项(向量化索引、混合检索)
- 技术决策(包名重构、文本格式、分块策略)
编译验证:BUILD SUCCESS
Progress: 31/33 tasks completed (94%)
This commit is contained in:
@@ -190,6 +190,163 @@ curl http://localhost:9900/milvus/health
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Phase 1: 基础设施搭建(已完成)
|
||||
|
||||
### 架构概览
|
||||
|
||||
Phase 1 完成了项目的基础设施搭建,包括:
|
||||
- ✅ 数据持久化层(MySQL + JPA + Flyway)
|
||||
- ✅ 会话管理(Redis)
|
||||
- ✅ 向量索引(Milvus 集成)
|
||||
- ✅ 文档管理服务(上传/查询/删除)
|
||||
- ✅ 统一异常处理
|
||||
- ✅ RESTful API 接口
|
||||
|
||||
### 本地开发环境
|
||||
|
||||
#### 前置要求
|
||||
|
||||
- Java 17+
|
||||
- Maven 3.8+
|
||||
- Docker & Docker Compose(用于本地数据库)
|
||||
|
||||
#### 快速开始
|
||||
|
||||
**1. 启动依赖服务**
|
||||
|
||||
```bash
|
||||
# 启动 MySQL + Redis + Milvus(本地开发)
|
||||
docker-compose up -d
|
||||
|
||||
# 查看服务状态
|
||||
docker-compose ps
|
||||
```
|
||||
|
||||
**2. 配置应用**
|
||||
|
||||
复制 `src/main/resources/application.yml` 并根据需要修改:
|
||||
|
||||
```yaml
|
||||
spring:
|
||||
datasource:
|
||||
url: jdbc:mysql://localhost:3306/super_biz_agent
|
||||
username: superbiz
|
||||
password: superbiz123
|
||||
|
||||
data:
|
||||
redis:
|
||||
host: localhost
|
||||
port: 6379
|
||||
password: redis123
|
||||
|
||||
milvus:
|
||||
host: localhost
|
||||
port: 19530
|
||||
```
|
||||
|
||||
**3. 运行应用**
|
||||
|
||||
```bash
|
||||
# 编译
|
||||
mvn clean compile
|
||||
|
||||
# 运行测试
|
||||
mvn test
|
||||
|
||||
# 启动应用
|
||||
mvn spring-boot:run
|
||||
```
|
||||
|
||||
应用将在 `http://localhost:9900` 启动。
|
||||
|
||||
#### 数据库迁移
|
||||
|
||||
Flyway 会自动执行数据库迁移:
|
||||
|
||||
```
|
||||
src/main/resources/db/migration/
|
||||
├── V001__create_diagnosis_record.sql
|
||||
├── V002__create_case_library.sql
|
||||
└── V003__create_api_document.sql
|
||||
```
|
||||
|
||||
#### API 文档
|
||||
|
||||
**文档管理接口**:
|
||||
|
||||
```bash
|
||||
# 上传文档(仅支持 .md 和 .txt)
|
||||
POST /api/documents/upload
|
||||
Content-Type: multipart/form-data
|
||||
|
||||
# 查询文档
|
||||
GET /api/documents/{docId}
|
||||
GET /api/documents/status/{status}?page=0&size=20
|
||||
GET /api/documents/faultSource/{faultSource}
|
||||
|
||||
# 删除文档
|
||||
DELETE /api/documents/{docId}
|
||||
```
|
||||
|
||||
**健康检查**:
|
||||
|
||||
```bash
|
||||
# Milvus 连接测试
|
||||
mvn test -Dtest=SimpleMilvusTest
|
||||
|
||||
# MySQL 连接测试
|
||||
mvn test -Dtest=MySQLConnectionTest
|
||||
|
||||
# Redis 连接测试
|
||||
mvn test -Dtest=RedisConnectionTest
|
||||
```
|
||||
|
||||
### 项目结构
|
||||
|
||||
```
|
||||
com.superbiz.agent/
|
||||
├── controller/ # REST 控制器
|
||||
│ ├── ChatController.java
|
||||
│ ├── DocumentController.java
|
||||
│ └── FileUploadController.java
|
||||
├── service/ # 业务逻辑层
|
||||
│ ├── DocumentManagementService.java
|
||||
│ ├── TextExtractorService.java
|
||||
│ ├── session/ # 会话管理
|
||||
│ └── ...
|
||||
├── repository/ # 数据访问层
|
||||
│ ├── ApiDocumentRepository.java
|
||||
│ ├── CaseLibraryRepository.java
|
||||
│ └── DiagnosisRecordRepository.java
|
||||
├── domain/ # 领域模型
|
||||
│ ├── entity/ # JPA 实体
|
||||
│ ├── model/ # 数据模型
|
||||
│ └── enums/ # 枚举类
|
||||
├── dto/ # 数据传输对象
|
||||
├── exception/ # 异常处理
|
||||
│ ├── GlobalExceptionHandler.java
|
||||
│ ├── SessionNotFoundException.java
|
||||
│ └── DocumentProcessException.java
|
||||
└── config/ # 配置类
|
||||
```
|
||||
|
||||
### 待办事项
|
||||
|
||||
- [ ] 向量化索引实现(VectorIndexService.indexDocumentChunks)
|
||||
- [ ] 混合检索工具(精确匹配 + 语义检索 + RRF 融合)
|
||||
- [ ] 文档管理集成测试
|
||||
|
||||
### 技术决策
|
||||
|
||||
- **包名重构**:`org.example` → `com.superbiz.agent`
|
||||
- **文本格式**:仅支持 Markdown (.md) 和纯文本 (.txt),其他格式需外部转换服务
|
||||
- **分块策略**:使用 DocumentChunkService 的智能分块(按标题、段落边界)
|
||||
- **向量数据库**:生产环境推荐 Zilliz Cloud,本地开发可用 Docker Milvus
|
||||
|
||||
---
|
||||
|
||||
**版本**: v1.0.0
|
||||
**作者**: chief
|
||||
**许可证**: MIT
|
||||
|
||||
Reference in New Issue
Block a user