datai/datai-scenes/datai-scene-salesforce/docs/requirements/REQ-010-10.md

163 lines
6.2 KiB
Markdown
Raw Normal View History

# Requirements - Destructive Changes功能实现
## 需求信息
- **需求名称**: Destructive Changes功能实现
- **需求类型**: 功能需求
- **需求编号**: REQ-010-10
- **父需求**: 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-8.md](REQ-010-8.md) - 元数据部署核心功能
- [004-元数据部署网页资料链接地址](../reference-code/metadata/004-元数据部署网页资料链接地址) - 官方文档和开源项目参考
- [010-metadata-retrieve-deploy-sub-requirements.md](010-metadata-retrieve-deploy-sub-requirements.md) - REQ-010子需求拆分文档
- [metadata-module.md](../reference-code/com/docs/metadata-module.md) - Salesforce Metadata API 模块说明(唯一真源)
- [index.md](../reference-code/com/docs/index.md) - Salesforce SOAP API Java 客户端参考文档(唯一真源)
## Context Maps
强制列出本次需求依赖的 Canvas 文件:
- [Authentication.canvas](../Authentication.canvas) - 项目架构视觉化展示
- **相关节点**: [集成核心](node_integration_core) - 提供与Salesforce的各种连接方式
## 需求目标
实现Destructive Changes功能支持部署时删除指定的元数据组件使用destructiveChanges.xml配置删除规则。
## 需求描述
### 概述
本需求旨在实现Destructive Changes功能包括destructiveChanges.xml配置、Destructive Changes部署、Destructive Changes验证、Destructive Changes历史记录等。
### 详细需求
#### 1. destructiveChanges.xml配置
- **需求描述**: 实现destructiveChanges.xml配置功能支持可视化编辑
- **优先级**: 高
- **验收标准**:
- destructiveChanges.xml配置成功
- destructiveChanges.xml格式符合Salesforce Metadata API规范
- 支持多种元数据类型配置
- 支持通配符配置
- destructiveChanges.xml验证功能正常工作
- **依赖关系**: 依赖于REQ-010-1, REQ-010-2
- **实现建议**: 使用XML解析库处理destructiveChanges.xml实现可视化编辑器
#### 2. Destructive Changes部署
- **需求描述**: 实现Destructive Changes部署功能支持删除指定的元数据组件
- **优先级**: 高
- **验收标准**:
- Destructive Changes部署成功
- 支持删除指定的元数据组件
- 支持批量删除
- 删除操作安全可靠
- API接口符合RESTful规范
- **依赖关系**: 依赖于destructiveChanges.xml配置和REQ-010-8
- **实现建议**: 使用MetadataApiClient调用deploy()方法传入destructiveChanges.xml
#### 3. Destructive Changes验证
- **需求描述**: 实现Destructive Changes验证功能验证删除规则
- **优先级**: 高
- **验收标准**:
- Destructive Changes验证功能正常工作
- destructiveChanges.xml格式验证正确
- 删除规则验证正确
- 验证失败返回详细错误信息
- **依赖关系**: 依赖于destructiveChanges.xml配置
- **实现建议**: 使用XML解析库验证destructiveChanges.xml使用正则表达式验证删除规则
#### 4. Destructive Changes历史记录
- **需求描述**: 实现Destructive Changes历史记录功能
- **优先级**: 高
- **验收标准**:
- Destructive Changes历史记录成功
- 支持分页查询
- 支持条件查询
- 历史记录完整
- **依赖关系**: 依赖于Destructive Changes部署
- **实现建议**: 使用MyBatis Plus的BaseMapper实现历史记录查询
#### 5. Destructive Changes回滚
- **需求描述**: 实现Destructive Changes回滚功能支持恢复被删除的元数据组件
- **优先级**: 高
- **验收标准**:
- Destructive Changes回滚功能正常工作
- 支持恢复被删除的元数据组件
- 回滚操作安全可靠
- 回滚日志记录完整
- **依赖关系**: 依赖于Destructive Changes部署和历史记录
- **实现建议**: 使用备份的元数据组件进行回滚,使用事务确保回滚原子性
## 约束
- **技术栈限制**: 必须基于现有的Spring Boot 3 + Vue 3技术栈
- **架构约束**: 必须遵循Authentication.canvas中定义的架构和调用关系
- **模块约束**: 必须在datai-salesforce-metadata模块下实现
- **数据库约束**: 必须使用MyBatis Plus作为持久层框架
- **API约束**: 必须使用现有的集成核心功能进行Salesforce API调用
- **文档约束**: 必须遵循REQ-010中定义的验收标准
- **依赖约束**: 必须依赖于REQ-010-1, REQ-010-2, REQ-010-8
## Rule Set
"请严格参考 @Authentication.canvas 中的状态机转移逻辑,不要自行发挥。"
**具体规则**
- 必须使用Canvas中定义的类名和方法名
- 必须遵循Canvas中定义的调用关系
- 必须参考Canvas中的流程图逻辑
## 验收标准
- **功能完整性**: 所有Destructive Changes功能能够正常工作
- **安全性**: 删除操作安全可靠,支持回滚
- **代码规范性**: 代码符合项目编码规范,有清晰的注释
- **可维护性**: 代码结构清晰,易于扩展和维护
- **可测试性**: 代码易于单元测试和集成测试
## 风险
- **删除操作风险**: 删除操作不可逆可能导致数据丢失
- **验证风险**: 验证逻辑不完善可能导致误删除
- **回滚风险**: 回滚功能不完善可能导致无法恢复
- **历史记录风险**: Destructive Changes历史记录过多可能影响查询性能
## 需求变更记录
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|------|---------|---------|--------|--------|------|
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
## 相关人员
- **需求提出人**: 系统管理员 - 联系方式
- **需求负责人**: 系统管理员 - 联系方式
- **技术负责人**: 开发工程师 - 联系方式
- **测试负责人**: 测试工程师 - 联系方式
- **其他相关人员**: - 联系方式
## 评审信息
- **评审日期**: -
- **评审人员**: -
- **评审结果**: -
- **评审意见**: -
- **修改建议**: -