- 完成REQ-010-17(性能优化和限流处理)的所有6个阶段 - 创建ADR文档:0026-performance-optimization.md - 创建Prompt文档:027-performance-optimization.md - 创建会话记录:20260119-performance-optimization.md - 创建变更记录:20260119-performance-optimization.md - 创建复盘报告:20260119-performance-optimization-retro.md - 更新index.md和CHANGELOG.md - 完成REQ-010-2(基础实体类和Mapper创建)的前3个阶段 - 更新ADR文档:0011-entity-mapper-create.md - 创建Prompt文档:002-entity-mapper-create.md - 更新index.md 所有文档均按照SSOT方法论创建,包括需求定义、架构决策、提示词资产化、执行会话、变更记录和闭环复盘。
5.7 KiB
5.7 KiB
Requirements - 文件哈希对比和增量检测
需求信息
- 需求名称: 文件哈希对比和增量检测
- 需求类型: 功能需求
- 需求编号: REQ-010-12
- 父需求: REQ-010
- 创建日期: 2026-01-17
- 需求版本: v1.0.0
- 需求提出人: 系统管理员
- 需求状态: 待审核
输入引用
引用相关的 docs 文档链接:
- REQ-010.md - Salesforce元数据拉取和部署主需求文档
- REQ-010-1.md - 数据库表结构设计和创建
- REQ-010-2.md - 基础实体类和Mapper创建
- REQ-010-7.md - 文件存储和解压处理
- REQ-010-11.md - 元数据组件索引和查询
- 010-metadata-retrieve-deploy-sub-requirements.md - REQ-010子需求拆分文档
- file/index.md - 文件模块 API 文档索引(唯一真源)
Context Maps
强制列出本次需求依赖的 Canvas 文件:
- Authentication.canvas - 项目架构视觉化展示
- 相关节点: 集成核心 - 提供与Salesforce的各种连接方式
需求目标
实现文件哈希对比和增量检测功能,支持检测文件变化,只拉取或部署变化的文件。
需求描述
概述
本需求旨在实现文件哈希对比和增量检测功能,包括文件哈希计算、哈希对比、增量检测、增量拉取、增量部署等。
详细需求
1. 文件哈希计算
- 需求描述: 实现文件哈希计算功能,使用SHA-256算法
- 优先级: 中
- 验收标准:
- 文件哈希计算成功
- 使用SHA-256算法
- 哈希值准确
- 支持大文件处理
- 内存使用合理
- 依赖关系: 依赖于REQ-010-1, REQ-010-2, REQ-010-7
- 实现建议: 使用Java MessageDigest计算SHA-256哈希,使用流式处理大文件
2. 哈希对比
- 需求描述: 实现哈希对比功能,对比文件的哈希值
- 优先级: 中
- 验收标准:
- 哈希对比功能正常工作
- 对比结果准确
- 支持批量对比
- 对比性能满足要求
- 依赖关系: 依赖于文件哈希计算
- 实现建议: 使用哈希值直接对比,使用并行处理提高对比性能
3. 增量检测
- 需求描述: 实现增量检测功能,检测文件变化
- 优先级: 中
- 验收标准:
- 增量检测功能正常工作
- 检测结果准确
- 支持新增文件检测
- 支持修改文件检测
- 支持删除文件检测
- 依赖关系: 依赖于哈希对比
- 实现建议: 使用哈希对比检测文件变化,使用文件系统监听器检测文件删除
4. 增量拉取
- 需求描述: 实现增量拉取功能,只拉取变化的文件
- 优先级: 中
- 验收标准:
- 增量拉取功能正常工作
- 只拉取变化的文件
- 拉取结果准确
- 拉取性能满足要求
- 依赖关系: 依赖于增量检测和REQ-010-6
- 实现建议: 使用增量检测结果构建package.xml,只拉取变化的文件
5. 增量部署
- 需求描述: 实现增量部署功能,只部署变化的文件
- 优先级: 中
- 验收标准:
- 增量部署功能正常工作
- 只部署变化的文件
- 部署结果准确
- 部署性能满足要求
- 依赖关系: 依赖于增量检测和REQ-010-8
- 实现建议: 使用增量检测结果构建package.xml,只部署变化的文件
约束
- 技术栈限制: 必须基于现有的Spring Boot 3 + Vue 3技术栈
- 架构约束: 必须遵循Authentication.canvas中定义的架构和调用关系
- 模块约束: 必须在datai-salesforce-metadata模块下实现
- 数据库约束: 必须使用MyBatis Plus作为持久层框架
- 性能约束: 哈希计算和对比性能必须满足要求
- 算法约束: 必须使用SHA-256算法计算哈希
- 依赖约束: 必须依赖于REQ-010-1, REQ-010-2, REQ-010-7, REQ-010-11
Rule Set
"请严格参考 @Authentication.canvas 中的状态机转移逻辑,不要自行发挥。"
具体规则:
- 必须使用Canvas中定义的类名和方法名
- 必须遵循Canvas中定义的调用关系
- 必须参考Canvas中的流程图逻辑
验收标准
- 功能完整性: 所有文件哈希对比和增量检测功能能够正常工作
- 性能指标: 哈希计算和对比性能满足要求,增量拉取和部署性能满足要求
- 准确性: 增量检测结果准确,只拉取或部署变化的文件
- 代码规范性: 代码符合项目编码规范,有清晰的注释
- 可维护性: 代码结构清晰,易于扩展和维护
- 可测试性: 代码易于单元测试和集成测试
风险
- 哈希计算风险: 哈希计算错误可能导致增量检测不准确
- 对比性能风险: 对比性能不佳可能影响用户体验
- 增量检测风险: 增量检测不准确可能导致遗漏或误判
- 增量拉取风险: 增量拉取失败可能导致文件不一致
- 增量部署风险: 增量部署失败可能导致部署不完整
需求变更记录
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|---|---|---|---|---|---|
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
相关人员
- 需求提出人: 系统管理员 - 联系方式
- 需求负责人: 系统管理员 - 联系方式
- 技术负责人: 开发工程师 - 联系方式
- 测试负责人: 测试工程师 - 联系方式
- 其他相关人员: - 联系方式
评审信息
- 评审日期: -
- 评审人员: -
- 评审结果: -
- 评审意见: -
- 修改建议: -