From 67cfbeb572eed3ebde71fdda1a21a41f4d1cd447 Mon Sep 17 00:00:00 2001 From: "zhiye.sun" Date: Thu, 21 May 2026 13:46:57 +0800 Subject: [PATCH] =?UTF-8?q?docs:=E6=9B=B4=E6=96=B0=E6=9E=B6=E6=9E=84?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E4=BB=A5=E5=8F=8D=E6=98=A0=E5=BD=93=E5=89=8D?= =?UTF-8?q?=E4=BB=A3=E7=A0=81=E5=AE=9E=E9=99=85=E7=8A=B6=E6=80=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit AGENT.md、README.md、ARCHITECTURE.md、ROADMAP.md 已根据最新代码更新: - 补充 DTO 层、统一返回体、全局异常处理、审计自动填充等已完成项 - 更新前端控制台架构描述与页面实现状态 - 调整 RAG 模块状态描述(元数据层已完成,业务闭环待建设) - 移除 docs 目录的 .gitignore 排除规则 Co-Authored-By: Claude Opus 4.6 --- .gitignore | 1 - AGENT.md | 121 ++--- README.md | 116 +++-- docs/ARCHITECTURE.md | 155 +++++++ docs/ROADMAP.md | 122 ++++++ .../2026-05-18-dto-request-result-refactor.md | 414 ------------------ .../2026-05-19-vue3-frontend-framework.md | 92 ++++ 7 files changed, 511 insertions(+), 510 deletions(-) create mode 100644 docs/ARCHITECTURE.md create mode 100644 docs/ROADMAP.md delete mode 100644 docs/superpowers/plans/2026-05-18-dto-request-result-refactor.md create mode 100644 docs/superpowers/plans/2026-05-19-vue3-frontend-framework.md diff --git a/.gitignore b/.gitignore index 16e5207..05b577b 100644 --- a/.gitignore +++ b/.gitignore @@ -31,5 +31,4 @@ build/ ### VS Code ### .vscode/ -/docs/ src/main/resources/application-dev.yaml diff --git a/AGENT.md b/AGENT.md index e44f1f7..e16d3ec 100644 --- a/AGENT.md +++ b/AGENT.md @@ -11,22 +11,22 @@ - 文件上传与附件管理 - 前后端统一的管理控制台 -当前阶段以“先搭平台骨架,再逐步补智能能力”为主,优先保证工程结构、接口规范、知识库链路和可扩展性。 +当前阶段以"先搭平台骨架,再逐步补智能能力"为主,优先保证工程结构、接口规范、知识库链路和可扩展性。 ## 2. 总体设计思路 -平台整体按“接入层 - 应用层 - 领域层 - 基础设施层”拆分: +平台整体按"接入层 - 应用层 - 领域层 - 基础设施层"拆分: -- 接入层 - 提供 REST API、后续可扩展 WebSocket / SSE,用于前端控制台和外部系统接入。 +- **接入层** + 提供 REST API,后续可扩展 WebSocket / SSE,用于前端控制台和外部系统接入。 -- 应用层 +- **应用层** 负责请求编排、DTO 转换、统一返回体、会话协调和 Agent 调度入口。 -- 领域层 +- **领域层** 承载核心业务对象,如系统枚举、附件、知识库、知识文档、Agent 配置、任务执行记录等。 -- 基础设施层 +- **基础设施层** 负责数据库访问、文件存储、模型调用、向量检索、日志、缓存和第三方工具适配。 ## 3. 核心模块规划 @@ -35,18 +35,22 @@ 用于支撑整个平台的通用能力: -- `sys_enum`:系统枚举配置 -- `sys_attachment`:附件与文件上传 -- 统一 DTO / `RequestResult` -- 通用状态枚举、启用禁用枚举 +- `sys_enum`:系统枚举配置(已完成 CRUD、批量新增、管理端查询) +- `sys_attachment`:附件与文件上传(已完成本地上传、元数据持久化) +- 统一 DTO / `RequestResult`(已完成) +- 通用状态枚举、启用禁用枚举(已完成) +- 全局异常处理 `GlobalExceptionHandler`(已完成) +- 公共审计字段自动填充 `EntityAuditMetaObjectHandler`(已完成) - 后续可补用户、权限、审计等基础能力 ### 3.2 RAG 知识库模块 -当前已经有初步表设计与 Java 骨架: +当前已有完整的元数据管理层: -- `rag_store`:知识库主表 -- `rag_document`:知识库文档表 +- `rag_store`:知识库主表(已完成 CRUD、编码唯一性校验) +- `rag_document`:知识库文档表(已完成实体、Mapper、Service、条件查询) +- RAG 解析状态枚举 `RagParseStatusEnum`(已完成) +- RAG 索引状态枚举 `RagIndexStatusEnum`(已完成) 后续计划继续扩展: @@ -58,7 +62,7 @@ 当前设计原则: - 文件物理信息放在 `sys_attachment` -- 业务归属关系通过 `source_type`、`source_id` 或文档关联字段承接 +- 业务归属关系通过 `storeId`、`attachmentId` 关联 - RAG 领域代码独立放在 `com.bruce.rag` ### 3.3 Agent 运行模块 @@ -82,52 +86,61 @@ ### 3.4 管理控制台模块 -当前已经建立基于 Vue 3、Vite、Element Plus 的前端控制台基础骨架。 +当前已建立基于 Vue 3、Vite、TypeScript、Element Plus 的前端控制台。 已具备的页面与布局: -- 左侧管理菜单与品牌区 -- 工作台入口 -- 系统枚举管理页 -- 附件管理入口 -- 知识库入口 -- 知识文档入口 +- 左侧管理菜单与品牌区(232px 侧边栏) +- 工作台(占位) +- 系统枚举管理页(完整 CRUD + 批量新增) +- 附件管理入口(占位) +- 知识库管理页(完整 CRUD + 双栏详情) +- 知识文档入口(占位) + +前端技术要点: + +- Composition API + `