Kris
469c78cf29
REQ-010-1 完成内容： - 创建 6 个数据库表设计（datai_meta_org_config、datai_meta_task、datai_meta_job_execution、datai_meta_component、datai_meta_deploy_history、datai_meta_job_log） - 设计了合理的索引策略 - 对敏感字段进行了加密存储设计 - 表名前缀统一为 datai_meta_ - 所有表包含标准基础字段 REQ-010-2 完成内容： - 补充用户故事和细化验收标准 - 创建架构决策记录（MyBatis Plus 注解 + XML 映射文件混合方案） - 对比了 3 种备选方案 - 分析了决策对系统架构、开发流程、运维管理的影响 - 识别了技术风险、业务风险和实施风险 - 定义了回滚策略和验收标准 文档更新： - 创建 0010-database-table-design.md 架构决策记录 - 创建 0011-entity-mapper-create.md 架构决策记录 - 创建 0020-database-table-design-create.md 变更记录 - 创建 20260117-database-table-design-create.md 会话记录 - 创建 20260117-database-table-design-create-retro.md 复盘报告 - 创建 011-database-table-design-create.md 提示词文档 - 更新 REQ-010-2.md 需求文档 - 更新 docs/index.md 和 CHANGELOG.md
149 lines
5.1 KiB
Markdown
149 lines
5.1 KiB
Markdown
# Requirements - 元数据组件索引和查询
|
||
|
||
## 需求信息
|
||
|
||
- **需求名称**: 元数据组件索引和查询
|
||
- **需求类型**: 功能需求
|
||
- **需求编号**: REQ-010-11
|
||
- **父需求**: REQ-010
|
||
- **创建日期**: 2026-01-17
|
||
- **需求版本**: v1.0.0
|
||
- **需求提出人**: 系统管理员
|
||
- **需求状态**: 待审核
|
||
|
||
## 输入引用
|
||
|
||
引用相关的 docs 文档链接：
|
||
|
||
- [REQ-010.md](REQ-010.md) - Salesforce元数据拉取和部署主需求文档
|
||
- [REQ-010-1.md](REQ-010-1.md) - 数据库表结构设计和创建
|
||
- [REQ-010-2.md](REQ-010-2.md) - 基础实体类和Mapper创建
|
||
- [REQ-010-7.md](REQ-010-7.md) - 文件存储和解压处理
|
||
- [010-metadata-retrieve-deploy-sub-requirements.md](010-metadata-retrieve-deploy-sub-requirements.md) - REQ-010子需求拆分文档
|
||
|
||
## Context Maps
|
||
|
||
强制列出本次需求依赖的 Canvas 文件：
|
||
|
||
- [Authentication.canvas](../Authentication.canvas) - 项目架构视觉化展示
|
||
- **相关节点**: [集成核心](node_integration_core) - 提供与Salesforce的各种连接方式
|
||
|
||
## 需求目标
|
||
|
||
实现元数据组件索引和查询功能，支持按类型、名称、版本等条件查询元数据组件。
|
||
|
||
## 需求描述
|
||
|
||
### 概述
|
||
|
||
本需求旨在实现元数据组件索引和查询功能，包括组件索引创建、组件查询、组件详情查看、组件统计等。
|
||
|
||
### 详细需求
|
||
|
||
#### 1. 组件索引创建
|
||
|
||
- **需求描述**: 实现组件索引创建功能，解析解压后的元数据文件
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 组件索引创建成功
|
||
- 支持多种元数据类型解析
|
||
- 索引信息完整准确
|
||
- 索引创建性能满足要求
|
||
- **依赖关系**: 依赖于REQ-010-1, REQ-010-2, REQ-010-7
|
||
- **实现建议**: 使用文件解析库解析元数据文件，使用MyBatis Plus批量插入索引数据
|
||
|
||
#### 2. 组件查询
|
||
|
||
- **需求描述**: 实现组件查询功能，支持按类型、名称、版本等条件查询
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 组件查询功能正常工作
|
||
- 支持按类型查询
|
||
- 支持按名称查询
|
||
- 支持按版本查询
|
||
- 支持多条件组合查询
|
||
- 支持分页查询
|
||
- API接口符合RESTful规范
|
||
- **依赖关系**: 依赖于组件索引创建
|
||
- **实现建议**: 使用MyBatis Plus的QueryWrapper实现多条件查询，使用分页插件实现分页
|
||
|
||
#### 3. 组件详情查看
|
||
|
||
- **需求描述**: 实现组件详情查看功能，查看组件的完整信息
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 组件详情查看成功
|
||
- 组件信息完整准确
|
||
- 支持查看组件文件内容
|
||
- 支持查看组件依赖关系
|
||
- **依赖关系**: 依赖于组件查询
|
||
- **实现建议**: 使用文件读取API读取组件文件内容，使用关系查询获取组件依赖关系
|
||
|
||
#### 4. 组件统计
|
||
|
||
- **需求描述**: 实现组件统计功能，统计组件数量、类型分布等
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 组件统计功能正常工作
|
||
- 统计信息准确
|
||
- 支持按类型统计
|
||
- 支持按版本统计
|
||
- 支持按组织统计
|
||
- **依赖关系**: 依赖于组件索引创建
|
||
- **实现建议**: 使用MyBatis Plus的聚合查询实现统计功能
|
||
|
||
## 约束
|
||
|
||
- **技术栈限制**: 必须基于现有的Spring Boot 3 + Vue 3技术栈
|
||
- **架构约束**: 必须遵循Authentication.canvas中定义的架构和调用关系
|
||
- **模块约束**: 必须在datai-salesforce-metadata模块下实现
|
||
- **数据库约束**: 必须使用MyBatis Plus作为持久层框架
|
||
- **性能约束**: 索引创建和查询性能必须满足要求
|
||
- **依赖约束**: 必须依赖于REQ-010-1, REQ-010-2, REQ-010-7
|
||
|
||
## Rule Set
|
||
|
||
"请严格参考 @Authentication.canvas 中的状态机转移逻辑，不要自行发挥。"
|
||
|
||
**具体规则**：
|
||
- 必须使用Canvas中定义的类名和方法名
|
||
- 必须遵循Canvas中定义的调用关系
|
||
- 必须参考Canvas中的流程图逻辑
|
||
|
||
## 验收标准
|
||
|
||
- **功能完整性**: 所有组件索引和查询功能能够正常工作
|
||
- **性能指标**: 索引创建和查询性能满足要求
|
||
- **代码规范性**: 代码符合项目编码规范，有清晰的注释
|
||
- **可维护性**: 代码结构清晰，易于扩展和维护
|
||
- **可测试性**: 代码易于单元测试和集成测试
|
||
|
||
## 风险
|
||
|
||
- **索引创建风险**: 索引创建失败可能导致组件查询失败
|
||
- **查询性能风险**: 查询性能不佳可能影响用户体验
|
||
- **文件解析风险**: 文件解析错误可能导致索引信息不准确
|
||
- **统计风险**: 统计逻辑错误可能导致统计信息不准确
|
||
|
||
## 需求变更记录
|
||
|
||
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|
||
|------|---------|---------|--------|--------|------|
|
||
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
|
||
|
||
## 相关人员
|
||
|
||
- **需求提出人**: 系统管理员 - 联系方式
|
||
- **需求负责人**: 系统管理员 - 联系方式
|
||
- **技术负责人**: 开发工程师 - 联系方式
|
||
- **测试负责人**: 测试工程师 - 联系方式
|
||
- **其他相关人员**: - 联系方式
|
||
|
||
## 评审信息
|
||
|
||
- **评审日期**: -
|
||
- **评审人员**: -
|
||
- **评审结果**: -
|
||
- **评审意见**: -
|
||
- **修改建议**: -
|