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
152 lines
5.2 KiB
Markdown
152 lines
5.2 KiB
Markdown
# Requirements - 版本回溯功能
|
||
|
||
## 需求信息
|
||
|
||
- **需求名称**: 版本回溯功能
|
||
- **需求类型**: 功能需求
|
||
- **需求编号**: REQ-010-13
|
||
- **父需求**: 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) - 文件存储和解压处理
|
||
- [REQ-010-12.md](REQ-010-12.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, REQ-010-12
|
||
- **实现建议**: 使用MyBatis Plus的BaseMapper实现版本历史记录，使用时间戳记录版本
|
||
|
||
#### 2. 版本对比
|
||
|
||
- **需求描述**: 实现版本对比功能，对比不同版本的元数据文件
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 版本对比功能正常工作
|
||
- 支持文件内容对比
|
||
- 支持文件哈希对比
|
||
- 对比结果清晰直观
|
||
- 支持差异高亮显示
|
||
- **依赖关系**: 依赖于版本历史记录
|
||
- **实现建议**: 使用Diff算法对比文件内容，使用哈希值对比文件差异
|
||
|
||
#### 3. 版本恢复
|
||
|
||
- **需求描述**: 实现版本恢复功能，恢复到指定的历史版本
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 版本恢复功能正常工作
|
||
- 支持选择历史版本
|
||
- 恢复操作安全可靠
|
||
- 恢复结果准确
|
||
- 恢复日志记录完整
|
||
- **依赖关系**: 依赖于版本历史记录和REQ-010-8
|
||
- **实现建议**: 使用历史版本的文件进行恢复，使用事务确保恢复原子性
|
||
|
||
#### 4. 版本回滚
|
||
|
||
- **需求描述**: 实现版本回滚功能，回滚到上一个版本
|
||
- **优先级**: 中
|
||
- **验收标准**:
|
||
- 版本回滚功能正常工作
|
||
- 支持一键回滚
|
||
- 回滚操作安全可靠
|
||
- 回滚结果准确
|
||
- 回滚日志记录完整
|
||
- **依赖关系**: 依赖于版本恢复
|
||
- **实现建议**: 使用上一个版本的文件进行回滚，使用事务确保回滚原子性
|
||
|
||
## 约束
|
||
|
||
- **技术栈限制**: 必须基于现有的Spring Boot 3 + Vue 3技术栈
|
||
- **架构约束**: 必须遵循Authentication.canvas中定义的架构和调用关系
|
||
- **模块约束**: 必须在datai-salesforce-metadata模块下实现
|
||
- **数据库约束**: 必须使用MyBatis Plus作为持久层框架
|
||
- **性能约束**: 版本对比和恢复性能必须满足要求
|
||
- **依赖约束**: 必须依赖于REQ-010-1, REQ-010-2, REQ-010-7, REQ-010-12
|
||
|
||
## Rule Set
|
||
|
||
"请严格参考 @Authentication.canvas 中的状态机转移逻辑，不要自行发挥。"
|
||
|
||
**具体规则**：
|
||
- 必须使用Canvas中定义的类名和方法名
|
||
- 必须遵循Canvas中定义的调用关系
|
||
- 必须参考Canvas中的流程图逻辑
|
||
|
||
## 验收标准
|
||
|
||
- **功能完整性**: 所有版本回溯功能能够正常工作
|
||
- **性能指标**: 版本对比和恢复性能满足要求
|
||
- **安全性**: 恢复和回滚操作安全可靠，有完整的日志记录
|
||
- **代码规范性**: 代码符合项目编码规范，有清晰的注释
|
||
- **可维护性**: 代码结构清晰，易于扩展和维护
|
||
- **可测试性**: 代码易于单元测试和集成测试
|
||
|
||
## 风险
|
||
|
||
- **版本记录风险**: 版本记录不完整可能导致无法恢复
|
||
- **对比风险**: 版本对比不准确可能导致误判
|
||
- **恢复风险**: 恢复操作失败可能导致数据不一致
|
||
- **回滚风险**: 回滚操作失败可能导致无法恢复
|
||
- **存储空间风险**: 版本历史记录过多可能占用大量存储空间
|
||
|
||
## 需求变更记录
|
||
|
||
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|
||
|------|---------|---------|--------|--------|------|
|
||
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
|
||
|
||
## 相关人员
|
||
|
||
- **需求提出人**: 系统管理员 - 联系方式
|
||
- **需求负责人**: 系统管理员 - 联系方式
|
||
- **技术负责人**: 开发工程师 - 联系方式
|
||
- **测试负责人**: 测试工程师 - 联系方式
|
||
- **其他相关人员**: - 联系方式
|
||
|
||
## 评审信息
|
||
|
||
- **评审日期**: -
|
||
- **评审人员**: -
|
||
- **评审结果**: -
|
||
- **评审意见**: -
|
||
- **修改建议**: -
|