feat(contract): 新增合同余额功能及重构文件管理

重构合同文件管理逻辑，增加错误处理和日志记录新增ContractBalance实体、Repository和VO类完善Voable接口文档和实现规范更新项目架构文档和数据库设计修复SmbFileService的连接问题移动合同相关TabSkin类到contract包添加合同文件重建任务的WebSocket支持
2025-11-19 00:50:16 +08:00
parent 87290f15b0
commit 02afa189f8
49 changed files with 7577 additions and 441 deletions
--- a/PROJECT_DOCUMENTATION.md
+++ b/PROJECT_DOCUMENTATION.md
@@ -0,0 +1,113 @@
+# Contract-Manager 项目文档
+
+## 📁 文档结构总览
+
+```
+Contract-Manager/
+├── 📄 README.md                           # 项目总体介绍
+├── 📄 PROJECT_DOCUMENTATION.md           # 本文档 - 项目文档总览
+├── 📄 DEVELOPMENT_GUIDE.md               # 开发指南
+├── 📄 API_DOCUMENTATION.md               # API接口文档
+├── 📄 DEPLOYMENT_GUIDE.md                # 部署指南
+├── 📄 DATABASE_SCHEMA.md                 # 数据库设计文档
+│
+├── 📁 .trae/rules/                       # 技术规则和规范文档
+│   ├── 📄 server_service_rules.md         # 服务器端Service开发规范
+│   ├── 📄 server_repository_rules.md      # 服务器端Repository开发规范
+│   ├── 📄 client_service_rules.md         # 客户端Service开发规范
+│   ├── 📄 client_controller_rules.md      # 客户端Controller开发规范
+│   ├── 📄 vo_rules.md                     # VO对象规范
+│   ├── 📄 entity_rules.md                 # 实体对象规范
+│   └── 📄 ...其他规则文档
+│
+├── 📁 docs/                              # 项目文档目录
+│   ├── 📁 analysis/                       # 技术分析报告
+│   ├── 📁 task/                          # 任务相关文档
+│   ├── 📁 db/                            # 数据库脚本和设计
+│   ├── 📁 model/                         # 数据模型说明
+│   └── 📁 cloud/                         # 云服务集成文档
+│
+├── 📁 server/                            # 服务器端代码
+└── 📁 client/                            # 客户端代码
+```
+
+## 📚 核心文档说明
+
+### 1. 技术规则文档 (.trae/rules/)
+技术规则文档是项目的核心开发规范，定义了代码编写、设计模式、架构原则等：
+
+- **server_service_rules.md** - 服务器端Service层开发规范
+- **server_repository_rules.md** - 数据访问层开发规范
+- **client_service_rules.md** - 客户端Service层开发规范
+- **client_controller_rules.md** - 客户端控制器开发规范
+- **vo_rules.md** - 视图对象(VO)设计和实现规范
+- **entity_rules.md** - 实体对象设计和实现规范
+
+### 2. 项目文档 (docs/)
+项目文档包含具体的技术实现、任务分析和业务说明：
+
+- **analysis/** - 包含技术架构分析、性能优化、代码审查报告
+- **task/** - 包含具体的开发任务文档和执行记录
+- **db/** - 数据库表结构、脚本和迁移文件
+- **model/** - 数据模型说明和业务规则
+
+### 3. 待完善文档 (需要新建)
+
+#### 核心项目文档
+- **README.md** - 项目简介、快速开始指南
+- **DEVELOPMENT_GUIDE.md** - 开发环境搭建、开发流程指南
+- **API_DOCUMENTATION.md** - REST API接口完整文档
+- **DEPLOYMENT_GUIDE.md** - 项目部署、运维指南
+- **DATABASE_SCHEMA.md** - 数据库架构和表关系图
+
+#### 用户指南
+- **USER_MANUAL.md** - 最终用户使用手册
+- **UI_COMPONENT_GUIDE.md** - 客户端界面组件说明
+
+## 🎯 文档更新目标
+
+### 高优先级 (Core Documentation)
+1. **项目架构文档** - 技术栈、模块划分、架构设计
+2. **开发指南** - 环境配置、开发流程、代码规范
+3. **API文档** - 完整的接口定义和示例
+
+### 中优先级 (Functional Documentation)
+1. **数据库文档** - 表结构、关系图、数据字典
+2. **部署运维** - 安装配置、监控、日志管理
+3. **业务功能** - 功能说明、使用流程
+
+### 低优先级 (User Documentation)
+1. **用户手册** - UI使用指南、常见问题
+2. **开发进阶** - 性能优化、高级特性
+3. **集成指南** - 第三方服务集成
+
+## 📋 文档质量标准
+
+### 内容要求
+- **完整性** - 覆盖项目各个方面的完整信息
+- **准确性** - 信息准确、代码示例可运行
+- **时效性** - 定期更新，保持与代码同步
+- **可读性** - 结构清晰、语言简洁
+
+### 格式规范
+- **统一格式** - 使用Markdown格式，保持一致的样式
+- **目录结构** - 清晰的章节组织和目录导航
+- **代码示例** - 提供可执行的代码示例和配置
+- **图表说明** - 使用图表辅助说明复杂概念
+
+## 🚀 更新计划
+
+1. **第一阶段** - 核心文档完善 (高优先级)
+2. **第二阶段** - 功能文档补充 (中优先级)  
+3. **第三阶段** - 用户指南和最佳实践 (低优先级)
+
+## 📞 文档维护
+
+- **责任分工** - 各模块开发者负责对应文档的维护
+- **更新频率** - 代码变更时同步更新相关文档
+- **审核机制** - 重要文档变更需要技术负责人审核
+- **版本控制** - 文档版本与代码版本保持同步
+
+---
+
+*本文档将持续更新以反映项目的最新状态和最佳实践。*