Python uvicorn 模块：深度解析

Travis Tang

2024-07-25

Python uvicorn 模块深度解析

模块介绍

uvicorn 是一个用于运行 ASGI 应用程序的轻量级、高性能的服务器。它能够处理异步请求，特别适合与 Python 的异步框架（如 FastAPI 和 Starlette）配合使用。uvicorn 基于 asyncio 库，适配 Python 3.6 及以上版本，使得开发者能够构建高并发的网络应用。

应用场景

uvicorn 主要用于开发和部署 ASGI 应用程序，尤其是在高性能要求的场景中。例如，它常被用作快速 API 的后端服务，或者在 WebSocket 服务中，以旋转和接收大量的实时数据流。由于其轻量和高效的特性，uvicorn 适合以下应用方向：

微服务架构中的 API 网关
需要处理大量并发请求的实时聊天应用
使用 FastAPI 构建的高性能 Web 应用

安装说明

uvicorn 并不是 Python 的内置标准库，用户需要通过 pip 来安装。可以使用以下命令进行安装：

1	pip install uvicorn # 通过pip安装uvicorn模块

用法举例

1. 创建一个简单的 ASGI 应用

# 导入所需的模块
from fastapi import FastAPI  # 导入FastAPI框架用于构建应用
import uvicorn  # 导入uvicorn以运行ASGI应用

app = FastAPI()  # 创建一个FastAPI实例

@app.get("/")  # 路由装饰器，处理GET请求
async def read_root():  # 异步函数，响应请求
    return {"Hello": "World"}  # 返回一个简单的JSON

if __name__ == "__main__":  # 确保脚本是直接运行
    uvicorn.run(app, host="127.0.0.1", port=8000)  # 启动uvicorn服务器

以上代码展示了如何使用 uvicorn 与 FastAPI 构建一个简单的 ASGI 应用，并通过 uvicorn 运行它。通过终端访问 http://127.0.0.1:8000/ 时，可以看到返回的 JSON 结果。

2. 支持异步任务的 API

from fastapi import FastAPI
import uvicorn
import time  # 导入time模块用于模拟耗时操作

app = FastAPI()

@app.get("/sleep/{duration}")  # 定义一个带参数的路由
async def sleep_for(duration: int):  # 异步函数处理请求
    time.sleep(duration)  # 模拟一个同步的耗时操作（不推荐）
    return {"message": f"Slept for {duration} seconds"}  # 返回结果

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

在这个例子中，通过提供一个参数，客户端可以指定休眠的秒数。需要注意的是，time.sleep() 会阻塞事件循环，实际开发中应使用 await asyncio.sleep() 来避免这个问题。

3. 处理 WebSocket 连接

from fastapi import FastAPI, WebSocket  # 导入WebSocket支持
import uvicorn

app = FastAPI()

@app.websocket("/ws")  # 定义WebSocket路由
async def websocket_endpoint(websocket: WebSocket):  # 异步处理WebSocket连接
    await websocket.accept()  # 接受WebSocket连接
    while True:  # 持续监听消息
        data = await websocket.receive_text()  # 接收消息
        await websocket.send_text(f"Message text was: {data}")  # 回送消息

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

此示例展示了如何使用 uvicorn 处理 WebSocket 连接，不仅可以接收客户端消息，还能实时响应。在浏览器中结合 WebSocket 客户端可以进行实时通讯。

在开发过程中，通过 uvicorn 这一模块，开发者可以轻松创建高效的 ASGI 应用并实现多种复杂功能。

强烈建议大家关注本人的博客全糖冲击博客，优点是包含所有 Python 标准库使用教程方便查询和学习。在我的博客中，您将会发现丰富的教程，详细的示例和实用的技巧，帮助您更快地掌握 Python 编程。不断更新的内容和清晰易懂的分析，绝对是您学习 Python 的好助手。期待您的关注与支持！

软件和库版本不断更新

由于软件和库版本不断更新，如果本文档不再适用或有误，请留言或联系我进行更新。让我们一起营造良好的学习氛围。感谢您的支持！ - Travis Tang