资讯

历史

科技

环境与自然

成长

游戏

财经

文学与艺术

美食

健康

家居

文化

情感

汽车

三农

军事

旅行

运动

教育

生活

星座命理

Uvicorn：安装、部署与开发详解

创作时间:

作者:

@小白创作中心

Uvicorn：安装、部署与开发详解

引用

CSDN

https://blog.csdn.net/lzyzuixin/article/details/139688632

Uvicorn是一个高性能的异步Web服务器框架，专为异步Python Web应用设计，如基于FastAPI、Starlette等框架构建的应用。它使用asyncio库实现异步I/O操作，支持HTTP和WebSocket协议，能够与各种ASGI应用程序框架配合使用。本文将详细介绍Uvicorn的安装、部署及开发方法，帮助读者快速上手并构建高效的异步Web服务。

一、Uvicorn 简介

Uvicorn是一个基于asyncio开发的高性能Web服务器框架，旨在实现两个主要目标：

使用uvloop和httptools实现一个极速的asyncio服务器。
实现一个基于ASGI（异步服务器网关接口）的最小应用程序接口。

Uvicorn目前支持HTTP、WebSockets和Pub/Sub广播，并且可以扩展到其他协议和消息类型。它基于uvloop和asyncio实现，提供了极高的性能，适用于处理大量并发请求和高吞吐量的场景。

二、Uvicorn 安装

Uvicorn的安装非常简单，可以通过Python的包管理工具pip来完成。在命令行中运行以下命令即可完成安装：

pip install uvicorn

如果需要使用uvloop来进一步提升性能，可以安装uvloop的额外依赖：

pip install uvicorn[standard]

这将自动包含uvloop和httptools的依赖，使Uvicorn能够发挥最佳性能。

三、Uvicorn 基本使用

安装完成后，就可以开始使用Uvicorn了。Uvicorn可以作为命令行工具直接运行ASGI应用，也可以作为Python模块导入并在代码中使用。

1. 命令行运行

假设你有一个名为main.py的文件，其中包含一个ASGI应用实例，可以使用以下命令启动服务器：

uvicorn main:app --reload

这里main是Python模块名，app是模块中ASGI应用实例的变量名。--reload参数表示在开发模式下启用自动重载功能，当代码发生变化时服务器会自动重启。

2. Python代码中使用

你也可以在Python代码中直接导入并使用Uvicorn：

import uvicorn
from myapp import app

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

这样就可以在代码中灵活地控制服务器的启动和配置。

四、Uvicorn 部署方法

在生产环境中部署Uvicorn时，通常需要结合其他工具来实现更强大的功能和更高的稳定性。以下是几种常见的部署方法：

1. 手动启动服务器

在开发或测试环境中，可以直接使用命令行启动Uvicorn服务器：

uvicorn main:app --host 0.0.0.0 --port 8000

2. 使用 Gunicorn 和 Uvicorn

Gunicorn是一个Python WSGI HTTP服务器，可以与Uvicorn结合使用，提供更强大的负载均衡和进程管理功能。首先需要安装Gunicorn：

pip install gunicorn

然后可以使用以下命令启动：

gunicorn -k uvicorn.workers.UvicornWorker main:app

这里-k uvicorn.workers.UvicornWorker指定了使用Uvicorn的工作进程。

3. 使用 Docker 容器

Docker是一种容器化技术，可以将应用及其运行环境打包成一个独立的容器，便于部署和管理。首先需要创建一个Dockerfile：

FROM python:3.9-slim

WORKDIR /app

COPY requirements.txt .
RUN pip install -r requirements.txt

COPY . .

CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]

然后构建并运行Docker容器：

docker build -t myapp .
docker run -p 8000:8000 myapp

4. 虚拟环境运行

在生产环境中，建议使用虚拟环境来隔离应用的依赖。可以使用Python的venv模块创建虚拟环境：

python3 -m venv venv
source venv/bin/activate
pip install uvicorn

然后在虚拟环境中运行Uvicorn服务器。

五、Uvicorn 开发方法

Uvicorn不仅是一个服务器，也是一个强大的开发工具。以下是一些常用的开发方法：

1. 异步 API 服务

Uvicorn支持异步API服务，可以与FastAPI等异步框架完美配合。以下是一个使用FastAPI的简单示例：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def read_root():
    return {"message": "Hello World"}

然后使用Uvicorn运行：

uvicorn main:app --reload

2. 使用中间件

Uvicorn支持ASGI中间件，可以在请求处理的不同阶段插入自定义逻辑。以下是一个简单的中间件示例：

from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import Response

class SimpleMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        response = await call_next(request)
        response.headers["X-Process-Time"] = "100ms"
        return response

然后在应用中使用：

from fastapi import FastAPI
from starlette.middleware.base import BaseHTTPMiddleware

app = FastAPI()
app.add_middleware(SimpleMiddleware)

3. 处理 WebSocket 连接

Uvicorn支持WebSocket协议，可以轻松构建实时通信应用。以下是一个WebSocket示例：

from fastapi import FastAPI
from fastapi.websockets import WebSocket

app = FastAPI()

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    while True:
        data = await websocket.receive_text()
        await websocket.send_text(f"Message text was: {data}")

然后使用Uvicorn运行：