architecture-overview.mdx 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. ---
  2. title: "架构全景 - Claude Code 五层架构详解"
  3. description: "从交互层到基础设施层,详解 Claude Code 的五层架构设计。基于 src/main.tsx、src/QueryEngine.ts、src/query.ts、src/tools.ts、src/services/api/claude.ts 的源码级数据流分析。"
  4. keywords: ["Claude Code 架构", "五层架构", "QueryEngine", "Agentic Loop", "数据流"]
  5. ---
  6. {/* 本章目标:一张图讲清楚整体架构,为后续章节建立坐标系 */}
  7. ## 五层架构
  8. Claude Code 从上到下分为五个层次,每一层职责清晰、边界分明:
  9. <Frame caption="Claude Code 五层架构">
  10. <img src="/docs/images/architecture-layers.png" alt="Claude Code 五层架构图" />
  11. </Frame>
  12. | 层次 | 职责 | 入口源码 | 关键词 |
  13. |------|------|---------|--------|
  14. | **交互层** | 终端 UI、用户输入、消息展示 | `src/screens/REPL.tsx` | React/Ink、PromptInput |
  15. | **编排层** | 多轮对话、会话持久化、成本追踪 | `src/QueryEngine.ts` | QueryEngine、transcript |
  16. | **核心循环层** | 单轮:发请求 → 拿响应 → 执行工具 → 循环 | `src/query.ts` | Agentic Loop、State |
  17. | **工具层** | AI 的"双手"——读写文件、执行命令 | `src/tools.ts` → `src/Tool.ts` | Tool 接口、MCP |
  18. | **通信层** | 与 Claude API 的流式通信 | `src/services/api/claude.ts` | Streaming、Provider |
  19. ## 一条主数据流的源码追踪
  20. <Frame caption="核心数据流">
  21. <img src="/docs/images/data-flow.png" alt="Claude Code 核心数据流" />
  22. </Frame>
  23. 整个系统的运转可以浓缩为一条核心数据流,以下是每一步对应的源码路径:
  24. ### 1. 用户输入 → REPL
  25. `src/screens/REPL.tsx` 是基于 React/Ink 的终端 UI 组件。用户输入经 `processUserInput()`(`src/utils/processUserInput/processUserInput.ts`)处理,支持斜杠命令、文件附件、图片等。
  26. ### 2. QueryEngine 编排
  27. `src/QueryEngine.ts` 是 REPL 与 `query()` 之间的中间层,管理:
  28. - **会话状态**:消息数组、工具权限上下文(`ToolPermissionContext`)、文件历史快照
  29. - **成本追踪**:`accumulateUsage()` / `getTotalCost()` 累计 token 用量
  30. - **Transcript 持久化**:`recordTranscript()` 将对话序列化到磁盘,支持 `--resume`
  31. - **文件历史**:`fileHistoryMakeSnapshot()` 在修改前创建快照,支持 undo
  32. 关键方法:`queryEngine.query()` 构造 `QueryParams`,调用 `query()` 异步生成器。
  33. ### 3. Agentic Loop(`src/query.ts`)
  34. `query()` 是一个 `AsyncGenerator`,`while(true)` 循环的每次迭代包含:
  35. ```
  36. ① 上下文预处理管道:
  37. applyToolResultBudget → snipCompact → microcompact → contextCollapse → autocompact
  38. ② 流式 API 调用:
  39. deps.callModel() → AsyncGenerator<StreamEvent | Message>
  40. 收集 assistantMessages[]、toolUseBlocks[]
  41. ③ 工具执行:
  42. StreamingToolExecutor(并行) 或 runTools(串行)
  43. → toolResults[]
  44. ④ 终止/继续判定:
  45. needsFollowUp ? continue : return { reason }
  46. ```
  47. 完整的状态机通过 `State` 类型(`src/query.ts:204`)在迭代间传递,包含 10 个字段(messages、autoCompactTracking、maxOutputTokensRecoveryCount 等)。
  48. ### 4. 工具层(`src/tools.ts` → `src/Tool.ts`)
  49. `getAllBaseTools()`(`src/tools.ts:191`)组装 50+ 工具列表,经过 `filterToolsByDenyRules()` 权限过滤后传给 API。
  50. 每个工具实现 `Tool<Input, Output, Progress>` 接口(`src/Tool.ts:362`),核心方法链:
  51. ```
  52. validateInput() → canUseTool()(UI 层)→ checkPermissions() → call() → ToolResult
  53. ```
  54. ### 5. 通信层(`src/services/api/claude.ts`)
  55. API 客户端支持 4 种 Provider:
  56. - **Anthropic Direct**:默认
  57. - **AWS Bedrock**:`ANTHROPIC_BEDROCK_BASE_URL`
  58. - **Google Vertex**:`ANTHROPIC_VERTEX_PROJECT_ID`
  59. - **Azure**:通过自定义 base URL
  60. `deps.callModel()` 发起流式请求,返回 `BetaRawMessageStreamEvent` 事件流。支持 Prompt Cache(`cache_control`)、thinking blocks、multi-turn tool use。
  61. ## 四个核心设计原则
  62. <AccordionGroup>
  63. <Accordion title="流式优先 (Streaming-first)">
  64. 所有 API 通信都是流式的——`deps.callModel()` 返回 AsyncGenerator,用户看到 AI "逐字打出"回答。StreamingToolExecutor 在流式过程中就开始并行执行工具,不等流结束。模型降级(Fallback)时,已收集的 assistantMessages 被标记为 tombstone 并清空,重试整个流式请求。
  65. </Accordion>
  66. <Accordion title="工具即能力 (Tool as Capability)">
  67. 每个工具是 `Tool<Input, Output, Progress>` 结构化类型,通过 `buildTool()` 工厂创建。`getTools()` 在每次 API 调用时组装(非全局缓存),因为 `isEnabled()` 可能随运行时状态变化。MCP 工具通过 `mcpInfo` 字段标记来源,支持 server 级别的 blanket deny。
  68. </Accordion>
  69. <Accordion title="权限即边界 (Permission as Boundary)">
  70. 每次工具调用经过 `validateInput() → checkPermissions()` 双重检查。权限规则从 5 个来源汇聚(session → project → user → managed → default),支持工具名、命令模式、路径前缀等匹配方式。Plan Mode 通过 `prepareContextForPlanMode()` 切换为只读模式,退出时自动恢复。
  71. </Accordion>
  72. <Accordion title="上下文即记忆 (Context as Memory)">
  73. System Prompt 由 `fetchSystemPromptParts()` 动态组装,包含 CLAUDE.md、git 状态、日期、MCP 服务器列表。Auto-compact 在每轮迭代前评估 token 阈值,超出时触发压缩。压缩后的摘要通过 `buildPostCompactMessages()` 替换原始消息,`taskBudgetRemaining` 跨压缩边界累计。
  74. </Accordion>
  75. </AccordionGroup>
  76. ## 入口与引导
  77. | 入口 | 文件 | 说明 |
  78. |------|------|------|
  79. | CLI 启动 | `src/entrypoints/cli.tsx` | 注入 `feature()` polyfill(始终返回 false)、MACRO 全局变量 |
  80. | 命令定义 | `src/main.tsx` | Commander.js 解析参数,初始化 auth/analytics/policy |
  81. | 一次性初始化 | `src/entrypoints/init.ts` | 遥测配置、信任对话框 |
  82. | 管道模式 | `src/main.tsx` `-p` flag | `echo "say hello" \| bun run dev -p` |