Develop/AIclinicalresearch
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(aia): Complete AIA V2.0 with universal streaming capabilities

Browse Source 
Major Changes:
- Add StreamingService with OpenAI Compatible format
- Upgrade Chat component V2 with Ant Design X integration
- Implement AIA module with 12 intelligent agents
- Update API routes to unified /api/v1 prefix
- Update system documentation

Backend (~1300 lines):
- common/streaming: OpenAI Compatible adapter
- modules/aia: 12 agents, conversation service, streaming integration
- Update route versions (RVW, PKB to v1)

Frontend (~3500 lines):
- modules/aia: AgentHub + ChatWorkspace (100% prototype restoration)
- shared/Chat: AIStreamChat, ThinkingBlock, useAIStream Hook
- Update API endpoints to v1

Documentation:
- AIA module status guide
- Universal capabilities catalog
- System overview updates
- All module documentation sync

Tested: Stream response verified, authentication working
Status: AIA V2.0 core completed (85%)
This commit is contained in:
HaHafeng
2026-01-14 19:15:01 +08:00
parent 3d35e9c58b
commit 1b53ab9d52
386 changed files with 52096 additions and 65238 deletions
Download Patch File Download Diff File Expand all files Collapse all files

189
docs/04-开发规范/README.md
View File

@@ -1,17 +1,14 @@
# 04-开发规范
> **目标：** 统一团队开发规范，提高代码质量和协作效率
> **适用范围：** 平台层 + 能力层 + 业务模块层
> **强制等级：** ⭐⭐⭐⭐⭐ 必须遵守
# 04-寮€鍙戣<EFBFBD>鑼?
> **鐩<>爣锛?* 缁熶竴鍥㈤槦寮€鍙戣<E98D99>鑼冿紝鎻愰珮浠ｇ爜璐ㄩ噺鍜屽崗浣滄晥鐜?
> **閫傜敤鑼冨洿锛?* 骞冲彴灞?+ 鑳藉姏灞?+ 涓氬姟妯″潡灞?
> **寮哄埗绛夌骇锛?* 猸愨瓙猸愨瓙猸?蹇呴』閬靛畧
---
## 馃搵 瑙勮寖鏂囨。鍒楄〃
### 1. 数据库设计规范 ⭐⭐⭐⭐⭐
**文件：** `01-数据库设计规范.md` ⏳ 待创建（从 `01-设计文档/数据库设计文档.md` 提取）
**核心内容：**
### 1. 鏁版嵁搴撹<EFBFBD>璁¤<EFBFBD>鑼?猸愨瓙猸愨瓙猸?**鏂囦欢锛?* `01-鏁版嵁搴撹<E690B4>璁¤<E79281>鑼?md` 鈴?寰呭垱寤猴紙浠?`01-璁捐<E79281>鏂囨。/鏁版嵁搴撹<E690B4>璁℃枃妗?md` 鎻愬彇锛?
**鏍稿績鍐呭<EFBFBD>锛?*
- Schema闅旂<E99785>绛栫暐锛坧latform_schema銆乤sl_schema绛夛級
- 琛ㄥ懡鍚嶈<E98D9A>鑼冿紙灏忓啓+涓嬪垝绾匡級
- 瀛楁<E7809B>鍛藉悕瑙勮寖
@@ -19,55 +16,41 @@
- 澶栭敭绾︽潫瑙勮寖
- 閫氱敤瀛楁<E7809B>锛坈reated_at銆乽pdated_at绛夛級
**快速参考：** [数据库全局视图](./03-数据库全局视图.md) ⭐ 已创建
**蹇<EFBFBD>€熷弬鑰冿細** [鏁版嵁搴撳叏灞€瑙嗗浘](./03-鏁版嵁搴撳叏灞€瑙嗗浘.md) 猸?宸插垱寤?
---
### 2. API设计规范 ⭐⭐⭐⭐⭐
**文件：** `02-API设计规范.md` ⏳ 待创建（从 `01-设计文档/API设计规范.md` 提取）
**核心内容：**
### 2. API璁捐<EFBFBD>瑙勮寖 猸愨瓙猸愨瓙猸?**鏂囦欢锛?* `02-API璁捐<E79281>瑙勮寖.md` 鈴?寰呭垱寤猴紙浠?`01-璁捐<E79281>鏂囨。/API璁捐<E79281>瑙勮寖.md` 鎻愬彇锛?
**鏍稿績鍐呭<EFBFBD>锛?*
- RESTful API璁捐<E79281>鍘熷垯
- URL命名规范（`/api/v1/模块/资源`）
- HTTP方法使用规范
- URL鍛藉悕瑙勮寖锛坄/api/v1/妯″潡/璧勬簮`锛?- HTTP鏂规硶浣跨敤瑙勮寖
- 璇锋眰/鍝嶅簲鏍煎紡瑙勮寖
- 错误码设计
- 认证和权限
**快速参考：** [API路由总览](./04-API路由总览.md) ⭐ 已创建
- 閿欒<EFBFBD>鐮佽<EFBFBD>璁?- 璁よ瘉鍜屾潈闄?
**蹇<>€熷弬鑰冿細** [API璺<EFBFBD>敱鎬昏<EFBFBD>](./04-API璺<49>敱鎬昏<E98EAC>.md) 猸?宸插垱寤?
---
### 3. 数据库全局视图 ⭐⭐⭐⭐⭐ ✅ 新增
**文件：** `03-数据库全局视图.md`
### 3. 鏁版嵁搴撳叏灞€瑙嗗浘 猸愨瓙猸愨瓙猸?鉁?鏂板<E98F82>
**鏂囦欢锛?* `03-鏁版嵁搴撳叏灞€瑙嗗浘.md`
**用途：** 提供所有Schema和表的快速索引
**核心内容：**
- Schema划分策略（8个Schema）
- 所有表的总览和跳转链接
- 跨Schema依赖关系
- 数据量预估
**使用场景：**
**鐢ㄩ€旓細** 鎻愪緵鎵€鏈塖chema鍜岃〃鐨勫揩閫熺储寮?
**鏍稿績鍐呭<E98D90>锛?*
- Schema鍒掑垎绛栫暐锛?涓猄chema锛?- 鎵€鏈夎〃鐨勬€昏<E282AC>鍜岃烦杞<E783A6>摼鎺?- 璺⊿chema渚濊禆鍏崇郴
- 鏁版嵁閲忛<EFBFBD>浼?
**浣跨敤鍦烘櫙锛?*
- 鏌ョ湅鍏ㄥ眬鏁版嵁鏋舵瀯
- 蹇<>€熷畾浣嶆煇涓<E78587>〃灞炰簬鍝<E7B0AC>釜Schema
- 了解跨模块数据关系
- 浜嗚В璺ㄦā鍧楁暟鎹<EFBFBD>叧绯?
---
### 4. API路由总览 ⭐⭐⭐⭐⭐ ✅ 新增
**文件：** `04-API路由总览.md`
### 4. API璺<EFBFBD>敱鎬昏<EFBFBD> 猸愨瓙猸愨瓙猸?鉁?鏂板<E98F82>
**鏂囦欢锛?* `04-API璺<EFBFBD>敱鎬昏<EFBFBD>.md`
**用途：** 提供所有API端点的快速索引
**核心内容：**
**鐢ㄩ€旓細** 鎻愪緵鎵€鏈堿PI绔<EFBFBD>偣鐨勫揩閫熺储寮?
**鏍稿績鍐呭<E98D90>锛?*
- 璺<>敱鍛藉悕瑙勮寖
- 鎵€鏈夋ā鍧楃殑API绔<49>偣鎬昏<E98EAC>
- 路由冲突检查
- 端点统计（~85个）
- 璺<EFBFBD>敱鍐茬獊妫€鏌?- 绔<>偣缁熻<E7BC81>锛垀85涓<35>級
**使用场景：**
**浣跨敤鍦烘櫙锛?*
- 鏌ョ湅鍏ㄥ眬API鏋舵瀯
- 閬垮厤璺<E58EA4>敱鍐茬獊
- 蹇<>€熸煡鎵炬煇涓<E78587>姛鑳界殑API绔<49>偣
@@ -75,36 +58,29 @@
---
### 5. 浠ｇ爜瑙勮寖 猸愨瓙猸愨瓙
**文件：** `05-代码规范.md` → 重命名自 `代码规范.md`（已存在，818行）
**鏂囦欢锛?* `05-浠ｇ爜瑙勮寖.md` 鈫?閲嶅懡鍚嶈嚜 `浠ｇ爜瑙勮寖.md`锛堝凡瀛樺湪锛?18琛岋級
**核心内容：**
**鏍稿績鍐呭<EFBFBD>锛?*
- TypeScript缂栫爜瑙勮寖
- React缁勪欢瑙勮寖
- 文件和目录命名
- 代码注释规范
- 鏂囦欢鍜岀洰褰曞懡鍚?- 浠ｇ爜娉ㄩ噴瑙勮寖
- 閿欒<E996BF>澶勭悊瑙勮寖
- 鏃ュ織璁板綍瑙勮寖
**宸叉湁鍐呭<E98D90>锛屽寘鍚<E5AF98>細**
- ESLint閰嶇疆
- Prettier閰嶇疆
- 详细的编码规范
- 璇︾粏鐨勭紪鐮佽<EFBFBD>鑼?
---
### 6. Git提交规范 ⭐⭐⭐⭐⭐ ✅ 已完成
**文件：** `06-Git提交规范.md`
### 6. Git鎻愪氦瑙勮寖 猸愨瓙猸愨瓙猸?鉁?宸插畬鎴?**鏂囦欢锛?* `06-Git鎻愪氦瑙勮寖.md`
**核心内容：**
- 远程仓库配置（Gitee）
- Commit Message格式规范
**鏍稿績鍐呭<EFBFBD>锛?*
- 杩滅▼浠撳簱閰嶇疆锛圙itee锛?- Commit Message鏍煎紡瑙勮寖
- 鍒嗘敮绠＄悊绛栫暐
- 中文编码问题解决方案 ⭐ 重要
- Git历史重写与维护
- PR/MR规范和代码审查流程
- 常见问题与最佳实践
**包含实用工具：**
- 涓<EFBFBD>枃缂栫爜闂<EFBFBD><EFBFBD>瑙ｅ喅鏂规<EFBFBD> 猸?閲嶈<E996B2>
- Git鍘嗗彶閲嶅啓涓庣淮鎶?- PR/MR瑙勮寖鍜屼唬鐮佸<E990AE>鏌ユ祦绋?- 甯歌<E794AF>闂<EFBFBD><E99782>涓庢渶浣冲疄璺?
**鍖呭惈瀹炵敤宸ュ叿锛?*
- `fix-git-commit-messages.ps1` 鑴氭湰浣跨敤璇存槑
- Git 鍒<>悕閰嶇疆
- 涓<>枃涔辩爜淇<E7889C><E6B787>瀹屾暣娴佺▼
@@ -113,22 +89,19 @@
```
<type>(<scope>): <subject>
feat: 新功能 fix: Bug修复 docs: 文档
feat: 鏂板姛鑳? fix: Bug淇<EFBFBD><EFBFBD> docs: 鏂囨。
style: 鏍煎紡 refactor: 閲嶆瀯 perf: 浼樺寲
test: 娴嬭瘯 chore: 鏋勫缓 ci: CI/CD
```
---
### 7. 测试规范 ⭐⭐⭐
**文件：** `07-测试规范.md` ⏳ 待创建
**核心内容：**
### 7. 娴嬭瘯瑙勮寖 猸愨瓙猸?**鏂囦欢锛?* `07-娴嬭瘯瑙勮寖.md` 鈴?寰呭垱寤?
**鏍稿績鍐呭<EFBFBD>锛?*
- 鍗曞厓娴嬭瘯瑙勮寖
- 闆嗘垚娴嬭瘯瑙勮寖
- E2E娴嬭瘯瑙勮寖
- 测试覆盖率要求
- 娴嬭瘯瑕嗙洊鐜囪<EFBFBD>姹?
**娴嬭瘯瑕嗙洊鐜囪<E9909C>姹傦細**
- 鏍稿績涓氬姟閫昏緫锛氣墺80%
- 宸ュ叿鍑芥暟锛氣墺90%
@@ -136,83 +109,63 @@ test: 测试 chore: 构建 ci: CI/CD
---
## 🎯 规范优先级
## 馃幆 瑙勮寖浼樺厛绾?
### P0 - 蹇呴』閬靛畧
- ✅ 数据库设计规范
- ✅ API设计规范
- ✅ Git提交规范（Commit Message）
- 鉁?鏁版嵁搴撹<E690B4>璁¤<E79281>鑼?- 鉁?API璁捐<E79281>瑙勮寖
- 鉁?Git鎻愪氦瑙勮寖锛圕ommit Message锛?
### P1 - 寮虹儓寤鸿<E5AFA4>
- ✅ 代码规范（TypeScript/React）
- ✅ 错误处理规范
- ✅ 日志记录规范
- 鉁?浠ｇ爜瑙勮寖锛圱ypeScript/React锛?- 鉁?閿欒<E996BF>澶勭悊瑙勮寖
- 鉁?鏃ュ織璁板綍瑙勮寖
### P2 - 寤鸿<E5AFA4>閬靛畧
- ⚪ 测试规范
- ⚪ 文档注释规范
- ⚪ 性能优化规范
- 鈿?娴嬭瘯瑙勮寖
- 鈿?鏂囨。娉ㄩ噴瑙勮寖
- 鈿?鎬ц兘浼樺寲瑙勮寖
---
## 🔍 快速查找
**我要设计数据库表：** → `01-数据库设计规范.md`
**我要设计API接口：** → `02-API设计规范.md`
**我要查看全局数据架构：** → `03-数据库全局视图.md` ✅
**我要查看全局API路由：** → `04-API路由总览.md` ✅
**我要编写代码：** → `05-代码规范.md` ✅
**我要提交代码：** → `06-Git提交规范.md` ✅
**我要解决中文乱码：** → `06-Git提交规范.md` (第4节) ✅
**我要配置远程仓库：** → `06-Git提交规范.md` (第1节) ✅
**我要编写测试：** → `07-测试规范.md`
## 馃攳 蹇<>€熸煡鎵?
**鎴戣<E98EB4>璁捐<E79281>鏁版嵁搴撹〃锛?* 鈫?`01-鏁版嵁搴撹<E690B4>璁¤<E79281>鑼?md`
**鎴戣<EFBFBD>璁捐<EFBFBD>API鎺ュ彛锛?* 鈫?`02-API璁捐<E79281>瑙勮寖.md`
**鎴戣<EFBFBD>鏌ョ湅鍏ㄥ眬鏁版嵁鏋舵瀯锛?* 鈫?`03-鏁版嵁搴撳叏灞€瑙嗗浘.md` 鉁?
**鎴戣<EFBFBD>鏌ョ湅鍏ㄥ眬API璺<EFBFBD>敱锛?* 鈫?`04-API璺<49>敱鎬昏<E98EAC>.md` 鉁?
**鎴戣<EFBFBD>缂栧啓浠ｇ爜锛?* 鈫?`05-浠ｇ爜瑙勮寖.md` 鉁?
**鎴戣<EFBFBD>鎻愪氦浠ｇ爜锛?* 鈫?`06-Git鎻愪氦瑙勮寖.md` 鉁?
**鎴戣<EFBFBD>瑙ｅ喅涓<EFBFBD>枃涔辩爜锛?* 鈫?`06-Git鎻愪氦瑙勮寖.md` (绗?鑺? 鉁?
**鎴戣<EFBFBD>閰嶇疆杩滅▼浠撳簱锛?* 鈫?`06-Git鎻愪氦瑙勮寖.md` (绗?鑺? 鉁?
**鎴戣<EFBFBD>缂栧啓娴嬭瘯锛?* 鈫?`07-娴嬭瘯瑙勮寖.md`
---
## ⚠️ 违反规范的后果
## 鈿狅笍 杩濆弽瑙勮寖鐨勫悗鏋?
### 鏁版嵁搴撹<E690B4>璁′笉瑙勮寖
- ❌ Schema混乱，模块耦合
- ❌ 无法实现模块独立部署
- ❌ 数据迁移困难
- 鉂?Schema娣蜂贡锛屾ā鍧楄€﹀悎
- 鉂?鏃犳硶瀹炵幇妯″潡鐙<E6BDA1>珛閮ㄧ讲
- 鉂?鏁版嵁杩佺Щ鍥伴毦
### API设计不规范
- ❌ 前后端对接困难
- ❌ API文档混乱
- ❌ 版本升级困难
### 代码不规范
- ❌ 代码可读性差
- ❌ 维护成本高
- ❌ Bug率上升
### API璁捐<EFBFBD>涓嶈<EFBFBD>鑼?- 鉂?鍓嶅悗绔<E68297><E7BB94>鎺ュ洶闅?- 鉂?API鏂囨。娣蜂贡
- 鉂?鐗堟湰鍗囩骇鍥伴毦
### 浠ｇ爜涓嶈<E6B693>鑼?- 鉂?浠ｇ爜鍙<E7889C><E98D99>鎬у樊
- 鉂?缁存姢鎴愭湰楂?- 鉂?Bug鐜囦笂鍗?
---
## 馃摑 瑙勮寖鏇存柊娴佺▼
1. 提出规范变更需求（Issue或PR）
2. 团队讨论和评审
3. 更新规范文档
1. 鎻愬嚭瑙勮寖鍙樻洿闇€姹傦紙Issue鎴朠R锛?2. 鍥㈤槦璁ㄨ<E79281>鍜岃瘎瀹?3. 鏇存柊瑙勮寖鏂囨。
4. 閫氱煡鍏ㄥ憳
5. 逐步迁移旧代码
5. 閫愭<EFBFBD>杩佺Щ鏃т唬鐮?
---
## 馃敆 鐩稿叧宸ュ叿
**浠ｇ爜妫€鏌ワ細**
- ESLint（JavaScript/TypeScript）
- Prettier（代码格式化）
- Stylelint（CSS）
- ESLint锛圝avaScript/TypeScript锛?- Prettier锛堜唬鐮佹牸寮忓寲锛?- Stylelint锛圕SS锛?
**鎻愪氦妫€鏌ワ細**
- Husky（Git Hooks）
- Commitlint（Commit Message检查）
- Husky锛圙it Hooks锛?- Commitlint锛圕ommit Message妫€鏌ワ級
**鏁版嵁搴擄細**
- Prisma（ORM + Migration）
- pgAdmin（数据库管理）
- Prisma锛圤RM + Migration锛?- pgAdmin锛堟暟鎹<E69A9F>簱绠＄悊锛?
---
**鏈€鍚庢洿鏂帮細** 2025-11-06