用Uvicorn 构建和部署高性能的异步 Web服务器@python

Uvicorn介绍

Uvicorn 是一个专为 Python 设计的快速 ASGI(Asynchronous Server Gateway Interface,异步服务器网关接口)服务器,用于构建和部署高性能的异步 Web 服务。以下是关于 Uvicorn 的详细介绍:

一、基本概念

  • ASGI:ASGI 是一种设计用于处理异步请求的接口规范,它允许 Python Web 应用程序与 Web 服务器之间进行高效的异步通信。与传统的 WSGI(Web Server Gateway Interface)相比,ASGI 提供了对 HTTP/2 和 WebSocket 等现代协议的支持,并且能够更好地利用 Python 3.7+ 中引入的 asyncio 和 async/await 特性。

  • Uvicorn:Uvicorn 是基于 ASGI 标准实现的 Web 服务器,它利用 Python 的 asyncio 库来实现非阻塞的网络 I/O,从而能够处理大量的并发连接,提高整体性能。Uvicorn 由 Starlette 框架的作者编写,旨在提供高性能的异步请求处理能力。

  • 二、主要特点

    1. 高性能:Uvicorn 利用了 Python 的 asyncio 库和可选的依赖项(如 uvloop 和 httptools),实现了高效的异步 I/O 操作,能够处理大量的并发请求。

    2. 简洁性:Uvicorn 的设计目标是速度和简洁性,让开发人员可以快速部署高性能的异步 Web 应用。

    3. 灵活性:Uvicorn 支持与各种 ASGI 应用程序框架(如 FastAPI、Starlette、Quart 等)无缝集成,能够轻松构建复杂的异步 Web 应用。

    4. 丰富的配置选项:Uvicorn 提供了丰富的命令行参数和配置文件选项,以满足不同场景下的需求。例如,可以指定主机地址、端口号、工作进程数量、日志级别等。

    5. 安全性:Uvicorn 支持通过 SSL 加密来提供安全的通信,可以保护数据传输的安全性。

    三、使用场景

    Uvicorn 适用于需要高效处理 HTTP 请求和 WebSocket 连接的各种场景,包括但不限于:

  • 实时通信应用:如在线聊天、游戏服务器或股票交易系统,这些应用需要频繁且即时的数据交换。
  • 高并发网站:对于访问量大的网站,Uvicorn 可以通过非阻塞的 I/O 处理大量并发请求,保持系统的响应速度。
  • 微服务架构:作为微服务架构的一部分,提供低延迟、高吞吐量的 API 服务。
  • 四、安装与使用

  • 安装:可以使用 pip 包管理工具来安装 Uvicorn。在命令行中执行 pip install uvicorn 即可完成安装。
  • 使用:安装完成后,可以在命令行中使用 uvicorn 命令来启动 ASGI 应用程序。例如,uvicorn main:app --reload 命令将启动一个名为 main 的 ASGI 应用程序,并监听本地主机的默认端口 8000 上的根路径 / 的 GET 请求。其中,main:app 指定了要运行的 ASGI 应用程序的模块名和对象名,--reload 参数表示在代码修改时自动重新加载应用程序。
  • 五、总结

    Uvicorn 是一个专为 Python 设计的快速 ASGI 服务器,它利用异步 I/O 实现了高效的并发处理能力,并且与各种 ASGI 应用程序框架无缝集成。无论是实时通信应用、高并发网站还是微服务架构,Uvicorn 都能够提供稳定、高效的支持。

    Uvicorn实践

    比如在GPT4Free这个项目里,就使用了UUvicorn

    def run_api(
        host: str = '0.0.0.0',
        port: int = 1337,
        bind: str = None,
        debug: bool = False,
        workers: int = None,
        use_colors: bool = None
    ) -> None:
        print(f'Starting server... [g4f v-{g4f.version.utils.current_version}]' + (" (debug)" if debug else ""))
        if use_colors is None:
            use_colors = debug
        if bind is not None:
            host, port = bind.split(":")
        uvicorn.run(
            f"g4f.api:create_app{'_debug' if debug else ''}",
            host=host, port=int(port),
            workers=workers,
            use_colors=use_colors,
            factory=True,
            reload=debug
        )

    安装

    pip install uvicorn

    使用

    可以这样使用,创建一个main.py文件

    async def app(scope, receive, send):
        assert scope['type'] == 'http'
    
        await send({
            'type': 'http.response.start',
            'status': 200,
            'headers': [
                [b'content-type', b'text/plain'],
            ],
        })
        await send({
            'type': 'http.response.body',
            'body': b'Hello, world!',
        })

    然后在命令行执行

    uvicorn main:app

    即可看到web服务器启动啦!

    python3.11 -m uvicorn main:app
    INFO:     Started server process [80890]
    INFO:     Waiting for application startup.
    INFO:     ASGI 'lifespan' protocol appears unsupported.
    INFO:     Application startup complete.
    INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

    当然也可以在代码中调用uvicorn库来启动web服务:

    import asyncio
    import uvicorn
    
    async def app(scope, receive, send):
        ...
    
    async def main():
        config = uvicorn.Config("main:app", port=5000, log_level="info")
        server = uvicorn.Server(config)
        await server.serve()
    
    if __name__ == "__main__":
        asyncio.run(main())

    启动服务:

    python3.11 uvicornweb.py 
    INFO:     Started server process [80968]
    INFO:     Waiting for application startup.
    INFO:     ASGI 'lifespan' protocol appears unsupported.
    INFO:     Application startup complete.
    INFO:     Uvicorn running on http://127.0.0.1:5000 (Press CTRL+C to quit)
    

    当然,可以在host参数里设置0.0.0.0监听,那样就可以全网web服务了:

    config = uvicorn.Config("main:app", host="0.0.0.0", port=5000,
    log_level="info")

    作者:skywalk8163

    物联沃分享整理
    物联沃-IOTWORD物联网 » 用Uvicorn 构建和部署高性能的异步 Web服务器@python

    发表回复