Skip to content

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

当将代理部署到 LangGraph 平台时,你通常需要在服务器启动时初始化数据库连接等资源,并确保在服务器关闭时正确关闭这些资源。生命周期事件允许你挂接到服务器的启动和关闭流程中,以处理这些关键的初始化和清理任务。

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

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

仅限 Python

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

创建应用

从一个**现有**的 LangGraph 平台应用程序开始,在你的 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 状态中
    app.state.db_session = async_session
    yield
    # 清理连接
    await engine.dispose()

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"
  }
  // 其他配置选项如认证、存储等。
}

启动服务器

在本地测试服务器:

langgraph dev --no-browser

当服务器启动时,你应该能看到启动信息被打印出来,并且当你使用 Ctrl+C 停止服务器时,会看到清理信息。

部署

你可以将你的应用直接部署到 LangGraph 平台,或者部署到你自己的托管平台。

下一步

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