Starlette如何优雅地关闭服务

夜明酱_2796

夜明酱_2796

2026-11-18

141人浏览

原创

starlette 优雅关闭服务需要利用 lifespan 事件机制,在应用启动时注册信号处理器,并在收到退出信号(如 sigterm)时触发清理逻辑。具体做法是创建一个自定义的 lifespan 函数,监听 "startup" 和 "shutdown" 事件,在 "shutdown" 阶段执行资源释放或等待任务完成的操作,然后将该函数传递给 starlette 实例的 lifespan 参数。

Starlette如何优雅地关闭服务

如何配置 Lifespan 以处理退出信号

通过定义一个异步生成器作为 lifespan 事件处理器,可以捕获应用的启动和关闭生命周期。在关闭阶段,可以使用 signal 模块注册回调,或者依赖 ASGI 服务器(如 Uvicorn)传递的关闭信号来触发清理代码的执行。

Starlette如何优雅地关闭服务

import asyncio
import signal
from starlette.applications import Starlette
from starlette.responses import PlainTextResponse
import uvicorn

# 全局状态用于模拟正在进行的任务
task_status = {"running": False}

async def lifespan(app):
    # 启动阶段
    print("Application startup")
    yield
    # 关闭阶段
    print("Application shutdown")
    # 在这里执行清理逻辑,例如等待后台任务结束
    if task_status["running"]:
        await asyncio.sleep(2)  # 模拟等待任务完成
    print("Cleanup complete")

app = Starlette(lifespan=lifespan)

@app.route("/")
async def homepage(request):
    return PlainTextResponse("Hello World")

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

上述代码展示了基本的 lifespan 结构。当服务器接收到终止信号时,ASGI 服务器会调用 lifespan 中的关闭部分。开发者可以在 yield 之后添加任何必要的清理代码,确保服务在退出前完成当前请求或后台任务。

如何在关闭期间阻止新请求并等待现有请求完成

为了实现更精细的控制,可以在关闭阶段设置一个标志位,阻止新的路由处理,同时允许已开始的请求继续执行直到完成。这通常涉及检查应用状态或在中间件中集成关闭逻辑。

Starlette如何优雅地关闭服务

Starlette 1.5.1
Starlette 1.5.1

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

下载
import asyncio
from starlette.applications import Starlette
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import JSONResponse
import uvicorn

# 用于控制是否接受新请求的标志
closing_flag = False

async def custom_lifespan(app):
    global closing_flag
    print("Startup")
    yield
    print("Shutdown initiated")
    closing_flag = True
    # 等待所有活跃任务完成
    await asyncio.sleep(1) 
    print("All tasks finished")

app = Starlette(lifespan=custom_lifespan)

class ShutdownMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        global closing_flag
        if closing_flag:
            return JSONResponse(
                status_code=503,
                content={"detail": "Service is shutting down"}
            )
        response = await call_next(request)
        return response

app.add_middleware(ShutdownMiddleware)

@app.route("/data")
async def get_data(request):
    await asyncio.sleep(0.5)  # 模拟耗时操作
    return JSONResponse({"data": "result"})

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

在这个示例中,ShutdownMiddleware 检查 closing_flag。如果为真,它返回 503 状态码,拒绝新请求。而已经在处理的请求会继续执行,因为它们在进入中间件时标志尚未设置。这种模式确保了服务的平滑过渡,避免了数据不一致或中断用户操作。

基于信号处理的具体问题:SIGTERM 到达时如何确保后台协程安全退出

当操作系统发送 SIGTERM 信号时,Uvicorn 等服务器会触发 lifespan 的关闭流程。关键在于确保所有后台创建的 Task 或 Coroutine 能够感知到关闭意图并安全退出,而不是被强制杀死导致资源泄漏。

可以通过在 lifespan 关闭阶段收集所有活跃的后台任务,并使用 asyncio.wait_for 或类似机制等待它们完成。如果任务超时,可以选择取消它们。此外,对于长期运行的后台进程,应定期检查一个共享的“停止”事件,以便在收到关闭信号时立即响应。

import asyncio
from starlette.applications import Starlette
import uvicorn

background_tasks = []
stop_event = asyncio.Event()

async def background_worker():
    try:
        while not stop_event.is_set():
            print("Worker running...")
            await asyncio.sleep(1)
    finally:
        print("Worker cleaned up")

async def lifespan(app):
    global stop_event
    # 启动后台任务
    task = asyncio.create_task(background_worker())
    background_tasks.append(task)
    
    yield
    
    # 关闭阶段
    print("Stopping background workers...")
    stop_event.set()  # 通知 worker 停止
    
    # 等待所有后台任务完成
    if background_tasks:
        await asyncio.gather(*background_tasks, return_exceptions=True)
    print("Background workers stopped")

app = Starlette(lifespan=lifespan)

if __name__ == "__main__":
    uvicorn.run(app, host="0.0.0.0", port=8000)

此代码演示了如何使用 asyncio.Event 来控制后台工作流的停止。在 lifespan 的关闭部分,设置 stop_event 后,等待所有关联的任务自然结束。这种方法比直接取消任务更安全,因为它允许任务进行最后的清理工作。

相关文章

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

796

23

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

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

2026.06.16

679

12

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

2026.11.17

0

15

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.17

0

15

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

2026.11.17

0

15

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

2026.11.17

0

10

SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查

SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。

2026.11.17

0

11

热门下载

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

精品课程

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