跳转至

如何添加自定义生命周期事件

将智能代理部署到 LangGraph Platform 时,你经常需要在服务器启动时初始化资源(如数据库连接),并确保它们在关闭时正确关闭。生命周期事件让你可以挂接到服务器的启动和关闭序列来处理这些关键的设置和清理任务。

这与 添加自定义路由 的工作方式相同。你只需要提供自己的 Starlette 应用(包括 FastAPIFastHTML 和其他兼容应用)。

下面是一个使用 FastAPI 的示例。

仅限 Python

我们目前仅在 langgraph-api>=0.0.26 的 Python 部署中支持自定义生命周期事件。

创建应用

现有的 LangGraph Platform 应用开始,将以下生命周期代码添加到你的 webapp.py 文件中。如果你从零开始,可以使用 CLI 从模板创建新应用。

langgraph new --template=new-langgraph-project-python my_new_project

一旦你有了 LangGraph 项目,添加以下应用代码:

# ./src/agent/webapp.py
from contextlib import asynccontextmanager
from fastapi import FastAPI
from sqlalchemy.ext.asyncio import create_async_engine, AsyncSession
from sqlalchemy.orm import sessionmaker

@asynccontextmanager
async def lifespan(app: FastAPI):
    # 例如...
    engine = create_async_engine("postgresql+asyncpg://user:pass@localhost/db")
    # 创建可复用的会话工厂
    async_session = sessionmaker(engine, class_=AsyncSession)
    # 存储在应用状态中
    app.state.db_session = async_session
    yield
    # 清理连接
    await engine.dispose()

# highlight-next-line
app = FastAPI(lifespan=lifespan)

# ... 如果需要可以添加自定义路由。

配置 langgraph.json

将以下内容添加到你的 langgraph.json 配置文件中。确保路径指向你上面创建的 webapp.py 文件。

{
  "dependencies": ["."],
  "graphs": {
    "agent": "./src/agent/graph.py:graph"
  },
  "env": ".env",
  "http": {
    "app": "./src/agent/webapp.py:app"
  }
  // 其他配置选项如 auth、store 等
}

启动服务器

在本地测试服务器:

langgraph dev --no-browser

当服务器启动时你应该会看到启动消息,当你用 Ctrl+C 停止它时会看到清理消息。

部署

你可以将应用原样部署到 LangGraph Platform 或你的自托管平台。

后续步骤

现在你已经向部署添加了生命周期事件,可以使用类似的技术添加 自定义路由自定义中间件 来进一步自定义服务器的行为。