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

6.3 KiB

Raw Blame History

Requirements - 元数据任务定义管理

需求信息

需求名称: 元数据任务定义管理
需求类型: 功能需求
需求编号: REQ-010-4
父需求: 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组织配置管理
010-metadata-retrieve-deploy-sub-requirements.md - REQ-010子需求拆分文档
metadata-module.md - Salesforce Metadata API 模块说明（唯一真源）
file/index.md - 文件模块 API 文档索引（唯一真源）

Context Maps

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

Authentication.canvas - 项目架构视觉化展示
相关节点: 集成任务 - 处理Salesforce的定时同步任务

需求目标

提供元数据任务定义的CRUD管理功能，支持配置拉取规则、package.xml内容、API版本、调度类型等。

需求描述

概述

本需求旨在提供元数据任务定义的完整管理功能，包括任务的增删改查、package.xml内容配置、API版本选择、调度类型选择、Cron表达式配置、任务验证等。

详细需求

1. 任务定义CRUD功能

需求描述: 实现任务定义的增删改查功能
优先级: 高
验收标准:
- 能够成功创建元数据任务
- 能够成功编辑元数据任务
- 能够成功删除元数据任务
- 能够查询元数据任务列表
- 支持分页查询
- 支持条件查询
- API接口符合RESTful规范
依赖关系: 依赖于REQ-010-1, REQ-010-2, REQ-010-3
实现建议: 使用MyBatis Plus的BaseMapper实现CRUD，使用@Valid注解进行参数验证

2. package.xml内容配置

需求描述: 实现package.xml内容配置，支持可视化编辑
优先级: 高
验收标准:
- package.xml内容配置成功
- package.xml格式符合Salesforce Metadata API规范
- 支持多种元数据类型配置
- 支持通配符配置
- package.xml验证功能正常工作
依赖关系: 依赖于任务定义CRUD功能
实现建议: 使用XML解析库处理package.xml，实现可视化编辑器

3. API版本选择

需求描述: 实现API版本选择功能
优先级: 高
验收标准:
- 支持API版本选择
- API版本列表正确
- API版本验证正确
- API版本显示友好
依赖关系: 依赖于任务定义CRUD功能
实现建议: 使用枚举类型管理API版本，使用配置文件管理支持的API版本列表

4. 调度类型选择

需求描述: 实现调度类型选择（Manual/Cron）
优先级: 高
验收标准:
- 支持调度类型选择（Manual/Cron）
- 使用枚举类型管理调度类型
- 调度类型验证正确
- 调度类型显示友好
依赖关系: 依赖于任务定义CRUD功能
实现建议: 使用Java枚举类型，使用@EnumValue注解映射数据库值

5. Cron表达式配置

需求描述: 实现Cron表达式配置和验证
优先级: 高
验收标准:
- 支持Cron表达式配置
- Cron表达式验证正确
- Cron表达式解析正确
- Cron表达式预览功能正常工作
依赖关系: 依赖于调度类型选择
实现建议: 使用Cron表达式解析库验证Cron表达式，实现Cron表达式预览功能

6. 任务验证功能

需求描述: 实现任务验证功能，验证package.xml和调度配置
优先级: 高
验收标准:
- 任务验证功能正常工作
- package.xml格式验证正确
- Cron表达式验证正确
- 验证失败返回详细错误信息
依赖关系: 依赖于package.xml内容配置和Cron表达式配置
实现建议: 使用XML解析库验证package.xml，使用Cron表达式解析库验证Cron表达式

约束

技术栈限制: 必须基于现有的Spring Boot 3 + Vue 3技术栈
架构约束: 必须遵循Authentication.canvas中定义的架构和调用关系
模块约束: 必须在datai-salesforce-metadata模块下实现
数据库约束: 必须使用MyBatis Plus作为持久层框架
文档约束: 必须遵循REQ-010中定义的验收标准
依赖约束: 必须依赖于REQ-010-1, REQ-010-2, REQ-010-3

Rule Set

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

具体规则：

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

验收标准

功能完整性: 所有CRUD功能能够正常工作，package.xml配置成功
代码规范性: 代码符合项目编码规范，有清晰的注释
用户体验: 操作界面友好易用，提供清晰的错误信息
可维护性: 代码结构清晰，易于扩展和维护

风险

package.xml验证风险: package.xml格式验证复杂可能导致验证不准确
Cron表达式解析风险: Cron表达式解析错误可能导致任务调度失败
任务验证风险: 任务验证逻辑复杂可能导致验证不准确
多任务管理风险: 多任务管理复杂可能导致任务冲突

需求变更记录

日期	变更内容	变更原因	变更人	审核人	状态
2026-01-17	创建需求文档	初始需求	系统管理员	-	待审核
2026-01-18	完成需求实现	完成6个阶段的开发流程	Datai Team	-	已完成

评审信息

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

6.3 KiB Raw Blame History Unescape Escape