一、Uvicorn简介
Uvicorn是一个快速、轻量级的Python ASGI服务器,使用uvloop和httptools实现高性能的HTTP、WebSocket、static file和ASGI应用程序服务。
它采用asynchronous I/O,利用Python 3.6+ 的asyncio库,同时支持http 1.1和http 2协议,这使得与任何现代Web浏览器和Web框架无缝集成。
Uvicorn的特点包括:
1)支持HTTP/1.x和HTTP/2(通过h11库提供H2支持)
2)自动化WebSocket支持(使用websockets)
3)自动Gzip压缩控制
4)静态文件服务
5)工作线程的预先派生(Pre-forking),适用于多核服务器
6)支持异步应用程序,包括托管在asyncio中的Wsgi应用程序(使用AsgiToWsGi)
7)使用uvloop实现了一些对性能的优化
二、安装Uvicorn
在安装Uvicorn之前,先需要安装Python 3.6或更高版本,以及pip工具。
1)使用pip命令安装Uvicorn:
pip install uvicorn
2)检查是否安装成功:
uvicorn --version
三、Uvicorn应用实例
1. HelloWorld 示例
首先我们来看一个最基本的Uvicorn示例:
import uvicorn
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}
if __name__ == "__main__":
uvicorn.run(app, host="0.0.0.0", port=8000)
这个示例创建了一个基于FastAPI框架的应用程序,监听在本地IP地址的8000端口上,访问http://localhost:8000/返回Hello World。
2. 静态文件服务示例
Uvicorn支持静态文件服务,默认情况下在项目根目录下public目录,可以在Uvicorn的运行参数中配置。
import uvicorn
from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles
app = FastAPI()
app.mount("/public", StaticFiles(directory="public"), name="public")
if __name__ == "__main__":
uvicorn.run(app, host="0.0.0.0", port=8000)
启动之后,访问 http://localhost:8000/public/index.html 将返回static文件夹下的index.html文件。
3. WebSocket 示例
Uvicorn还支持WebSocket服务的实现。下面是一个返回当前时间的WebSocket例子:
import asyncio
import uvicorn
from fastapi import FastAPI, WebSocket
app = FastAPI()
@app.websocket("/ws/{websocket_id}")
async def websocket_endpoint(websocket: WebSocket, websocket_id: int):
await websocket.accept()
while True:
await websocket.send_text(f"{websocket_id}: {datetime.utcnow().isoformat()}")
if __name__ == "__main__":
uvicorn.run(
app,
host="0.0.0.0",
port=8000,
ws=True, # 启用 WebSocket
ws_handler=websocket_endpoint) # 设置 WebSocket 事件处理函数
启动之后,可以使用WebSocket客户端连接:ws://localhost:8000/ws/1。
四、总结
Uvicorn是一个快速、轻量级且功能强大的Python ASGI服务器,基于Python 3.6+的asyncio库,同时支持HTTP/1.x和HTTP/2,自动化WebSocket支持和静态文件服务,为Python的Web开发提供了更方便、高效、可扩展的工具。
原创文章,作者:小蓝,如若转载,请注明出处:https://www.506064.com/n/297120.html