【Python笔记-FastAPI】后台任务+WebSocket监控进度

目录

一、代码示例

二、执行说明

[(一) 调用任务执行接口](#(一) 调用任务执行接口)

[(二) 监控任务进度](#(二) 监控任务进度)


实现功能:

  1. 注册后台任务(如:邮件发送、文件处理等异步场景,不影响接口返回)
  2. 监控后台任务执行进度(进度条功能)
  3. 支持根据任务ID查询对应任务进度

一、代码示例

python 复制代码
#!/usr/bin/env python
# -*- coding: UTF-8 -*-
import random
import asyncio

from typing import List, Dict
from fastapi import FastAPI, BackgroundTasks, WebSocket

app = FastAPI()

# 用于存储连接的 WebSocket 实例
connected_websockets: Dict[int, List[WebSocket]] = {}


@app.websocket("/ws/{task_id}/")
async def websocket_endpoint(websocket: WebSocket, task_id: int):
    """WebSocket路由,用于接收任务进度"""
    await websocket.accept()
    connected_websockets.setdefault(task_id, []).append(websocket)
    try:
        while True:
            await websocket.receive_text()
    except:
        connected_websockets[task_id].remove(websocket)


@app.post("/task/{task_id}/")
async def start_task(background_tasks: BackgroundTasks, task_id: int):
    """注册后台任务"""
    background_tasks.add_task(process_task, task_id=task_id)
    return {"task_id": task_id}


async def process_task(task_id):
    """处理任务的后台任务"""
    progress = 0
    while progress < 100:
        await asyncio.sleep(1)
        progress += random.randint(1, 10)
        progress = min(progress, 100)
        for ws in connected_websockets[task_id]:
            await ws.send_json({"task_id": task_id, "progress": progress})
    await asyncio.sleep(1)


# 启动应用
if __name__ == "__main__":
    import uvicorn

    uvicorn.run(app, host="0.0.0.0", port=8000)

二、执行说明

(一) 调用任务执行接口

  1. 启动服务后,访问:http://127.0.0.1:8000/docs
  2. POST请求:http://127.0.0.1:8000/task/1/,指定任务ID为1

(二) 监控任务进度

  1. 安装websocket请求工具:npm install -g wscat
  2. 终端输入wscat -c ws://127.0.0.1:8000/ws/1/,监控任务ID为1的执行进度
相关推荐
2501_915918414 小时前
接口漏洞怎么抓?Fiddler 中文版 + Postman + Wireshark 实战指南
websocket·网络协议·tcp/ip·http·网络安全·https·udp
游戏开发爱好者82 天前
iOS重构期调试实战:架构升级中的性能与数据保障策略
websocket·网络协议·tcp/ip·http·网络安全·https·udp
却道天凉_好个秋2 天前
音视频学习(三十六):websocket协议总结
websocket·音视频
Python私教2 天前
FastAPI+React19 ERP系统实战 第02期
fastapi
2501_916013742 天前
iOS 多线程导致接口乱序?抓包还原 + 请求调度优化实战
websocket·网络协议·tcp/ip·http·网络安全·https·udp
夏天想2 天前
优化 WebSocket 实现单例连接用于打印【待测试 】
网络·websocket·网络协议
Python私教2 天前
FastAPI+React19 ERP系统实战 第01期
react·fastapi
2501_915921433 天前
Fiddler 中文版怎么配合 Postman 与 Wireshark 做多环境接口调试?
websocket·网络协议·tcp/ip·http·网络安全·https·udp
游戏开发爱好者83 天前
iOS App首次启动请求异常调试:一次冷启动链路抓包与初始化流程修复
websocket·网络协议·tcp/ip·http·网络安全·https·udp
2501_915106323 天前
频繁迭代下完成iOS App应用上架App Store:一次快速交付项目的完整回顾
websocket·网络协议·tcp/ip·http·网络安全·https·udp