沙箱 - LangChain中文文档

编码 Agent 需要的不仅仅是聊天窗口。它们需要文件浏览器、代码查看器和差异面板，即 IDE 体验。这个模式将深度 Agent 连接到沙箱，使其可以在隔离环境中读取、写入和执行代码，然后通过自定义 API 服务器公开沙箱文件系统，以便前端可以在 Agent 工作时实时显示文件。

架构

沙箱模式有三个层次：

带有沙箱后端的深度 Agent： Agent 自动从沙箱获取文件系统工具（read_file、write_file、edit_file、execute）
自定义 API 服务器 — 通过 langgraph.json 的 http.app 字段公开的 FastAPI 应用，提供前端可调用的文件浏览端点
IDE 前端： 三面板布局（文件树、代码/差异查看器、聊天）在 Agent 进行更改时实时同步文件

沙箱生命周期

在深入了解代码之前，了解沙箱如何进行作用域管理很重要。作用域策略决定了谁共享沙箱、沙箱存活多长时间，以及如何在运行时解析它。

线程作用域沙箱（推荐）

每个 LangGraph 线程获得自己的沙箱。沙箱 ID 存储在线程的元数据中，并通过 getConfig() 在运行时解析。这是大多数应用的推荐方法：

对话是隔离的 —— 一个线程中的文件更改不会影响另一个线程
沙箱状态跨页面重载持久化（相同的线程 = 相同的沙箱）
清理很简单：当线程被删除时，其沙箱也可以被删除

代理作用域沙箱

同一助手下的所有线程共享一个沙箱。对于您希望更改跨对话持续存在的持久项目环境很有用：

from langgraph.config import get_config

def get_sandbox_backend_for_assistant():
    config = get_config()
    assistant_id = config.get("metadata", {}).get("assistant_id")
    return get_or_create_sandbox_for_assistant(assistant_id)

用户作用域沙箱

每个用户在所有线程中获得自己的沙箱。需要自定义身份验证和用户标识：

from langgraph.config import get_config

def get_sandbox_backend_for_user():
    config = get_config()
    user_id = config.get("configurable", {}).get("user_id")
    return get_or_create_sandbox_for_user(user_id)

会话作用域沙箱（客户端）

对于没有 LangGraph 线程的更简单应用，前端可以生成会话 ID 并直接传递。这种方法不会跨浏览器会话持久化，最适合演示或原型设计：

import uuid
import urllib.parse
import urllib.request

session_id = str(uuid.uuid4())
query = urllib.parse.urlencode({"sessionId": session_id})
urllib.request.urlopen(f"http://localhost:2024/api/sandbox/tree?{query}")

本指南的其余部分使用线程作用域沙箱作为主要示例。

设置 Agent

选择沙箱提供商

Deep Agents 支持多个沙箱提供商。任何实现 SandboxBackendProtocol 的提供商都可以工作：

from deepagents import create_deep_agent
from deepagents.sandbox import LangSmithSandbox  # 或 DaytonaSandbox 等

sandbox = LangSmithSandbox.create()
agent = create_deep_agent(model="anthropic:claude-sonnet-4-5", backend=sandbox)

Agent 自动获取文件系统工具（read_file、write_file、edit_file、ls、glob、grep）和用于运行 shell 命令的 execute 工具。无需工具配置。

为每个线程解析沙箱

不要在模块级别创建沙箱（这将在所有线程之间共享并且可能会过期），而是在运行时按线程解析沙箱。沙箱通过 getConfig() 从 LangGraph config 读取 thread_id：

from deepagents import create_deep_agent
from deepagents.sandbox import LangSmithSandbox
from langgraph.config import get_config


def get_or_create_sandbox_for_thread(thread_id: str) -> LangSmithSandbox:
    # 根据 thread_id 查找或创建沙箱
    ...


sandbox = LangSmithSandbox(
    resolve=lambda: get_or_create_sandbox_for_thread(
        get_config()["configurable"]["thread_id"]
    ),
)

agent = create_deep_agent(
    model="anthropic:claude-sonnet-4-5",
    backend=sandbox,
)

填充沙箱

在 Agent 运行之前，使用 uploadFiles 将项目文件填充到沙箱中：

对于 LangSmith 沙箱，容器镜像和资源限制来自沙箱模板。创建沙箱时传递 templateName （参见上面的 get_or_create_sandbox_for_thread）。upload_files 在运行时在该镜像之上填充或更新项目文件。

const SEED_FILES: Record<string, string> = {
  "package.json": JSON.stringify({ name: "my-app", version: "1.0.0" }, null, 2),
  "src/index.js": 'console.log("Hello");',
};

const encoder = new TextEncoder();
await sandbox.uploadFiles(
  Object.entries(SEED_FILES).map(([path, content]) => [`/app/${path}`, encoder.encode(content)]),
);

上传 package.json 后运行 sandbox.execute("cd /app && npm install") 以在 Agent 开始之前安装依赖项。

添加文件浏览 API

Agent 可以读取和写入文件，但前端也需要直接访问浏览沙箱文件系统。添加自定义 FastAPI API 服务器，并通过 langgraph.json 中的 http.app 字段公开它。

创建 API 服务器

沙箱 API 端点使用线程 ID 作为 URL 路径参数。这确保前端始终访问当前对话的正确沙箱，使用与 Agent 后端相同的 get_or_create_sandbox_for_thread 函数：

# src/api/server.py
from fastapi import FastAPI, Query, Path
from utils import get_or_create_sandbox_for_thread

app = FastAPI()

@app.get("/api/sandbox/{thread_id}/tree")
async def list_tree(
    thread_id: str = Path(...),
    path: str = Query("/app"),
):
    sandbox = await get_or_create_sandbox_for_thread(thread_id)
    result = await sandbox.aexecute(
        f"find {path} -printf '%y\\t%s\\t%p\\n' 2>/dev/null | sort"
    )
    entries = []
    for line in result.output.strip().split("\n"):
        if not line:
            continue
        type_char, size_str, full_path = line.split("\t")
        entries.append({
            "name": full_path.split("/")[-1],
            "type": "directory" if type_char == "d" else "file",
            "path": full_path,
            "size": int(size_str),
        })
    return {"path": path, "entries": entries, "sandbox_id": sandbox.id}

@app.get("/api/sandbox/{thread_id}/file")
async def read_file(
    thread_id: str = Path(...),
    path: str = Query(...),
):
    sandbox = await get_or_create_sandbox_for_thread(thread_id)
    results = await sandbox.adownload_files([path])
    return {"path": path, "content": results[0].content.decode()}

Agent 的后端和 API 服务器都调用相同的 get_or_create_sandbox_for_thread 函数。这确保它们始终为给定线程解析到相同的沙箱。线程元数据中的沙箱 ID 是单一真实来源 —— 无需内存缓存。

配置 `langgraph.json`

{
  "graphs": {
    "coding_agent": "./src/agents/my_agent.py:agent"
  },
  "env": ".env",
  "http": {
    "app": "./src/api/server.py:app"
  }
}

您的自定义路由与 LangGraph API 位于同一主机上。对于使用 langgraph dev 的本地开发，那是 http://localhost:2024。

在 http.app 中定义的自定义路由优先于默认的 LangGraph 路由。这意味着您可以根据需要覆盖内置端点，但要注意不要意外覆盖 /threads 或 /runs 等路由。

构建前端

前端有三个面板：文件树侧边栏、代码/差异查看器和聊天面板。它使用 useStream 进行 Agent 对话，使用自定义 API 端点进行文件浏览。

线程创建

页面加载时创建 LangGraph 线程并将其 ID 持久化在 sessionStorage 中，这样页面重载会重新连接到相同的沙箱：

const THREAD_KEY = "sandbox-thread-id";

function IDEPreview() {
  const [threadId, setThreadId] = useState<string | null>(
    () => sessionStorage.getItem(THREAD_KEY),
  );

  const updateThreadId = useCallback((id: string | null) => {
    setThreadId(id);
    if (id) sessionStorage.setItem(THREAD_KEY, id);
    else sessionStorage.removeItem(THREAD_KEY);
  }, []);

  const stream = useStream<typeof myAgent>({
    apiUrl: AGENT_URL,
    assistantId: "coding_agent",
    threadId,
    onThreadId: updateThreadId,
  });

  // 首次挂载时创建线程
  useEffect(() => {
    if (threadId) return;
    stream.client.threads.create().then((t) => updateThreadId(t.thread_id));
  }, [stream.client, threadId, updateThreadId]);

  // 将 threadId 传递给沙箱文件钩子
  const { tree, files } = useSandboxFiles(threadId);
  // ...
}

“新线程”按钮清除存储的 ID，以便下一次挂载创建新的线程（和沙箱）：

function handleNewThread() {
  stream.switchThread(null);
  updateThreadId(null);
}

文件状态管理

跟踪沙箱文件系统的两个快照：原始状态（Agent 运行前）和当前状态（实时更新）。线程 ID 包含在 API URL 中，因此请求始终命中正确的沙箱：

const AGENT_URL = "http://localhost:2024";

async function fetchTree(threadId: string): Promise<FileEntry[]> {
  const res = await fetch(
    `${AGENT_URL}/api/sandbox/${encodeURIComponent(threadId)}/tree?filePath=/app`,
  );
  const data = await res.json();
  return data.entries.filter((e: FileEntry) => !e.path.includes("node_modules"));
}

async function fetchFile(threadId: string, path: string): Promise<string | null> {
  const res = await fetch(
    `${AGENT_URL}/api/sandbox/${encodeURIComponent(threadId)}/file?filePath=${encodeURIComponent(path)}`,
  );
  const data = await res.json();
  return data.content ?? null;
}

实时文件同步

IDE 体验的关键是在 Agent 工作时实时更新文件，而不是在 Agent 完成后更新。监视流的 ToolMessage 实例以查找文件修改工具。当 write_file 或 edit_file 工具调用完成时，刷新该特定文件。当 execute 完成时，刷新所有内容（因为 shell 命令可能修改任何文件）：

import { useStream } from "@langchain/react";
import { ToolMessage, AIMessage } from "langchain";

const FILE_MUTATING_TOOLS = new Set(["write_file", "edit_file", "execute"]);

export function IDEPreview() {
  const stream = useStream<typeof myAgent>({
    apiUrl: AGENT_URL,
    assistantId: "coding_agent",
  });

  const processedIds = useRef(new Set<string>());

  useEffect(() => {
    // 从 AI 消息构建文件修改工具调用的映射
    const toolCallMap = new Map();
    for (const msg of stream.messages) {
      if (!AIMessage.isInstance(msg)) continue;
      for (const tc of msg.tool_calls ?? []) {
        if (tc.id && FILE_MUTATING_TOOLS.has(tc.name)) {
          toolCallMap.set(tc.id, { name: tc.name, args: tc.args });
        }
      }
    }

    // 当文件修改工具的 ToolMessage 出现时，刷新
    for (const msg of stream.messages) {
      if (!ToolMessage.isInstance(msg)) continue;
      const id = msg.id ?? msg.tool_call_id;
      if (!id || processedIds.current.has(id)) continue;

      const call = toolCallMap.get(msg.tool_call_id);
      if (!call) continue;
      processedIds.current.add(id);

      if (call.name === "write_file" || call.name === "edit_file") {
        refreshSingleFile(call.args.path);
      } else if (call.name === "execute") {
        refreshAllFiles();
      }
    }
  }, [stream.messages]);
}

检测更改的文件

在每次 Agent 运行之前，快照当前文件内容。文件刷新后，与快照比较以识别哪些文件发生了变化：

function detectChanges(current: FileSnapshot, original: FileSnapshot): Set<string> {
  const changed = new Set<string>();
  for (const [path, content] of Object.entries(current)) {
    if (original[path] !== content) changed.add(path);
  }
  for (const path of Object.keys(original)) {
    if (!(path in current)) changed.add(path);
  }
  return changed;
}

当用户选择更改的文件时，默认使用差异视图，这样他们可以立即看到 Agent 修改了什么。

显示差异

使用适合框架的差异库来渲染统一差异：

框架	库	组件
React	`@pierre/diffs`	使用 `parseDiffFromFile` 的 `<FileDiff>`
Vue	`@git-diff-view/vue`	使用 `@git-diff-view/file` 的 `generateDiffFile` 的 `<DiffView>`
Svelte	`@git-diff-view/svelte`	使用 `@git-diff-view/file` 的 `generateDiffFile` 的 `<DiffView>`
Angular	`ngx-diff`	带 `[before]` 和 `[after]` 的 `<ngx-unified-diff>`

使用 @pierre/diffs（React）的示例：

import { FileDiff } from "@pierre/diffs/react";
import { parseDiffFromFile } from "@pierre/diffs";

function DiffPanel({ original, current, fileName }) {
  const diff = parseDiffFromFile(
    { name: fileName, contents: original },
    { name: fileName, contents: current },
  );

  return (
    <FileDiff
      fileDiff={diff}
      options={{ theme: "github-dark", diffStyle: "unified", diffIndicators: "bars" }}
    />
  );
}

更改文件摘要

显示所有已修改文件的摘要，包括逐行的添加/删除计数。这为用户提供 Agent 影响的快速概览 —— 类似于 git status：

function ChangedFilesSummary({ changedFiles, files, originalFiles, onSelect }) {
  const stats = [...changedFiles].map((path) => {
    const oldLines = (originalFiles[path] ?? "").split("\n");
    const newLines = (files[path] ?? "").split("\n");
    // 通过比较行来计算添加/删除
    return { path, additions, deletions };
  });

  return (
    <div>
      <h3>{stats.length} 个文件已更改</h3>
      {stats.map((file) => (
        <button key={file.path} onClick={() => onSelect(file.path)}>
          {file.path}
          <span className="text-green-400">+{file.additions}</span>
          <span className="text-red-400">-{file.deletions}</span>
        </button>
      ))}
    </div>
  );
}

三面板布局

IDE 布局将三个面板并排排列：

面板	宽度	用途
文件树	固定（208px）	浏览沙箱文件，查看更改指示器
代码/差异	灵活	查看文件内容或统一差异
聊天	固定（320px）	与 Agent 交互

<div className="flex h-screen">
  <div className="w-52 shrink-0">
    <FileTree />
    <ChangedFilesSummary />
  </div>

  <CodePanel /* flex-1 */ />

  <div className="w-80 shrink-0">
    <ChatPanel />
  </div>
</div>

文件树显示 VS Code 风格的图标（使用 @iconify-json/vscode-icons）和已修改文件上的琥珀色点。选择修改的文件会自动切换到差异选项卡。

用例

沙箱是正确的选择当：

编码 Agent 创建、修改和运行代码，需要聊天之外的视觉界面
代码审查工作流 Agent 建议更改，用户在接受之前审阅差异
教程或学习应用 AI 助手帮助用户逐步构建项目，实时显示上下文中的更改
原型设计工具 用户用自然语言描述功能，实时观看 Agent 实现它们

最佳实践

在生产应用中使用线程作用域沙箱。将沙箱 ID 存储在线程元数据中，并通过 getConfig() 在运行时解析。这避免了模块级状态并保持每个对话的沙箱隔离。
在 Agent 后端和 API 服务器之间共享 getOrCreateSandboxForThread。两者应该通过线程元数据以相同方式解析沙箱 —— 所以有单一真实来源，没有内存缓存。
在 sessionStorage 中持久化 threadId，以便页面重载重新连接到相同的线程和沙箱，而不是创建新的。
在每个相关工具调用时同步文件，而不是仅在运行完成时。这使 IDE 感觉是实时的。监视 write_file、edit_file 和 execute 工具消息并立即刷新。
对于已更改的文件默认使用差异视图。当用户点击被 Agent 修改的文件时，首先显示差异 —— 这是他们关心的。
对于只读操作显示紧凑的工具结果。不要在聊天中转储 read_file 的完整输出，而是显示一行摘要，如 Read router.js L1-42。将完整输出显示保留给修改工具。
用真实项目填充沙箱。从空沙箱开始会让人迷失方向。上传一个可用的启动项目，以便用户（和 Agent）立即有上下文。
从文件树中过滤 node_modules。没有人想浏览数千个依赖文件。在获取树时将它们过滤掉。

Get started

Deployment

Core capabilities

Frontend

Protocols

Command line interface

沙箱

架构

沙箱生命周期

线程作用域沙箱（推荐）

代理作用域沙箱

用户作用域沙箱

会话作用域沙箱（客户端）

设置 Agent

选择沙箱提供商

为每个线程解析沙箱

填充沙箱

添加文件浏览 API

创建 API 服务器

配置 `langgraph.json`

构建前端

线程创建

文件状态管理

实时文件同步

检测更改的文件

显示差异

更改文件摘要

三面板布局

用例

最佳实践

Get started

Deployment

Core capabilities

Frontend

Protocols

Command line interface

​架构

​沙箱生命周期

​线程作用域沙箱（推荐）

​代理作用域沙箱

​用户作用域沙箱

​会话作用域沙箱（客户端）

​设置 Agent

​选择沙箱提供商

​为每个线程解析沙箱

​填充沙箱

​添加文件浏览 API

​创建 API 服务器

​配置 langgraph.json

​构建前端

​线程创建

​文件状态管理

​实时文件同步

​检测更改的文件

​显示差异

​更改文件摘要

​三面板布局

​用例

​最佳实践

架构

沙箱生命周期

线程作用域沙箱（推荐）

代理作用域沙箱

用户作用域沙箱

会话作用域沙箱（客户端）

设置 Agent

选择沙箱提供商

为每个线程解析沙箱

填充沙箱

添加文件浏览 API

创建 API 服务器

配置 `langgraph.json`

构建前端

线程创建

文件状态管理

实时文件同步

检测更改的文件

显示差异

更改文件摘要

三面板布局

用例

最佳实践