代码语言

知识点思维导图

30 个知识节点

参考资料

项目实战（09） - 架构总览：控制平面 vs 执行平面

读完后，你应能完成以下任务：

绘制“项目实战（09） - 架构总览：控制平面 vs 执行平面 / 四层架构”的关键对象与数据流，解释“前端用前端的视角类比：UI 是 React SPA，通过 REST API 拿数据（TanStack Query 做缓存），这套大家都熟。”，并用源码位置、日志或 Trace 标注证据。

为“项目实战（09） - 架构总览：控制平面 vs 执行平面 / 最重要的一张图：一次心跳的完整流转”设计正常与异常输入，验证“触发（Trigger）：调度器、手动 invoke、或事件（任务分配、@提及）触发一次心跳。 -> 适配器调用（Adapter invocation）：Server 调用该 Agent 配置的适配器的 execute() 函数。 -> Agent 进程（Agent process）：适配器启动 Agent 运行时（比如 Claude Code CLI），把 Paperclip 的环境变量和 prompt 喂给它。 -> Agent 干活（Agent work）：Agent 回调 Paperclip 的 REST API——查任务、签出任务、干活、更新状态。”，输出首个偏差位置与回归测试结果。

实现“项目实战（09） - 架构总览：控制平面 vs 执行平面 / 适配器模型（Adapter）：Paperclip 的灵魂”的最小代码或配置，检验“适配器是 Paperclip 和 Agent 运行时之间的桥。”，输出命令、结果与 Diff，并说明不适用边界。

本章目标：画出 Paperclip 的四层架构，讲清「一次心跳从触发到落库」的完整流转，吃透「只编排不运行」这条核心设计原则。这一章偏技术，但不写代码也能看懂。

一、先建立全局：架构总览：控制平面 vs 执行平面是什么？

理解“架构总览：控制平面 vs 执行平面”，先要把标题中的对象放进同一条处理链：它接收什么输入，经过哪些状态变化，最终用什么证据判断结果。下表不另造概念，只把作者正文已经解释的章节按依赖顺序连起来。

“架构总览：控制平面 vs 执行平面”的第一个核心判断是：前端用前端的视角类比：UI 是 React SPA，通过 REST API 拿数据（TanStack Query 做缓存），这套大家都熟。。先弄清这个判断中的对象和输入输出，后面的实现、故障和验收才有共同语境。

顺序	章节	读完本节应抓住的结论
1	四层架构	前端用前端的视角类比：UI 是 React SPA，通过 REST API 拿数据（TanStack Query 做缓存），这套大家都熟。
2	最重要的一张图：一次心跳的完整流转	触发（Trigger）：调度器、手动 invoke、或事件（任务分配、@提及）触发一次心跳。 -> 适配器调用（Adapter invocation）：Server 调用该 Agent 配置的适配器的 execute() 函数。 -> Agent 进程（Agent process）：适配器启动 Agent 运行时（比如 Claude Code CLI），把 Paperclip 的环境变量和 prompt 喂给它。 -> Agent 干活（Agent work）：Agent 回调 Paperclip 的 REST API——查任务、签出任务、干活、更新状态。
3	适配器模型（Adapter）：Paperclip 的灵魂	适配器是 Paperclip 和 Agent 运行时之间的桥。
4	常见误区	Paperclip 本身只是 Node + Postgres。
5	最佳实践	✅ 先理解数据流向再排查问题：分不清是「Paperclip 的锅」还是「Agent 运行时的锅」时，回想第三节那张图——API 之前是 Paperclip，之后是 Agent。
6	这一章偏技术	这一章偏技术，但不写代码也能看懂。

1.1 核心对象之间怎样衔接

flowchart LR
  S1["四层架构"] --> S2
  S2["最重要的一张图：一次心跳的完整流转"] --> S3
  S3["适配器模型（Adapter）：Paperclip 的灵魂"] --> S4
  S4["常见误区"] --> S5
  S5["最佳实践"]

这张图只表达本文的讲解顺序，不替代正文机制。判断“架构总览：控制平面 vs 执行平面”是否真正掌握，需要能从最后一个结果沿图回到前面每个章节的输入、状态变化和证据。

1.2 再看失败：问题最早会出现在哪一步？

在“架构总览：控制平面 vs 执行平面”的对象和顺序已经明确后，再看可观察的失败：条件缺失、结果不可复现或失败后责任不清。定位时不从最后一条错误猜原因，而是沿上图找第一个偏离正文结论的节点。

二、四层架构

Paperclip 是一个 monorepo（单仓多包），整体分四层：

┌─────────────────────────────────────┐
│  React UI (Vite)                     │  ← 你看的控制台：看板、组织管理、任务
├─────────────────────────────────────┤
│  Express.js REST API (Node.js)       │  ← 大脑：路由、业务逻辑、认证、适配器
├─────────────────────────────────────┤
│  PostgreSQL (Drizzle ORM)            │  ← 记忆：表结构、迁移、内嵌模式
├─────────────────────────────────────┤
│  Adapters（适配器）                   │  ← 桥梁：Claude Local / Codex / Process / HTTP
└─────────────────────────────────────┘

对应的技术栈（了解即可，不必背）：

层	技术
前端	React 19、Vite 6、React Router 7、Radix UI、Tailwind CSS 4、TanStack Query
后端	Node.js 20+、Express.js 5、TypeScript
数据库	PostgreSQL 17（或内嵌 PGlite）、Drizzle ORM
认证	Better Auth（会话 + API Key）
适配器	Claude Code CLI、Codex CLI、shell 进程、HTTP webhook
包管理	pnpm 9 + workspaces

前端用前端的视角类比：UI 是 React SPA，通过 REST API 拿数据（TanStack Query 做缓存），这套大家都熟。真正有意思的是适配器层——这是 Paperclip 的灵魂。

三、仓库结构速览

知道东西放在哪，看源码或排查问题时不抓瞎：

paperclip/
├── ui/                     # React 前端
│   ├── src/pages/          # 路由页面
│   ├── src/components/      # 组件
│   ├── src/api/            # API 客户端
│   └── src/context/         # React context
│
├── server/                 # Express API
│   ├── src/routes/          # REST 端点
│   ├── src/services/        # 业务逻辑
│   ├── src/adapters/        # Agent 执行适配器
│   └── src/middleware/      # 认证、日志
│
├── packages/
│   ├── db/                 # Drizzle schema + 迁移
│   ├── shared/             # API 类型、常量、校验器
│   ├── adapter-utils/       # 适配器接口和工具
│   └── adapters/
│       ├── claude-local/    # Claude Code 适配器
│       └── codex-local/     # OpenAI Codex 适配器
│
├── skills/                 # Agent 技能
│   └── paperclip/           # 核心技能（含心跳协议）
│
├── cli/                    # CLI 客户端
└── doc/                    # 内部文档

四、最重要的一张图：一次心跳的完整流转

这是整本书技术部分的核心。当一次心跳触发时，发生了什么？

①触发 ──▶ ②调用适配器 ──▶ ③启动 Agent 进程 ──▶ ④Agent 干活
                                                      │
                                          （调 Paperclip REST API）
                                                      │
⑥落库记录 ◀── ⑤捕获结果 ◀──────────────────────────┘

逐步拆解：

触发（Trigger）：调度器、手动 invoke、或事件（任务分配、@提及）触发一次心跳。
适配器调用（Adapter invocation）：Server 调用该 Agent 配置的适配器的 execute() 函数。
Agent 进程（Agent process）：适配器启动 Agent 运行时（比如 Claude Code CLI），把 Paperclip 的环境变量和 prompt 喂给它。
Agent 干活（Agent work）：Agent 回调 Paperclip 的 REST API——查任务、签出任务、干活、更新状态。
结果捕获（Result capture）：适配器捕获 stdout，解析 token 用量/成本，提取 session 状态。
运行记录（Run record）：Server 记下这次运行的结果、花费、session 状态（供下次心跳恢复上下文用）。

注意第 4 步的方向：是 Agent 主动调 Paperclip 的 API，不是 Paperclip 指挥 Agent 每一步。Paperclip 给的是「上下文 + 一个 prompt」，怎么干是 Agent 自己的事——它干活时通过 API 汇报。

五、适配器模型（Adapter）：Paperclip 的灵魂

适配器是 Paperclip 和 Agent 运行时之间的桥。每个适配器是一个包，含三个模块：

Server 模块：execute() 函数，负责启动/调用 Agent，外加环境诊断。
UI 模块：stdout 解析器（给运行查看器用）、创建 Agent 时的配置表单字段。
CLI 模块：给 paperclipai run --watch 用的终端格式化输出。

内置适配器：claude_local、codex_local、process、http（还有一批实验性的，第 06 章细讲）。 **任何能调 HTTP API 的运行时都能当 Agent。 **

my-adapter/
  src/
    index.ts          # 共享元数据（type、label、models）
    server/execute.ts  # 核心执行逻辑
    server/parse.ts    # 输出解析
    ui-parser.ts       # UI 转录解析
    cli/format-event.ts # 终端输出

六、五条关键设计决策

理解了这五条，你就理解了 Paperclip 为什么是现在这个样子：

设计决策	含义	为什么
控制平面，非执行平面	Paperclip 编排 Agent，不运行 Agent	解耦——大脑随便换（BYOB）
公司范围隔离	所有实体都属于唯一一家公司，数据边界严格	一个实例跑多家公司互不干扰
单负责人任务	原子签出，同一任务不会被并发处理	多 Agent 不打架
适配器无关	任何能调 HTTP API 的运行时都能当 Agent	不绑死某个 AI 厂商
默认内嵌	零配置本地模式，内嵌 PostgreSQL	五分钟就能跑起来

七、常见误区

❌ 「Paperclip 内部跑着大模型」 → 没有。模型跑在适配器拉起的外部进程里（如本机的 Claude Code CLI）。 Paperclip 本身只是 Node + Postgres。
❌ 「Agent 是 Paperclip 的一个线程/子模块」 → 不是。 Agent 是被适配器启动的独立进程（甚至是远程 HTTP 服务），通过 REST API 和 Paperclip 通信。
❌ 「换个 AI 厂商要改 Paperclip 源码」 → 不用。换适配器即可，甚至能装第三方/自研适配器，不动核心代码。
❌ 「内嵌数据库是玩具，生产不能用」 → 本地开发够用；生产可换外部 PostgreSQL（第 13 章）。内嵌只是默认值，不是唯一选项。

八、最佳实践

✅ 先理解数据流向再排查问题：分不清是「Paperclip 的锅」还是「Agent 运行时的锅」时，回想第三节那张图——API 之前是 Paperclip，之后是 Agent。
✅ 看运行记录（Run record）调试：每次心跳的 stdout、花费、session 都留痕，排查 Agent 行为先看这里。
✅ 适配器选型即架构决策：用 claude_local 还是 http，决定了 Agent 跑在哪、怎么计费、怎么扩展（第 06 章展开）。

九、动手验证：先跑通架构总览：控制平面 vs 执行平面，再改变一个变量

前面的章节已经建立问题、概念和机制。现在把“架构总览：控制平面 vs 执行平面”放进同一套基线中运行；本节不再引入新术语，只验证前文结论能否被复现。

9.1 基线与候选只允许一个变量不同

验证“架构总览：控制平面 vs 执行平面”时，先固定样本、基线、候选、成功标准和失败边界。候选方案只能改变本次要验证的变量；如果同时更换数据、依赖和配置，即使结果改善，也不能知道是哪一项产生作用。

执行“架构总览：控制平面 vs 执行平面”时，动作是：同环境运行基线与候选，记录输入、中间状态和异常。原始结果不能只保留截图或汇总分数，必须同步保存：可重放命令、结构化日志、输出 Diff、失败样本、版本，使下一次复查可以在同一输入上重放。

实验要素	本文要求
固定条件	固定样本、基线、候选、成功标准和失败边界
唯一变量	本次候选方案与基线之间的一项明确差异
原始证据	可重放命令、结构化日志、输出 Diff、失败样本、版本
通过阈值	结果符合结论条件，异常输入可解释、可恢复
立即停止	条件缺失、结果不可复现或失败后责任不清

9.2 执行前先排除不可比较条件

“架构总览：控制平面 vs 执行平面”开始前先确认下面四项；任一项不成立，都应先修复实验条件，而不是解释结果。

基线能够在“架构总览：控制平面 vs 执行平面”的当前环境重复运行。
候选只改变一个与“架构总览：控制平面 vs 执行平面”结论直接相关的条件。
“架构总览：控制平面 vs 执行平面”的基线和候选使用同一批输入、同一版本依赖与同一通过阈值。
“架构总览：控制平面 vs 执行平面”的原始输出和失败现场不会被重试、格式化或汇总覆盖。

9.3 执行后先核对证据完整性

结果出来后先检查证据，再讨论“架构总览：控制平面 vs 执行平面”是否通过。缺少中间状态时，最终输出只能说明现象，不能证明机制。

检查项	当前文章的判定
输入可追溯	固定样本、基线、候选、成功标准和失败边界
过程可回放	同环境运行基线与候选，记录输入、中间状态和异常
结果可审计	可重放命令、结构化日志、输出 Diff、失败样本、版本

“架构总览：控制平面 vs 执行平面”的一次合格基线对照按以下顺序执行：

保存“架构总览：控制平面 vs 执行平面”基线版本及输入摘要，确认基线本身可以重复运行。
写下“架构总览：控制平面 vs 执行平面”候选方案唯一变化的变量，以及它预期影响的指标。
在同一环境执行“架构总览：控制平面 vs 执行平面”：同环境运行基线与候选，记录输入、中间状态和异常。
为“架构总览：控制平面 vs 执行平面”保存：可重放命令、结构化日志、输出 Diff、失败样本、版本。
使用“架构总览：控制平面 vs 执行平面”预登记条件判断：结果符合结论条件，异常输入可解释、可恢复。
如果“架构总览：控制平面 vs 执行平面”未通过，不修改第二个变量，先恢复基线并保留失败现场。

十、用一张矩阵验证架构总览：控制平面 vs 执行平面的关键结论

矩阵按正文顺序列出“架构总览：控制平面 vs 执行平面”的结论。一次实验只选择一行，只改变这一行对应的条件；不要把多行合并成一个无法归因的大实验。

正文章节	已解释的结论	本轮唯一变量	必须保存的证据
四层架构	前端用前端的视角类比：UI 是 React SPA，通过 REST API 拿数据（TanStack Query 做缓存），这套大家都熟。	只改变与“四层架构”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本
最重要的一张图：一次心跳的完整流转	触发（Trigger）：调度器、手动 invoke、或事件（任务分配、@提及）触发一次心跳。 -> 适配器调用（Adapter invocation）：Server 调用该 Agent 配置的适配器的 execute() 函数。 -> Agent 进程（Agent process）：适配器启动 Agent 运行时（比如 Claude Code CLI），把 Paperclip 的环境变量和 prompt 喂给它。 -> Agent 干活（Agent work）：Agent 回调 Paperclip 的 REST API——查任务、签出任务、干活、更新状态。	只改变与“最重要的一张图：一次心跳的完整流转”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本
适配器模型（Adapter）：Paperclip 的灵魂	适配器是 Paperclip 和 Agent 运行时之间的桥。	只改变与“适配器模型（Adapter）：Paperclip 的灵魂”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本
常见误区	Paperclip 本身只是 Node + Postgres。	只改变与“常见误区”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本
最佳实践	✅ 先理解数据流向再排查问题：分不清是「Paperclip 的锅」还是「Agent 运行时的锅」时，回想第三节那张图——API 之前是 Paperclip，之后是 Agent。	只改变与“最佳实践”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本
这一章偏技术	这一章偏技术，但不写代码也能看懂。	只改变与“这一章偏技术”相关的条件	可重放命令、结构化日志、输出 Diff、失败样本、版本

10.1 记录本次实际实验

下面的记录用于“架构总览：控制平面 vs 执行平面”当前这一次实验，不是第二套知识目录。先从矩阵选择一个章节，再填写实际值；没有填写的字段表示尚未验证。

topic: "架构总览：控制平面 vs 执行平面"
selected_chapter: required
claim_from_article: required
baseline_version: required
changed_condition: exactly_one
execution: "同环境运行基线与候选，记录输入、中间状态和异常"
evidence: "可重放命令、结构化日志、输出 Diff、失败样本、版本"
pass_when: "结果符合结论条件，异常输入可解释、可恢复"
stop_when: "条件缺失、结果不可复现或失败后责任不清"
observed_result: required
first_deviation: null_or_evidence
recovery_replay: required_after_failure

10.2 边界实验必须证明能够停止和恢复

成功路径只能证明“架构总览：控制平面 vs 执行平面”在当前样本上工作，不能证明它可以进入生产。边界实验需要主动制造：条件缺失、结果不可复现或失败后责任不清，并观察系统是否在产生不可逆副作用前停止。

场景	只改变什么	应保存什么	通过标准
正常路径	使用已知有效输入	可重放命令、结构化日志、输出 Diff、失败样本、版本	结果符合结论条件，异常输入可解释、可恢复
边界路径	把一个输入推进到约束临界值	临界值前后的输出与指标	不静默降级，不把部分结果冒充成功
明确失败	注入：条件缺失、结果不可复现或失败后责任不清	原始错误、首个异常阶段和最终状态	失败被正确分类且没有扩大副作用
恢复重放	执行：保留基线，缩小变量；根因确认前不扩大范围	原失败样本的复测证据	原样本恢复，正常样本没有回归

恢复动作不是简单重启。对于“架构总览：控制平面 vs 执行平面”，第一步是：保留基线，缩小变量；根因确认前不扩大范围。完成后使用原始失败样本复测；只验证一个新样本成功，不能证明触发条件已经消失。

“架构总览：控制平面 vs 执行平面”边界实验结束后，应把正常、临界、失败和恢复四类记录放在同一个运行批次中。这样才能区分“候选方案真的修复问题”和“环境变化让问题暂时没有出现”。

十一、架构总览：控制平面 vs 执行平面的结果解释

解释“架构总览：控制平面 vs 执行平面”实验时先看首个偏差，而不是最后一条错误。最后的异常通常只是上游状态错误的结果；从末端反推容易误把症状当根因。

观察结果	可以支持的判断	下一步
主链路没有达到预期	条件缺失、结果不可复现或失败后责任不清	先执行：保留基线，缩小变量；根因确认前不扩大范围
异常链路无法恢复	条件缺失、结果不可复现或失败后责任不清	先执行：保留基线，缩小变量；根因确认前不扩大范围
新样本成功但原样本仍失败	修复没有覆盖原始触发条件	固定原失败输入，恢复基线后重新比较
指标改善但证据无法回链	数据、版本或中间状态没有固定	暂停发布，补齐可追溯记录后重跑

“架构总览：控制平面 vs 执行平面”只有同时满足“结果符合结论条件，异常输入可解释、可恢复”，并且没有出现“条件缺失、结果不可复现或失败后责任不清”，才可以认为主链路通过。这里的“通过”只对当前固定版本、样本和环境有效，不能外推到尚未测试的容量、权限或数据分布。

如果“架构总览：控制平面 vs 执行平面”候选方案与基线差异很小，先检查证据分辨率是否足够；如果差异很大，先排除数据泄漏、环境漂移和版本不一致。两种情况都不能只看一个汇总均值，需要回到逐样本输出和中间状态。

“架构总览：控制平面 vs 执行平面”故障定位完成后，记录“现象、首个偏差、根因、改动、原样本复测”五项。缺少原样本复测时，只能标记为待观察，不能标记为已解决。

十二、架构总览：控制平面 vs 执行平面的发布判断

发布判断需要把“架构总览：控制平面 vs 执行平面”的质量、失败边界和恢复能力放在同一份记录中。以下任一条件缺失，都应停止扩量，而不是用“基本正常”替代证据。

“架构总览：控制平面 vs 执行平面”的基线与候选只存在一个计划内变量。
“架构总览：控制平面 vs 执行平面”的输入、代码、依赖、配置和数据版本可以追溯。
“架构总览：控制平面 vs 执行平面”的正常、临界、失败和恢复样本使用同一套断言。
“架构总览：控制平面 vs 执行平面”的原始输出、中间状态和失败现场已经保留。
“架构总览：控制平面 vs 执行平面”的日志、Trace、截图和测试数据已经脱敏。
“架构总览：控制平面 vs 执行平面”的停止条件、负责人和回滚入口已经演练。
“架构总览：控制平面 vs 执行平面”尚未覆盖的输入、权限、容量和外部依赖已经登记。

最终记录至少包含基线版本、唯一变量、原始证据、首个偏差、恢复复测和发布责任人。没有参与本次修改的人如果不能据此重放“架构总览：控制平面 vs 执行平面”的判断，就不能发布。

十三、总结

四层架构：前端用前端的视角类比：UI 是 React SPA，通过 REST API 拿数据（TanStack Query 做缓存），这套大家都熟。
适配器模型（Adapter）：Paperclip 的灵魂：适配器是 Paperclip 和 Agent 运行时之间的桥。
五条关键设计决策：| 公司范围隔离 | 所有实体都属于唯一一家公司，数据边界严格 | 一个实例跑多家公司互不干扰 |
常见误区：Paperclip 本身只是 Node + Postgres。
最佳实践：✅ 先理解数据流向再排查问题：分不清是「Paperclip 的锅」还是「Agent 运行时的锅」时，回想第三节那张图——API 之前是 Paperclip，之后是 Agent。