Python Uvicorn用法介绍

简介

Uvicorn是一个基于ASGI（Asynchronous Server Gateway Interface）标准的高性能Web服务器，旨在提供对Python Web应用程序的高效和快速的支持。它使用uvloop和httptools这两个高性能库来加速网络IO操作，使得Python应用程序能够处理更多的并发请求。

本文将详细介绍Uvicorn的安装和使用方法，并通过示例代码演示其基本功能。

安装

Uvicorn可以通过Python的包管理工具pip进行安装。在命令行中执行以下命令即可安装Uvicorn：

pip install uvicorn

安装完成后，即可在Python脚本中引入Uvicorn并使用其提供的功能。

使用方法

启动Web应用程序

要使用Uvicorn启动一个Python Web应用程序，只需执行以下命令：

uvicorn myapp:app

其中，myapp:app表示要启动的Python模块和应用程序对象，myapp是模块名，app是在模块中定义的ASGI应用程序对象。启动成功后，Uvicorn将监听默认的本地主机（localhost）和8000端口上的HTTP请求。

指定主机和端口

如果希望监听不同的主机和端口，可以使用--host和--port参数来指定。例如，以下命令将Uvicorn的监听主机地址设置为0.0.0.0，端口设置为8080：

uvicorn myapp:app --host 0.0.0.0 --port 8080

这样，Uvicorn将监听所有接口上的HTTP请求，并将其转发到指定的应用程序对象。

多进程运行

默认情况下，Uvicorn运行在单进程模式下，但可以通过--workers参数指定运行的进程数量。例如，以下命令将使用4个进程来处理并发请求：

uvicorn myapp:app --workers 4

这样，Uvicorn将使用4个子进程来处理并发请求，提高了Web应用程序的性能和处理能力。

自动加载代码

在开发调试过程中，经常需要对代码进行修改并重新加载。Uvicorn提供了一个--reload参数，用于自动监测代码变化并重新加载应用程序。例如：

uvicorn myapp:app --reload

启用此参数后，当代码被更改并保存时，Uvicorn将自动检测到变化并重新加载应用程序，无需手动重启服务器。

HTTPS支持

Uvicorn还支持通过--ssl-keyfile和--ssl-certfile参数启用HTTPS支持。例如，以下命令将Uvicorn配置为使用SSL证书对传输进行加密：

uvicorn myapp:app --ssl-keyfile key.pem --ssl-certfile cert.pem

这样，Uvicorn将监听HTTPS（加密）协议上的请求，并使用指定的密钥和证书进行加密和解密操作。

示例代码

下面是一个简单的示例代码，展示了如何使用Uvicorn启动一个基本的Web应用程序：

from fastapi import FastAPI

app = FastAPI()

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

@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

保存以上代码为main.py文件，然后执行以下命令启动Uvicorn服务器：