From e77bfa662ec43a5841ac086a0efd3c50039a6f97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E4=B8=89?= <142391390+zhansan379@users.noreply.github.com> Date: Sun, 7 Jun 2026 20:51:10 +0800 Subject: [PATCH] Update multi-turn.mdx (#1257) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 文档中对于多种交互模式以及会话处理未明确区分。参考源码src\screens\REPL.tsx --- docs/conversation/multi-turn.mdx | 318 ++++++++++++++++++++++++++++++- 1 file changed, 317 insertions(+), 1 deletion(-) diff --git a/docs/conversation/multi-turn.mdx b/docs/conversation/multi-turn.mdx index 0f4894da1..525c73df3 100644 --- a/docs/conversation/multi-turn.mdx +++ b/docs/conversation/multi-turn.mdx @@ -7,6 +7,322 @@ sourceRef: "3ec5675 (2026-04-08)" {/* 本章目标:从源码角度揭示会话编排、持久化存储、成本追踪和模型切换的完整链路 */} +首先要区分claude code的多种交互方式 + +REPL关注交互形态,SDK关注接入方式,ACP则关注通信协议。 + +### 🆚 核心概念对比 + +| 维度 | 🖥️ REPL (交互形态) | 🧩 SDK (接入方式) | 🌉 ACP (通信协议) | +| :--- | :--- | :--- | :--- | +| **是什么** | 供开发者直接在终端使用的**交互式对话环境** | 面向开发者的**程序化调用库**,供集成到其他应用 | 一种**开放式的通信标准**,连接不同AI Agent与编辑器 | +| **使用方式** | 1. 直接在终端输入`claude`命令
2. 进入专用界面(基于React Ink渲染)
3. 通过斜杠命令(如`/help`)交互 | 1. 在自己的Node.js/Python项目中安装SDK包(如`npm install claude-code-sdk`)
2. 通过API发送查询 | 1. 通过ACP适配器(如`claude-code-acp`)启动Claude Code
2. 供编辑器通过ACP协议与其通信 | +| **典型场景** | 开发者日常编写代码时,随时向其提问、修改代码或执行任务 | 将Claude Code的核心能力(对话、工具执行等)集成到自动化脚本、CI/CD流程或其他应用的后台中 | 将Claude Code的能力集成到JetBrains IDE、Zed等第三方编辑器中,利用其UI交互功能 | +| **主要特点** | - **面向人**:交互式、直观
- **功能完整**:可使用所有内置工具,并支持MCP集成
- **处理复杂任务**:可自主规划、执行多步操作 | - **面向程序**:编程化、可集成
- **轻量级**:不依赖Claude Code的完整运行时
- **由你控制**:适合在自有应用中实现自动化 | - **标准化**:统一不同Agent与编辑器间的通信
- **双向通信**:Agent可主动向编辑器请求文件、执行命令等
- **与编辑器深度整合**:能完全复用Claude Code的能力 | + +其中的 🧩 SDK (接入方式) 与 🌉 ACP (通信协议)采用如下QueryEngine实现会话管理 + +作为一个对话终端(🖥️ REPL 交互形态模式),则使用的是 onQueryImpl 在 src/screens/REPL.tsx 中调用 query() 函数 + +对于REPL 交互形态模式的调用链路如下 +``` +用户输入 + ↓ +onSubmit (REPL.tsx) + ↓ +handlePromptSubmit (handlePromptSubmit.ts) + ↓ +executeUserInput (handlePromptSubmit.ts) + ↓ +onQuery (REPL.tsx) + ↓ +onQueryImpl (REPL.tsx) + ↓ +query (query.ts) ← 在这里调用 +``` + +其中 + +query 函数是 Agentic Loop 的核心实现,包含 while(true) 循环处理对话回合 query.ts:460-522 + +onQueryImpl 是 REPL(Read-Eval-Print Loop)中与 AI 模型交互的核心控制器,它负责: + +1.环境准备(IDE、诊断、权限) + +2.会话标题的首次生成 + +3.构建动态系统提示和用户上下文 + +4.执行流式查询并实时更新 UI + +5.收集性能指标和最终清理 + +## `onQueryImpl` 方法的详细解析 +以下是对 `onQueryImpl` 方法的详细解析。该方法是一个 React `useCallback` 包装的异步函数,负责处理用户消息到 AI 模型(Claude)的**完整查询流程**,包括预处理、系统提示构建、工具上下文准备、流式查询执行、后处理与指标记录。 + +--- + +### 一、函数签名与参数 + +```typescript +const onQueryImpl = useCallback( + async ( + messagesIncludingNewMessages: MessageType[], + newMessages: MessageType[], + abortController: AbortController, + shouldQuery: boolean, + additionalAllowedTools: string[], + mainLoopModelParam: string, + effort?: EffortValue, + ) => { ... }, + [ ...dependencies ] +) +``` + +| 参数 | 说明 | +| -------------------------------- | ---------------------------------------------------------------------------------------- | +| `messagesIncludingNewMessages` | 包含新增消息的完整消息列表,用于构建模型输入 | +| `newMessages` | 本次新增的消息(例如用户刚输入的文本或附件) | +| `abortController` | 用于取消当前查询的控制器 | +| `shouldQuery` | 是否真正执行查询;若为 `false` 则跳过模型调用(例如处理无效斜杠命令、手动 compact 等) | +| `additionalAllowedTools` | 本轮查询额外允许的工具列表(通常来自 Skill 的 frontmatter) | +| `mainLoopModelParam` | 指定本次使用的主模型参数(如 `'claude-3-opus'`) | +| `effort` | 可选,覆盖全局的“努力程度”值(用于控制模型推理深度) | + +--- + +### 二、总体执行流程 + +下图概括了函数的主要分支与关键步骤: + +```mermaid +graph TD +A["开始"] --> B{shouldQuery?} +B -- true --> C["IDE集成:刷新MCP客户端,诊断追踪,关闭差异视图"] +B -- false --> D["仅处理compact边界/重置状态并返回"] +C --> E["标记项目onboarding完成"] +E --> F["尝试生成会话标题(仅一次)"] +F --> G["将additionalAllowedTools写入全局权限store"] +G --> H["获取ToolUseContext(含最新工具/MCP)"] +H --> I["如有effort,临时覆盖getAppState中的effortValue"] +I --> J["并行执行:系统提示/用户上下文/系统上下文/自动模式检查"] +J --> K["构建有效系统提示"] +K --> L["重置各类耗时计时器"] +L --> M["执行query生成器,流式处理事件"] +M --> N["若BUDDY开启,触发companion观察者"] +N --> O["若UDS_INBOX且中断,记录错误"] +O --> P["ant用户:收集API指标并插入指标消息"] +P --> Q["重置加载状态,输出性能报告,调用onTurnComplete"] +Q --> R["结束"] +D --> R +``` + +--- + +### 三、核心逻辑详解 + +#### 3.1 IDE 集成与诊断(仅 `shouldQuery = true`) + +```typescript +const freshClients = mergeClients(initialMcpClients, store.getState().mcp.clients); +diagnosticTracker.handleQueryStart(freshClients); +const ideClient = getConnectedIdeClient(freshClients); +if (ideClient) closeOpenDiffs(ideClient); +``` + +- 从 store 中获取最新的 MCP 客户端(因为 `useManageMCPConnections` 可能在闭包捕获后更新了状态)。 +- 通知诊断追踪器查询开始。 +- 若存在已连接的 IDE 客户端,关闭所有打开的差异视图(清理环境)。 + +#### 3.2 会话标题生成(仅一次) + +```typescript +if (!titleDisabled && !sessionTitle && !agentTitle && !haikuTitleAttemptedRef.current) { + const firstUserMessage = newMessages.find(m => m.type === 'user' && !m.isMeta); + const text = getContentText(firstUserMessage.message.content); + if (text && !text.startsWith(`<${LOCAL_COMMAND_STDOUT_TAG}>`) ... ) { + haikuTitleAttemptedRef.current = true; + generateSessionTitle(text, ...).then(title => setHaikuTitle(title)); + } +} +``` + +- 仅当全局标题未禁用、当前无任何标题且从未尝试过时执行。 +- 从新增消息中提取第一条**非元用户消息**的真实文本。 +- 跳过合成面包屑(如 slash 命令输出、skill 扩展标记等)。 +- 异步调用 `generateSessionTitle`,结果通过 `setHaikuTitle` 保存;失败则重置 ref 允许重试。 + +#### 3.3 权限工具覆盖写入 Store + +```typescript +store.setState(prev => { + const cur = prev.toolPermissionContext.alwaysAllowRules.command; + if (cur === additionalAllowedTools || (cur?.length === ...)) return prev; + return { ...prev, toolPermissionContext: { ...prev.toolPermissionContext, alwaysAllowRules: { ...prev.toolPermissionContext.alwaysAllowRules, command: additionalAllowedTools } } }; +}); +``` + +- 将本轮 `additionalAllowedTools` 写入全局 store 的 `toolPermissionContext.alwaysAllowRules.command`。 +- 用于限定本轮查询中可用的工具集(例如 Skill 专属工具)。 +- 通过浅比较避免不必要的状态更新。 +- 即使在 `shouldQuery=false` 时也会执行(例如 forked 命令需要此权限信息),但原代码位置在 `shouldQuery` 分支**之前**,所以始终会更新。 + +#### 3.4 `shouldQuery = false` 分支 + +```typescript +if (!shouldQuery) { + if (newMessages.some(isCompactBoundaryMessage)) { + setConversationId(randomUUID()); + if (feature('PROACTIVE') || feature('KAIROS')) proactiveModule?.setContextBlocked(false); + } + resetLoadingState(); + setAbortController(null); + return; +} +``` + +- 处理不需要实际调用模型的情况(如用户输入了无效斜杠命令,或者手动 `/compact` 等)。 +- 若新消息中包含 **compact 边界消息**(压缩边界),则: + - 生成新的 `conversationId`,促使 UI 中消息行组件重新挂载。 + - 若开启了 PROACTIVE/KAIROS 特性,清除上下文阻塞标志(恢复主动提示)。 +- 最后重置加载状态并清空 abortController。 + +#### 3.5 查询前置准备(`shouldQuery = true`) + +##### 3.5.1 获取 ToolUseContext + +```typescript +const toolUseContext = getToolUseContext(messagesIncludingNewMessages, newMessages, abortController, mainLoopModelParam); +const { tools: freshTools, mcpClients: freshMcpClients } = toolUseContext.options; +``` + +- `getToolUseContext` 内部会从 store 中读取最新的 tools 和 MCP 客户端配置,确保闭包捕获的旧值不会导致遗漏新连接的工具或 MCP 服务器。 + +##### 3.5.2 Effort 覆盖(临时) + +```typescript +if (effort !== undefined) { + const previousGetAppState = toolUseContext.getAppState; + toolUseContext.getAppState = () => ({ ...previousGetAppState(), effortValue: effort }); +} +``` + +- 如果传入了 `effort` 参数,临时覆盖 `getAppState` 返回的 `effortValue`。 +- 作用域**仅限于本轮查询**,不影响全局 store,避免后台 Agent 或 UI 组件误读到该临时值。 + +##### 3.5.3 并行获取提示与上下文 + +```typescript +const [, , defaultSystemPrompt, baseUserContext, systemContext] = await Promise.all([ + undefined, + feature('TRANSCRIPT_CLASSIFIER') ? checkAndDisableAutoModeIfNeeded(...) : undefined, + getSystemPrompt(freshTools, mainLoopModelParam, additionalWorkingDirectories, freshMcpClients), + getUserContext(), + getSystemContext(), +]); +``` + +- 并行执行以下任务以节省时间: + - **自动模式断路器**:如果启用了转录分类器,检查并可能禁用快速模式(`fastMode`)。 + - **系统提示**:基于最新工具、模型参数、额外工作目录、MCP 客户端生成。 + - **用户上下文**:如当前工作区、环境变量等。 + - **系统上下文**:如操作系统、终端信息等。 + +##### 3.5.4 增强用户上下文 + +```typescript +const userContext = { + ...baseUserContext, + ...getCoordinatorUserContext(freshMcpClients, getScratchpadDir()), + ...((feature('PROACTIVE') || feature('KAIROS')) && proactiveModule?.isProactiveActive() && !terminalFocusRef.current + ? { terminalFocus: 'The terminal is unfocused — the user is not actively watching.' } + : {}), +}; +``` + +- 合并基本用户上下文、协调器上下文(与 MCP 协作相关)、以及可选的终端焦点状态(当 proactive 特性激活且终端未聚焦时,提示模型用户未在观看)。 + +##### 3.5.5 构建最终系统提示 + +```typescript +const systemPrompt = buildEffectiveSystemPrompt({ + mainThreadAgentDefinition, + toolUseContext, + customSystemPrompt, + defaultSystemPrompt, + appendSystemPrompt, +}); +``` + +- 整合主线程 Agent 定义、工具上下文、自定义系统提示、默认系统提示以及需要追加的内容。 + +#### 3.6 执行查询与流式事件处理 + +```typescript +resetTurnHookDuration(); resetTurnToolDuration(); resetTurnClassifierDuration(); +for await (const event of query({ messages, systemPrompt, userContext, systemContext, canUseTool, toolUseContext, querySource })) { + onQueryEvent(event); +} +``` + +- 重置本轮钩子、工具、分类器的耗时计时器。 +- 调用 `query` 生成器函数(负责与模型 API 通信并返回 SSE 事件流)。 +- 遍历每个事件并调用 `onQueryEvent`(通常用于更新 UI 消息列表、处理工具调用等)。 + +#### 3.7 后处理与指标收集 + +##### 3.7.1 BUDDY 特性(companion 反应) + +```typescript +if (feature('BUDDY') && typeof fireCompanionObserver === 'function') { + fireCompanionObserver(messagesRef.current, reaction => setAppState(prev => ({ ...prev, companionReaction: reaction }))); +} +``` + +- 将当前消息列表传递给 companion 观察者,并根据返回的反应更新全局状态。 + +##### 3.7.2 UDS_INBOX 中断处理 + +```typescript +if (feature('UDS_INBOX') && abortController.signal.aborted) { + pipeReturnHadErrorRef.current = true; + relayPipeMessage({ type: 'error', data: 'Slave request was interrupted before completion.' }); +} +``` + +- 若因中断导致查询未完成,标记错误并通过管道中继消息。 + +##### 3.7.3 Ant 内部用户的 API 指标记录 + +```typescript +if (process.env.USER_TYPE === 'ant' && apiMetricsRef.current.length > 0) { + const entries = apiMetricsRef.current; + const ttfts = entries.map(e => e.ttftMs); + const otpsValues = entries.map(e => { /* 计算每请求的 OTPs */ }); + const isMultiRequest = entries.length > 1; + // 创建 API 指标消息并添加到消息列表 + setMessages(prev => [...prev, createApiMetricsMessage({ ttftMs: isMultiRequest ? median(ttfts) : ttfts[0], ... })]); +} +``` + +- 仅当用户类型为 `'ant'` 且存在 API 指标记录时执行。 +- 收集每次请求的 **首字节时间 (TTFT)** 和 **每秒输出 Token 数 (OTPS)**。 +- 若本轮包含多次请求(例如工具调用循环),计算中位数(P50)后存入指标消息。 +- 同时记录钩子耗时、工具耗时、分类器耗时、本轮总时长、配置写入次数等。 + +##### 3.7.4 重置与清理 + +```typescript +resetLoadingState(); +logQueryProfileReport(); +await onTurnComplete?.(messagesRef.current); +``` + +- 重置加载状态(隐藏 loading 指示器)。 +- 输出查询性能报告(如果调试标志启用)。 +- 调用外部传入的 `onTurnComplete` 回调,并传递完整消息列表(通常用于触发后续行为如自动滚动、保存会话等)。 + + ## 单轮 vs 多轮:架构层面的差异 - **单轮**(一次 Agentic Loop):`query()` 函数的一次完整执行——组装上下文 → 调 API → 处理工具调用 → 循环直到结束 @@ -28,7 +344,7 @@ QueryEngine 内部状态(src/QueryEngine.ts 构造函数) ## QueryEngine 的核心方法:submitMessage() -每次用户输入一条消息,REPL 或 SDK 调用 `submitMessage()`,它会执行完整的 turn 初始化链路: +每次用户输入一条消息,SDK 调用 `submitMessage()`,它会执行完整的 turn 初始化链路: ```typescript // src/QueryEngine.ts — QueryEngine.submitMessage() 简化流程