Skip to content

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

在 LangGraph 平台上部署代理时,你通常需要在服务器启动时初始化数据库连接等资源,并确保在服务器关闭时正确关闭这些资源。生命周期事件允许你介入服务器的启动和关闭序列,以处理这些关键的设置和清理任务。

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

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

仅支持 Python

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

创建应用

如果是基于一个**现有的** 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.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 云平台,也可以部署到你自己托管的平台。

后续步骤

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

Comments