- 完成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方法论创建,包括需求定义、架构决策、提示词资产化、执行会话、变更记录和闭环复盘。
6.7 KiB
6.7 KiB
Requirements - Salesforce组织配置管理
需求信息
- 需求名称: Salesforce组织配置管理
- 需求类型: 功能需求
- 需求编号: REQ-010-3
- 父需求: REQ-010
- 创建日期: 2026-01-17
- 需求版本: v1.0.0
- 需求提出人: 系统管理员
- 需求状态: 已完成
输入引用
引用相关的 docs 文档链接:
- REQ-010.md - Salesforce元数据拉取和部署主需求文档
- REQ-010-1.md - 数据库表结构设计和创建
- REQ-010-2.md - 基础实体类和Mapper创建
- 010-metadata-retrieve-deploy-sub-requirements.md - REQ-010子需求拆分文档
Context Maps
强制列出本次需求依赖的 Canvas 文件:
- Authentication.canvas - 项目架构视觉化展示
- 相关节点: SessionManager - 会话管理,提供登录服务
- 相关节点: 集成核心 - 提供与Salesforce的各种连接方式
需求目标
提供Salesforce组织配置的CRUD管理功能,支持多环境配置、OAuth认证管理、存储路径配置等。
需求描述
概述
本需求旨在提供Salesforce组织配置的完整管理功能,包括配置的增删改查、OAuth认证信息加密存储、环境类型管理、存储路径配置、连接状态管理等。
详细需求
1. 组织配置CRUD功能
- 需求描述: 实现组织配置的增删改查功能,支持多环境配置
- 优先级: 高
- 验收标准:
- 能够成功添加Salesforce组织配置
- 能够成功编辑组织配置
- 能够成功删除组织配置
- 能够查询组织配置列表
- 支持分页查询
- 支持条件查询
- API接口符合RESTful规范
- 依赖关系: 依赖于REQ-010-1, REQ-010-2
- 实现建议: 使用MyBatis Plus的BaseMapper实现CRUD,使用@Valid注解进行参数验证
2. OAuth认证信息加密存储
- 需求描述: 实现OAuth认证信息的加密存储,确保安全性
- 优先级: 高
- 验收标准:
- OAuth认证信息加密存储成功
- 使用AES加密算法
- 加密密钥安全存储
- 解密功能正常工作
- 加密算法符合安全标准
- 依赖关系: 依赖于组织配置CRUD功能
- 实现建议: 使用Java Cryptography API实现AES加密,使用Base64编码存储
3. 环境类型管理
- 需求描述: 实现环境类型选择和管理(Sandbox/Production)
- 优先级: 高
- 验收标准:
- 支持环境类型选择(Sandbox/Production)
- 使用枚举类型管理环境类型
- 环境类型验证正确
- 环境类型显示友好
- 依赖关系: 依赖于组织配置CRUD功能
- 实现建议: 使用Java枚举类型,使用@EnumValue注解映射数据库值
4. 存储根路径配置
- 需求描述: 实现存储根路径配置,支持OSS和本地文件系统
- 优先级: 高
- 验收标准:
- 支持存储根路径配置
- 路径格式验证正确
- 支持相对路径和绝对路径
- 路径存在性检查正确
- 依赖关系: 依赖于组织配置CRUD功能
- 实现建议: 使用正则表达式验证路径格式,使用File API检查路径存在性
5. 连接状态管理
- 需求描述: 实现连接状态管理(Active/Inactive/Auth_Invalid)
- 优先级: 高
- 验收标准:
- 支持连接状态管理
- 使用枚举类型管理连接状态
- 连接状态更新正确
- 连接状态显示友好
- 依赖关系: 依赖于组织配置CRUD功能
- 实现建议: 使用Java枚举类型,使用状态机管理连接状态
6. 配置验证功能
- 需求描述: 实现配置验证功能,验证OAuth认证信息和连接
- 优先级: 高
- 验收标准:
- 配置验证功能正常工作
- 验证OAuth认证信息格式正确
- 验证连接可用性
- 验证失败返回详细错误信息
- 依赖关系: 依赖于OAuth认证信息加密存储和连接状态管理
- 实现建议: 使用SessionManager验证连接,使用正则表达式验证OAuth信息格式
约束
- 技术栈限制: 必须基于现有的Spring Boot 3 + Vue 3技术栈
- 架构约束: 必须遵循Authentication.canvas中定义的架构和调用关系
- 模块约束: 必须在datai-salesforce-metadata模块下实现
- 数据库约束: 必须使用MyBatis Plus作为持久层框架
- 认证约束: 必须使用现有的认证模块和SessionManager进行会话管理
- 安全约束: OAuth认证信息必须加密存储,不存明文密码
- API约束: 必须使用现有的集成核心功能进行Salesforce API调用
- 文档约束: 必须遵循REQ-010中定义的验收标准
Rule Set
"请严格参考 @Authentication.canvas 中的状态机转移逻辑,不要自行发挥。"
具体规则:
- 必须使用Canvas中定义的类名和方法名
- 必须遵循Canvas中定义的调用关系
- 必须参考Canvas中的流程图逻辑
- 必须使用SessionManager进行会话管理和自动重新登录
- 必须使用现有的认证模块进行OAuth认证
- 必须使用现有的集成核心功能进行API调用
- 必须遵循现有的异常处理机制
- 必须遵循现有的日志记录规范
验收标准
- 功能完整性: 所有CRUD功能能够正常工作,OAuth认证信息加密存储成功
- 安全性要求: OAuth认证信息加密存储,符合安全标准
- 用户体验: 操作界面友好易用,提供清晰的错误信息
- 代码规范性: 代码符合项目编码规范,有清晰的注释
- 可维护性: 代码结构清晰,易于扩展和维护
风险
- 安全风险: OAuth认证信息加密不当可能导致安全风险
- 配置验证风险: 配置验证逻辑复杂可能导致验证不准确
- 多环境配置风险: 多环境配置管理复杂可能导致配置混乱
- 连接状态管理风险: 连接状态管理不当可能导致状态不一致
- 加密算法风险: 加密算法选择不当可能导致加密强度不足
需求变更记录
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|---|---|---|---|---|---|
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
相关人员
- 需求提出人: 系统管理员 - 联系方式
- 需求负责人: 系统管理员 - 联系方式
- 技术负责人: 开发工程师 - 联系方式
- 测试负责人: 测试工程师 - 联系方式
- 其他相关人员: - 联系方式
评审信息
- 评审日期: -
- 评审人员: -
- 评审结果: -
- 评审意见: -
- 修改建议: -