7.8 KiB
7.8 KiB
Requirements - Document 文件上传下载功能
需求信息
- 需求名称: Document 文件上传下载功能
- 需求类型: 功能需求
- 需求编号: REQ-011-4
- 父需求: REQ-011 - Salesforce文件上传下载功能（支持Attachment、ContentDocument、Document）
- 创建日期: 2026-01-19
- 需求版本: v1.0.0
- 需求提出人: 系统管理员
- 需求状态: 已完成
输入引用
引用相关的 docs 文档链接：
- REQ-011.md - 父需求文档
- REQ-011-1.md - 基础设施和枚举定义
- Document上传下载.md - Salesforce Document 上传下载实现逻辑
- Authentication.canvas - 项目架构视觉化展示
Context Maps
强制列出本次需求依赖的 Canvas 文件：
- Authentication.canvas - 项目架构视觉化展示
- 相关节点: 集成核心 - 提供与Salesforce的各种连接方式
- 相关节点: SessionManager - 会话管理，提供登录服务
需求目标
在 datai-salesforce-integration 模块实现 Salesforce Document 对象的文件上传下载功能，使用 Partner API (SOAP) 方式，支持最大 20-30MB 文件。
需求描述
概述
本需求旨在实现 Salesforce Document 对象的文件上传下载功能。Document 是 Salesforce 的文档对象（用于存储 Email 模板 Logo、Classic 模式附件等），使用 Partner API (SOAP) 方式进行文件上传下载，最大支持 20-30MB 文件。
Document 对象特性
| 特性 | 说明 |
|---|---|
| 主要用途 | Email模板Logo、Classic附件 |
| 单文件限制 | 20-30MB |
| 版本管理 | 不支持（只能覆盖） |
| 关联方式 | 存储在DocumentFolder |
| 上传方式 | Partner API (SOAP) |
| 推荐等级 | 仅用于特定遗留功能 |
| 必填字段 | FolderId, Name, Body |
详细需求
1. Document 上传策略
- 需求描述: 实现 Document 上传策略，使用 Partner API (SOAP) 方式
- 优先级: 高
- 验收标准:
- 定义 DocumentUploadStrategy 类，实现 FileUploadStrategy 接口
- 能够成功上传本地文件到 Salesforce Document 对象
- 支持指定组织配置 ID
- 支持指定 FolderId（必填）
- 支持指定文件名和 DeveloperName
- 文件内容使用 Base64 编码
- 上传成功返回 Document ID
- 支持文件大小限制（建议不超过 20-30MB）
- 支持文件类型验证
- 支持文件大小验证
- 提供详细的错误信息
- 依赖关系:
- 依赖于 REQ-011-1 的基础设施
- 依赖于 datai-salesforce-integration 模块的 SessionManager
- 依赖于 datai-salesforce-integration 模块的 PartnerV1Connection
- 实现建议:
- 使用 Partner API (SOAP) 创建 Document 对象
- 使用 Base64 编码文件内容
- 使用 SessionManager 获取 Access Token
- 使用 @Valid 注解进行参数验证
- 参考参考代码中的实现逻辑
2. Document 下载策略
- 需求描述: 实现 Document 下载策略，使用 Partner API (SOAP) 方式
- 优先级: 高
- 验收标准:
- 定义 DocumentDownloadStrategy 类，实现 FileDownloadStrategy 接口
- 能够成功从 Salesforce Document 对象下载文件到本地
- 支持指定组织配置 ID
- 支持指定 Document ID
- 支持指定保存路径
- 使用流式处理避免内存溢出
- 下载成功返回文件信息
- 支持大文件下载
- 提供详细的错误信息
- 依赖关系:
- 依赖于 REQ-011-1 的基础设施
- 依赖于 datai-salesforce-integration 模块的 SessionManager
- 依赖于 datai-salesforce-integration 模块的 PartnerV1Connection
- 实现建议:
- 使用 Partner API (SOAP) 查询 Document 对象的 Body 字段
- 使用 InputStream 流式处理文件内容
- 使用 SessionManager 获取 Access Token
- 使用 FileOutputStream 保存文件到本地
- 使用 @Valid 注解进行参数验证
- 参考参考代码中的实现逻辑
3. Document 上传下载 Service
- 需求描述: 实现 Document 上传下载 Service，封装策略调用逻辑
- 优先级: 高
- 验收标准:
- 定义 DocumentFileService 接口
- 定义 DocumentFileServiceImpl 实现类
- 提供 uploadDocument 方法
- 提供 downloadDocument 方法
- 使用策略模式封装上传下载逻辑
- 提供参数验证
- 提供异常处理
- 提供日志记录
- 依赖关系:
- 依赖于 REQ-011-1 的基础设施
- 依赖于 Document 上传下载策略
- 依赖于 datai-salesforce-integration 模块的 SessionManager
- 实现建议:
- 使用策略模式封装上传下载逻辑
- 使用 @Autowired 注入策略
- 使用 @Slf4j 记录日志
- 使用 @Transactional 管理事务
约束
- 技术栈限制: 必须基于现有的 Spring Boot 3 技术栈
- 架构约束: 必须遵循 Authentication.canvas 中定义的架构和调用关系
- 模块约束: 必须在 datai-salesforce-integration 模块下实现
- 认证约束: 必须使用 SessionManager 进行会话管理和自动重新登录
- API约束: 必须使用 Salesforce Partner API (SOAP)
- 文件大小约束: 单个文件大小建议不超过 20-30MB
- 内存约束: 必须使用流式处理避免内存溢出
- 文档约束: 必须遵循 SSOT 方法论
- 设计模式约束: 必须使用策略模式封装上传下载逻辑
Rule Set
"请严格参考 @Authentication.canvas 中的状态机转移逻辑，不要自行发挥。"
具体规则：
- 必须使用 Canvas 中定义的类名和方法名
- 必须遵循 Canvas 中定义的调用关系
- 必须参考 Canvas 中的流程图逻辑
- 必须使用 SessionManager 进行会话管理和自动重新登录
- 必须使用现有的认证模块进行 OAuth 认证
- 必须遵循现有的异常处理机制
- 必须遵循现有的日志记录规范
- 必须使用 PartnerV1Connection 处理 SOAP API 调用
- 必须使用策略模式封装上传下载逻辑
验收标准
- 功能完整性: Document 文件上传下载功能能够正常工作，支持指定组织配置 ID
- 性能指标:
- 文件上传下载不影响系统响应
- 大文件处理性能良好
- 流式处理有效避免内存溢出
- 代码规范性:
- 代码符合项目编码规范，有清晰的注释
- 使用策略模式封装上传下载逻辑
- 遵循单一职责原则和开闭原则
- 可维护性:
- 代码结构清晰，易于扩展和维护
- 配置与代码分离，易于调整
- 可测试性:
- 代码易于单元测试和集成测试
- 提供完整的测试用例覆盖
风险
- 文件大小风险: 大文件上传下载可能导致内存溢出
- API 限流风险: 频繁的 API 调用可能导致 Salesforce API 限流
- 认证失效风险: Access Token 失效可能导致文件上传下载失败
- 网络异常风险: 网络异常可能导致文件上传下载失败
- 并发风险: 并发上传下载可能导致资源竞争
- 功能受限风险: Document 功能受限，仅适用于特定场景
- SOAP API 风险: SOAP API 调用复杂度较高，可能增加实现难度
需求变更记录
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|---|---|---|---|---|---|
| 2026-01-19 | 创建需求文档 | 从 REQ-011 拆分 | 系统管理员 | - | 待审核 |
相关人员
- 需求提出人: 系统管理员 - 联系方式
- 需求负责人: 系统管理员 - 联系方式
- 技术负责人: 开发工程师 - 联系方式
- 测试负责人: 测试工程师 - 联系方式
- 其他相关人员: - 联系方式
评审信息
- 评审日期: -
- 评审人员: -
- 评审结果: -
- 评审意见: -
- 修改建议: -