task-management.mdx 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  1. ---
  2. title: "任务管理"
  3. description: "从单机 Todo 到多 Agent 任务队列的演进"
  4. ---
  5. {/* 本章目标:揭示任务系统 V1(内存 TodoWrite)和 V2(文件系统 Task*)的双轨架构,以及依赖管理、认领竞争、验证推动的工程细节 */}
  6. ## 双轨架构:TodoWrite V1 与 Tasks V2
  7. Claude Code 的任务管理并非单一系统,而是两个并存、按运行模式切换的实现:
  8. | 维度 | V1: TodoWrite | V2: TaskCreate / TaskUpdate / TaskList / TaskGet |
  9. |------|--------------|--------------------------------------------------|
  10. | **启用条件** | 非交互式(pipe/SDK)或 `isTodoV2Enabled()` 返回 `false` | 交互式 REPL(默认)或 `CLAUDE_CODE_ENABLE_TASKS=1` |
  11. | **存储** | 内存中 `AppState.todos[sessionId]`(Zustand store) | 文件系统 `~/.claude/tasks/<taskListId>/<id>.json` |
  12. | **数据模型** | `{content, status, activeForm}` — 扁平三元组 | `{id, subject, description, activeForm, owner, status, blocks[], blockedBy[], metadata}` — 完整实体 |
  13. | **持久化** | 进程退出即丢失 | 跨进程存活,支持多 Agent 并发访问 |
  14. | **并发安全** | 无(单会话单写者) | 文件锁 + 高水位标记 + TOCTOU 防护 |
  15. 切换逻辑位于 `isTodoV2Enabled()`(`src/utils/tasks.ts:133`):交互式会话默认启用 V2,SDK/pipe 模式回落 V1。两者互斥——`TodoWriteTool.isEnabled` 返回 `!isTodoV2Enabled()`,而 `TaskCreateTool.isEnabled` 返回 `isTodoV2Enabled()`。
  16. ## V1:TodoWrite 的极简设计
  17. TodoWrite 本质是一个**全量替换**操作——每次调用传入完整的 `todos[]` 数组,完全覆盖之前的状态:
  18. ```typescript
  19. // src/tools/TodoWriteTool/TodoWriteTool.ts — call() 核心逻辑
  20. async call({ todos }, context) {
  21. const todoKey = context.agentId ?? getSessionId()
  22. const oldTodos = appState.todos[todoKey] ?? []
  23. const allDone = todos.every(_ => _.status === 'completed')
  24. const newTodos = allDone ? [] : todos // 全部完成则清空列表
  25. // ... 写入 AppState
  26. }
  27. ```
  28. ### 智能清空与验证推动
  29. 一个微妙的设计:当所有任务都 `completed` 时,`newTodos` 被设为空数组(而非保留 `completed` 列表)。这确保 UI 上不会有"已完成"的视觉噪音。
  30. 此外,V1 包含一个**验证推动**(verification nudge)机制:当主线程 Agent 完成 3+ 个任务且没有任何一个是验证步骤时,系统在 tool_result 中追加提示,催促 Agent 派生验证子 Agent:
  31. ```typescript
  32. // 条件:主线程 + 全部完成 + ≥3 项 + 无验证任务
  33. if (allDone && todos.length >= 3 && !todos.some(t => /verif/i.test(t.content))) {
  34. verificationNudgeNeeded = true
  35. }
  36. // tool_result 中追加:
  37. // "NOTE: You just closed out 3+ tasks and none was a verification step..."
  38. ```
  39. 这是防止 Agent "自说自话地宣布完成"的防御性设计——通过结构性推动而非硬约束。
  40. ## V2:文件系统持久化的任务系统
  41. ### 数据模型
  42. 每个任务是一个独立 JSON 文件,路径为 `~/.claude/tasks/<taskListId>/<id>.json`:
  43. ```typescript
  44. // src/utils/tasks.ts — TaskSchema
  45. {
  46. id: string, // 自增整数(1, 2, 3...)
  47. subject: string, // 祈使句标题(如 "Fix auth bug")
  48. description: string, // 详细描述
  49. activeForm?: string, // 进行时形式(如 "Fixing auth bug"),用于 spinner
  50. owner?: string, // 认领该任务的 Agent ID/名称
  51. status: "pending" | "in_progress" | "completed",
  52. blocks: string[], // 此任务阻塞哪些任务 ID
  53. blockedBy: string[], // 哪些任务 ID 阻塞此任务
  54. metadata?: Record<string, unknown> // 任意附加数据
  55. }
  56. ```
  57. ### 任务列表 ID 的解析优先级
  58. `getTaskListId()` 按 5 级优先级解析任务归属:
  59. 1. `CLAUDE_CODE_TASK_LIST_ID` 环境变量(显式覆盖)
  60. 2. 进程内 teammate 上下文的 teamName(共享 leader 的任务列表)
  61. 3. `CLAUDE_CODE_TEAM_NAME` 环境变量(进程级 teammate)
  62. 4. Leader 通过 `setLeaderTeamName()` 设置的 teamName
  63. 5. `getSessionId()`(独立会话的兜底)
  64. 这意味着多 Agent 团队模式下,所有 teammate 自动共享同一个任务列表,无需额外协调。
  65. ### ID 分配与高水位标记
  66. 任务 ID 是简单的递增整数,但在并发场景下需要防止竞争:
  67. ```typescript
  68. // src/utils/tasks.ts — createTask() 简化
  69. async function createTask(taskListId, taskData) {
  70. release = await lockfile.lock(lockPath, LOCK_OPTIONS) // 获取排他锁
  71. const highestId = await findHighestTaskId(taskListId) // 读取当前最大 ID
  72. const id = String(highestId + 1) // 递增
  73. await writeFile(path, JSON.stringify({ id, ...taskData }))
  74. return id
  75. }
  76. ```
  77. 锁配置使用指数退避重试 30 次(总计约 2.6 秒),适配 10+ 并发 Agent 的 swarm 场景。
  78. 高水位标记文件 `.highwatermark` 确保删除任务后 ID 不会被重用——即使任务 #5 被删除,下一个新建任务仍然是 #6。
  79. ## 依赖管理:blocks / blockedBy
  80. 任务间的依赖通过双向链表式的 `blocks` / `blockedBy` 字段实现:
  81. - `taskA.blocks = ["3"]` 表示 "任务 A 完成前,任务 3 不能开始"
  82. - `task3.blockedBy = ["A"]` 表示 "任务 3 必须等任务 A 完成"
  83. `blockTask()` 函数同时维护两端:
  84. ```typescript
  85. // src/utils/tasks.ts — blockTask()
  86. // A blocks B → 更新 A.blocks 加入 B,同时更新 B.blockedBy 加入 A
  87. if (!fromTask.blocks.includes(toTaskId)) {
  88. await updateTask(taskListId, fromTaskId, { blocks: [...fromTask.blocks, toTaskId] })
  89. }
  90. if (!toTask.blockedBy.includes(fromTaskId)) {
  91. await updateTask(taskListId, toTaskId, { blockedBy: [...toTask.blockedBy, fromTaskId] })
  92. }
  93. ```
  94. 删除任务时,系统自动清理所有指向它的依赖引用(`deleteTask()` 遍历全部任务移除 `blocks` 和 `blockedBy` 中的引用)。
  95. ## 任务认领与并发控制
  96. `claimTask()` 是 V2 的核心并发原语,支持两种锁定粒度:
  97. ### 1. 任务级锁(默认)
  98. 仅锁定目标任务文件,适合单 Agent 场景:
  99. ```
  100. getTask → 检查 owner → 检查 status → 检查 blockedBy → 写入 owner
  101. ```
  102. ### 2. 列表级锁 + Agent 忙碌检查
  103. 当 `checkAgentBusy: true` 时,锁定整个任务列表目录(`.lock` 文件),原子化地完成:
  104. ```
  105. listTasks → 检查任务状态 → 检查依赖 → 检查 Agent 是否已拥有其他未完成任务 → 写入 owner
  106. ```
  107. 认领失败有 4 种原因:
  108. | `reason` | 含义 |
  109. |----------|------|
  110. | `task_not_found` | 任务 ID 不存在 |
  111. | `already_claimed` | 已被其他 Agent 认领 |
  112. | `already_resolved` | 任务已标记 completed |
  113. | `blocked` | blockedBy 列表中有未完成的任务 |
  114. | `agent_busy` | 该 Agent 已拥有其他未完成任务(仅 `checkAgentBusy` 模式) |
  115. ## Agent 团队的任务生命周期
  116. 在 swarms 模式下,任务系统的生命周期是这样的:
  117. ```
  118. Leader 创建团队
  119. Leader 用 TaskCreate 创建任务(status=pending, owner=undefined)
  120. Leader 用 TaskUpdate 设置依赖关系(addBlocks/addBlockedBy)
  121. Teammate 调用 TaskList → 发现可认领的任务
  122. Teammate 调用 TaskUpdate(taskId, {status: "in_progress"})
  123. → 自动设置 owner 为 teammate 名称
  124. → Leader 通过 mailbox 收到 task_assignment 通知
  125. Teammate 完成工作 → TaskUpdate(taskId, {status: "completed"})
  126. → tool_result 提示 "Call TaskList to find your next available task"
  127. → 依赖此任务的其他任务自动解锁
  128. Teammate 异常退出 → unassignTeammateTasks()
  129. → 未完成任务被重置为 pending + owner=undefined
  130. → Leader 收到通知并重新分配
  131. ```
  132. ### Hooks 集成
  133. TaskCreate 和 TaskUpdate 都集成了 hooks 系统:
  134. - **创建时**:`executeTaskCreatedHooks` — 外部钩子可以阻断任务创建(blockingError 导致任务被立即删除)
  135. - **完成时**:`executeTaskCompletedHooks` — 外部钩子可以阻断任务标记为完成
  136. 这允许外部系统(CI、审批流)参与任务状态机。
  137. ## activeForm:终端 UX 的细节
  138. 每个任务有两个文案字段:
  139. - `subject`:祈使句,用于任务列表展示("Fix auth bug")
  140. - `activeForm`:进行时形式,用于 spinner 动画("Fixing auth bug...")
  141. 当 `activeForm` 缺省时,spinner 回退显示 `subject`。这个看似微小的设计确保了用户在等待时看到的是"正在做什么"而非"要做什么"。
  142. ## Plan Mode 与任务系统的配合
  143. Plan Mode(计划模式)和任务系统是互补但独立的机制:
  144. 1. Plan Mode 限制工具集为只读(搜索、阅读),迫使 AI 先理解再行动
  145. 2. AI 在 Plan Mode 中用 TaskCreate 建立任务列表
  146. 3. 用户审批后退出 Plan Mode
  147. 4. AI 按 `blockedBy` 拓扑序逐项执行,每项用 TaskUpdate 标记进度
  148. `shouldDefer: true` 属性确保这些工具调用不会触发权限确认弹窗——任务管理操作始终自动批准,因为它们不产生副作用。