6a-spec-install 1.0.1-dev.17 → 1.0.1-dev.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -82,6 +82,7 @@ alwaysApply: false
|
|
|
82
82
|
**补充约束（必须遵守）：**
|
|
83
83
|
- **只设计“本需求实际存在”的入口类型**。
|
|
84
84
|
- **输出规则**：未涉及的入口类型在 TDD 中**不要为了完整性而补齐**；对应小结/表格应**直接省略**。
|
|
85
|
+
- 你需要仔细识别是否需要API，定时任务、事件订阅、后台任务，需要才设计，否则请**直接省略**，不要为了完整性而补齐。
|
|
85
86
|
|
|
86
87
|
#### 设计表格填写范例（Few-Shot Reference）
|
|
87
88
|
为确保输出质量，请参考以下标准填写表格中的关键列：
|
|
@@ -104,7 +105,7 @@ alwaysApply: false
|
|
|
104
105
|
- 必须同时写 **事件中文名 + 英文名**
|
|
105
106
|
|
|
106
107
|
#### 后台任务（Async Background Job）
|
|
107
|
-
**什么是后台任务**：系统定义的异步任务机制（任务队列 +
|
|
108
|
+
**什么是后台任务**：系统定义的异步任务机制（任务队列 + 消费者,类似线程池异步执行），用于将耗时、可重试逻辑剥离。
|
|
108
109
|
你必须说明：投递时机、任务载荷（仅 ID）、幂等处理、失败重试、数据量级。
|
|
109
110
|
|
|
110
111
|
## TDD 文档输出模板（必须严格按此结构产出）
|
|
@@ -112,6 +113,7 @@ alwaysApply: false
|
|
|
112
113
|
### 1. 功能概述
|
|
113
114
|
- 目标与核心价值
|
|
114
115
|
- 功能范围（Scope）
|
|
116
|
+
- **相关文档**：[API 详细定义](./TDD_{功能名称}_API_def.md)
|
|
115
117
|
|
|
116
118
|
### 1.5 核心技术决策与权衡 (Key Technical Decisions)
|
|
117
119
|
**必须输出此章节**。你必须解释“为什么”采用某些关键技术手段，特别是针对幂等、并发和性能的设计。
|
|
@@ -125,6 +127,9 @@ alwaysApply: false
|
|
|
125
127
|
按“架构分层与模块设计”要求输出表格。
|
|
126
128
|
|
|
127
129
|
### 3. 接口/入口规范
|
|
130
|
+
|
|
131
|
+
> 📋 **API 详细定义**：所有接口的入参/出参 JSON 结构、字段说明、示例等详细信息，请参考 [TDD_{功能名称}_API_def.md](./TDD_{功能名称}_API_def.md)
|
|
132
|
+
|
|
128
133
|
不同类型的入口必须分开说明，分别输出为不同小结与不同表格。**本需求未涉及的入口类型，小结/表格直接省略**。
|
|
129
134
|
|
|
130
135
|
#### 3.1 写操作 REST API（Command API）
|
|
@@ -90,8 +90,11 @@ alwaysApply: false
|
|
|
90
90
|
### 3. 业务规则与实现细节
|
|
91
91
|
- **核心逻辑**：基于 TDD 中的“执行逻辑”描述，详细说明 Service 层及领域层需处理的规则（如存在对应的可视化文档 `TDD_{功能名称}_Visual.md`，可作为辅助参考，但不得脱离 TDD 自行补充规则）。
|
|
92
92
|
- **核心技术决策**：回顾 TDD 中的关键决策（如幂等方案），再次确认落实。
|
|
93
|
+
- **数据结构与契约 (Binding)**：
|
|
94
|
+
- **API 契约**：必须严格遵循 `TDD_{功能名称}_API_def.md` 中的 Request/Response 结构。
|
|
95
|
+
- **Entity 引用**：实体类与 Mapper 均已预生成，请在代码实现阶段搜索并复用（如 `MyEntity.java`, `MyEntityMapper.java`或者`MyEntityDao.java`），**严禁重复创建**。
|
|
93
96
|
- **状态流转**：若涉及状态变更，明确状态机逻辑。
|
|
94
|
-
- **数据结构**：涉及的 DTO、Command、Query
|
|
97
|
+
- **数据结构**：涉及的 DTO、Command、Query 的定义要求
|
|
95
98
|
- **异常处理**：需捕获并抛出的业务异常类型。
|
|
96
99
|
|
|
97
100
|
### 4. 跨模块依赖调用
|
|
@@ -131,3 +134,4 @@ alwaysApply: false
|
|
|
131
134
|
- **任务清单**：按推荐执行顺序排列，包含状态图标 (✅/🔄/⏳)。
|
|
132
135
|
- **开发阶段划分**：建议将任务划分为 Phase 1 (Core), Phase 2 (Extensions) 等阶段。
|
|
133
136
|
- **验收标准汇总**：从各任务 DoD 汇总，形成整体 DoD。
|
|
137
|
+
- **注意事项与相关文档链接**: 至少包含：TDD、API_def、如存在则包含 Visual 文档链接
|