kris/datai

Kris 2e6f087732 docs: 完成REQ-010-17和REQ-010-2的文档创建

- 完成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方法论创建，包括需求定义、架构决策、提示词资产化、执行会话、变更记录和闭环复盘。

2026-01-19 10:06:09 +08:00

5.7 KiB

Raw Blame History

Requirements - 文件存储和解压处理

需求信息

需求名称: 文件存储和解压处理
需求类型: 功能需求
需求编号: REQ-010-7
父需求: REQ-010
创建日期: 2026-01-17
需求版本: v1.0.0
需求提出人: 系统管理员
需求状态: 待审核

输入引用

引用相关的 docs 文档链接：

REQ-010.md - Salesforce元数据拉取和部署主需求文档
REQ-010-1.md - 数据库表结构设计和创建
REQ-010-2.md - 基础实体类和Mapper创建
REQ-010-3.md - Salesforce组织配置管理
REQ-010-6.md - 元数据拉取核心功能
010-metadata-retrieve-deploy-sub-requirements.md - REQ-010子需求拆分文档
file/index.md - 文件模块 API 文档索引（唯一真源）

Context Maps

强制列出本次需求依赖的 Canvas 文件：

Authentication.canvas - 项目架构视觉化展示
相关节点: 集成核心 - 提供与Salesforce的各种连接方式

需求目标

实现拉取后的Zip文件存储和解压处理，支持本地文件系统和OSS存储，支持大文件处理。

需求描述

概述

本需求旨在实现拉取后的Zip文件存储和解压处理，包括Zip文件存储、文件解压、文件路径管理、存储空间管理、文件清理等。

详细需求

1. Zip文件存储

需求描述: 实现Zip文件存储功能，支持本地文件系统和OSS存储
优先级: 高
验收标准:
- Zip文件存储成功
- 支持本地文件系统存储
- 支持OSS存储
- 存储路径正确
- 文件完整性验证通过
依赖关系: 依赖于REQ-010-1, REQ-010-2, REQ-010-3, REQ-010-6
实现建议: 使用File API处理本地文件存储，使用OSS SDK处理OSS存储

2. 文件解压

需求描述: 实现文件解压功能，支持大文件处理
优先级: 高
验收标准:
- 文件解压成功
- 支持大文件处理
- 支持流式解压
- 内存使用合理
- 解压文件结构正确
依赖关系: 依赖于Zip文件存储
实现建议: 使用ZipInputStream处理大文件，使用流式处理避免内存溢出

3. 文件路径管理

需求描述: 实现文件路径管理，支持路径规范化和验证
优先级: 高
验收标准:
- 文件路径管理正常工作
- 支持路径规范化
- 支持路径验证
- 路径格式正确
- 路径安全性验证通过
依赖关系: 依赖于文件解压
实现建议: 使用Path API处理路径，使用正则表达式验证路径格式

4. 存储空间管理

需求描述: 实现存储空间管理，支持存储空间监控和告警
优先级: 高
验收标准:
- 存储空间管理正常工作
- 支持存储空间监控
- 支持存储空间告警
- 存储空间信息准确
依赖关系: 依赖于Zip文件存储
实现建议: 使用File API获取存储空间信息，使用定时任务监控存储空间

5. 文件清理

需求描述: 实现文件清理功能，支持过期文件自动清理
优先级: 高
验收标准:
- 文件清理功能正常工作
- 支持过期文件自动清理
- 支持手动清理
- 清理策略可配置
- 清理日志记录完整
依赖关系: 依赖于存储空间管理
实现建议: 使用定时任务实现自动清理，使用配置文件管理清理策略

约束

技术栈限制: 必须基于现有的Spring Boot 3 + Vue 3技术栈
架构约束: 必须遵循Authentication.canvas中定义的架构和调用关系
模块约束: 必须在datai-salesforce-metadata模块下实现
存储约束: 必须支持本地文件系统和OSS存储
性能约束: 必须支持大文件处理，内存使用合理
安全约束: 必须验证路径安全性，防止路径遍历攻击
依赖约束: 必须依赖于REQ-010-1, REQ-010-2, REQ-010-3, REQ-010-6

Rule Set

"请严格参考 @Authentication.canvas 中的状态机转移逻辑，不要自行发挥。"

具体规则：

必须使用Canvas中定义的类名和方法名
必须遵循Canvas中定义的调用关系
必须参考Canvas中的流程图逻辑

验收标准

功能完整性: 所有文件存储和解压功能能够正常工作
性能指标: 大文件处理不影响系统性能，内存使用合理
安全性: 路径安全性验证通过，防止路径遍历攻击
代码规范性: 代码符合项目编码规范，有清晰的注释
可维护性: 代码结构清晰，易于扩展和维护

风险

大文件处理风险: 大文件处理不当可能导致内存溢出
路径安全风险: 路径验证不完善可能导致路径遍历攻击
存储空间风险: 存储空间不足可能导致文件存储失败
文件清理风险: 文件清理策略不当可能导致重要文件被删除
OSS存储风险: OSS存储不稳定可能导致文件存储失败

需求变更记录

日期	变更内容	变更原因	变更人	审核人	状态
2026-01-17	创建需求文档	初始需求	系统管理员	-	待审核

评审信息

评审日期: -
评审人员: -
评审结果: -
评审意见: -
修改建议: -

5.7 KiB Raw Blame History Unescape Escape