Starlette如何使用生命周期事件Startup和Shutdown

夏丽同学_3644

夏丽同学_3644

2026-11-17

815人浏览

原创

starlette 通过 lifespan 参数接收一个生命周期管理器来处理启动和关闭事件。你需要定义一个异步函数,在其中使用 async with 上下文管理器包裹初始化代码(启动)和清理代码(关闭),然后将该函数传递给 starlette 实例的 lifespan 参数。

Starlette如何使用生命周期事件Startup和Shutdown

如何定义并注册 lifespan 管理器

在 Starlette 中,生命周期管理依赖于一个符合特定签名的异步可调用对象。这个对象必须接收一个名为 receive 的字典参数,并根据其中包含的事件类型执行不同的逻辑。当收到 "lifespan.startup" 事件时,执行资源初始化;当收到 "lifespan.shutdown" 事件时,执行资源释放。最后,必须向外部发送 "lifespan.state" 事件以传递状态,或发送 "lifespan.complete" 表示结束。

import asyncio
from starlette.applications import Starlette
from starlette.routing import Route
from starlette.responses import PlainTextResponse

# 全局状态存储
db_connection = None

async def lifespan_manager(event_type: str):
    global db_connection
    if event_type == "startup":
        print("正在连接数据库...")
        await asyncio.sleep(1) # 模拟耗时操作
        db_connection = {"status": "connected"}
        yield {"db": db_connection} # 将状态传递给应用
    elif event_type == "shutdown":
        print("正在断开数据库连接...")
        await asyncio.sleep(1)
        db_connection = None

async def homepage(request):
    return PlainTextResponse("Hello World")

app = Starlette(
    routes=[Route("/", homepage)],
    lifespan=lifespan_manager
)

上述代码展示了最基础的生命周期实现。注意 yield 的使用:它允许函数暂停执行,等待应用运行,直到收到关闭信号时才继续执行 yield 之后的代码。这种结构确保了启动和关闭逻辑的原子性。

如何在路由中访问生命周期状态

通过 yield 传递给 lifespan 的状态字典会被注入到每个请求的 request.scope["state"] 中。这使得你可以在路由处理函数中安全地访问在启动阶段初始化的资源,如数据库连接池、配置对象或缓存客户端。这种方式避免了在每个路由中重复初始化资源,也保证了线程安全。

Starlette 1.5.1
Starlette 1.5.1

Starlette 1.5.1 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。

下载
async def get_db_status(request):
    # 从 request.scope 中获取 lifespan 传递的状态
    state = request.scope.get("state", {})
    db = state.get("db")
    
    if db and db.get("status") == "connected":
        return PlainTextResponse("Database is ready")
    else:
        return PlainTextResponse("Database not connected", status_code=503)

app = Starlette(
    routes=[
        Route("/", homepage),
        Route("/db-status", get_db_status)
    ],
    lifespan=lifespan_manager
)

在这个例子中,/db-status 端点直接读取了 lifespan_manager 中 yield 出来的 {"db": db_connection}。如果启动失败或未执行,db 将为 None,从而返回 503 错误。这是 Starlette 推荐的资源管理模式,它将资源的生存周期与应用的生命周期紧密绑定。

如何处理 lifespan 中的异常与错误恢复

如果在 startup 阶段发生异常,Starlette 会阻止应用进入就绪状态,并记录错误日志。此时,应用不会接受任何 HTTP 请求。对于 shutdown 阶段的异常,通常建议捕获并记录,以免阻塞进程退出。你可以使用 try...except 块来确保清理逻辑的健壮性,即使某些资源已经失效也能安全退出。

async def robust_lifespan(event_type: str):
    global db_connection
    try:
        if event_type == "startup":
            print("Starting up...")
            db_connection = await connect_to_db() # 假设此函数可能失败
            yield {"db": db_connection}
        elif event_type == "shutdown":
            print("Shutting down...")
            if db_connection:
                await db_connection.close()
    except Exception as e:
        print(f"Lifespan error: {e}")
        raise # 重新抛出异常以确保应用状态正确反映错误

async def connect_to_db():
    # 模拟可能失败的连接
    raise ConnectionError("DB unreachable")

app = Starlette(lifespan=robust_lifespan, routes=[])

在上面的代码中,如果 connect_to_db 抛出异常,startup 流程中断,yield 不会执行,应用保持非就绪状态。在 shutdown 中,我们检查 db_connection 是否存在再调用 close,防止因启动失败导致的空指针异常。这种模式确保了应用在各种边界条件下都能稳定运行。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

starlette

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

2026.02.06

594

18

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

2026.05.09

776

23

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

2026.06.16

679

12

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

140

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

100

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

140

13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程