讲师中心 微信公众号
AI工具推荐 视频效率加速

FastAPI WebSocket 中正确执行异步后台任务的完整指南

秋丽姑娘_5429

秋丽姑娘_5429

发布时间:2026-03-17 12:16:03

|

670人浏览过

|

来源于php中文网

原创

在 FastAPI 的 WebSocket 连接中,BackgroundTasks 不可用;必须改用 asyncio.create_task() 启动真正的异步后台协程,才能确保外部服务调用与 Redis 订阅逻辑并行执行。

在 fastapi 的 websocket 连接中,`backgroundtasks` 不可用;必须改用 `asyncio.create_task()` 启动真正的异步后台协程,才能确保外部服务调用与 redis 订阅逻辑并行执行。

WebSocket 是长连接、双向持续通信协议,而 FastAPI 的 BackgroundTasks 机制专为 HTTP 请求生命周期设计:它依赖 Request 对象,在响应返回客户端后立即触发,并在应用层自动管理任务生命周期(如异常捕获、作用域清理)。但 WebSocket 连接一旦建立,就不再有“请求完成”这一语义——连接长期保持,BackgroundTasks 因缺少上下文而无法注册或执行,这也是你调用 background_task.add_task(...) 后函数静默失效的根本原因。

要实现在 WebSocket 接入时立即触发外部服务调用(如通知下游系统向 Redis 发布消息),同时持续监听 Redis Pub/Sub 通道并将结果实时推送给客户端,应采用原生 asyncio 任务调度方式:

✅ 推荐方案:使用 asyncio.create_task()
该方法将协程直接提交至事件循环,不依赖任何请求上下文,完全适配 WebSocket 场景。注意:需手动处理异常(否则后台任务崩溃将无声失败),建议包裹 try/except 并记录日志。

以下是修正后的完整示例(含关键注释与健壮性增强):

import asyncio
import logging
from fastapi import FastAPI, WebSocket, WebSocketDisconnect
from redis import asyncio as aioredis
import aiohttp

app = FastAPI()
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

# ✅ 全局复用 HTTP 客户端(避免每次新建 session,提升性能与连接复用)
HTTP_CLIENT = None

@app.on_event("startup")
async def startup_event():
    global HTTP_CLIENT
    HTTP_CLIENT = aiohttp.ClientSession()

@app.on_event("shutdown")
async def shutdown_event():
    if HTTP_CLIENT:
        await HTTP_CLIENT.close()

async def call_external_server(channel: str, text: str):
    """异步调用外部服务,触发其向 Redis 发布数据"""
    try:
        logger.info(f"Triggering external server for channel: {channel}, text: {text}")
        async with HTTP_CLIENT.get(
            f"http://localhost:9000/pub?channel={channel}&text={text}"
        ) as resp:
            logger.debug(f"External server response: {resp.status}")
        logger.info("External server notified successfully")
    except Exception as e:
        logger.error(f"Failed to notify external server: {e}")

STOPWORD = "STOP"

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()

    # 从 headers 或 query 获取参数(示例中假设通过 header 传递)
    headers = dict(websocket.headers)
    channel = headers.get("x-channel", "default")
    text = headers.get("x-text", "")

    # 初始化 Redis Pub/Sub
    redis_client = await aioredis.from_url("redis://localhost")
    pubsub = redis_client.pubsub()
    await pubsub.subscribe(channel)
    logger.info(f"Subscribed to Redis channel: {channel}")

    # ✅ 正确启动后台任务:使用 asyncio.create_task
    # 注意:此处不 await,否则会阻塞 WebSocket 主循环
    asyncio.create_task(call_external_server(channel, text))

    try:
        while True:
            # 非阻塞获取消息,超时 1 秒避免永久挂起
            message = await pubsub.get_message(ignore_subscribe_messages=True, timeout=1.0)
            if message is not None:
                if isinstance(message["data"], bytes):
                    decoded_msg = message["data"].decode("utf-8")
                    if decoded_msg == STOPWORD:
                        logger.info("(Reader) Received STOP signal")
                        break
                    await websocket.send_text(decoded_msg)
    except WebSocketDisconnect:
        logger.info("Client disconnected")
    except Exception as e:
        logger.error(f"WebSocket error: {e}")
    finally:
        await pubsub.unsubscribe(channel)
        await redis_client.close()
        await websocket.close()

? 关键注意事项:

  • 绝不 await 后台任务:asyncio.create_task() 返回 Task 对象,直接调用即可并发执行;若 await 它,将退化为串行,失去后台意义。
  • 异常必须显式捕获:create_task 启动的任务若抛出未捕获异常,会静默终止且不中断主流程,务必在任务内部 try/except 并记录日志。
  • 资源复用至关重要:如示例所示,aiohttp.ClientSession 和 aioredis.Redis 应在应用生命周期内复用(startup/shutdown 事件管理),避免高频创建连接导致资源耗尽。
  • Redis Pub/Sub 需主动清理:WebSocket 断开时务必 unsubscribe 并关闭 client,防止内存泄漏和订阅堆积。

? 进阶提示:若需更严格的后台任务生命周期管理(如取消、等待完成、错误传播),可考虑封装为 asyncio.TaskGroup(Python 3.11+)或结合 asyncio.shield() + asyncio.wait_for() 实现超时控制与取消联动。

掌握这一模式,你就能在 FastAPI WebSocket 场景中可靠地解耦“触发动作”与“监听响应”,构建真正响应式、高并发的实时通信服务。

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

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1891

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

5164

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1829

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

31197

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3687

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3707

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1243

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

616

2023.08.10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn