FastAPI生产部署指南：使用Gunicorn优化FastAPI性能-原创手记-慕课网

精通FastAPI部署的技巧：生产环境下的性能、安全性和可扩展性的最佳实践方法。

照片由 Trinity Nguyen 在 Unsplash 提供

介绍

当目标是在生产环境中运行一个FastAPI应用程序时，需要考虑一些基本方面。根据官方文档的建议，最佳实践之一是使用容器来使API的部署和扩展更简便。比如Docker提供的容器，确保应用程序的依赖和运行环境标准化，从而使“生产化”过程更加顺畅。

除了使用容器外，优化性能的其他关键因素还包括特定的Gunicorn配置选项，例如设置工作进程的数量和选择进程管理模型。接下来我们将深入探讨这些及其他相关方面，来提高FastAPI在生产环境中的性能。

使用容器来

在生产环境中使用 FastAPI 部署 API 通常会涉及使用 Docker 容器，这是一种常见的做法，将应用程序及其依赖项隔离，与系统上的其他容器和服务保持独立。这不仅简化了依赖管理，还确保应用程序环境在不同部署中的一致性。

此外，容器相比虚拟机具有显著更低的资源消耗，因为它们通常只运行一个独立的进程。这种减少的开销对API来说特别有利，因为它有利于保障安全性、网络设置、开发和部署。容器的使用引入了容器镜像的概念，容器镜像是可以用来启动容器的现成模板。这些镜像包含了所需文件、库和配置的具体版本，确保应用程序行为的一致性和可预测性。简而言之，容器镜像是一个模板，在执行时生成一个包含运行应用程序所需指令的容器，从而实现应用程序的独立运行。

容器会保持活动状态，只要主命令或配置的过程还在运行——这正是基于FastAPI的API所期望的行为结果。然而，如果没有活动进程在运行，容器将会被自动终止。容器就会被自动终止。

这里是 FastAPI 应用程序的简单 Dockerfile 示例：

    FROM python:3.9  

    设置工作目录 /code  

    将 ./requirements.txt 复制到 /code/requirements.txt  

    运行 pip install --no-cache-dir --upgrade -r /code/requirements.txt  

    将 ./app 复制到 /code/app  

    运行命令 ["fastapi", "run", "app/main.py", "--port", "80"]

此文件通常命名为 Dockerfile，构建镜像时，只需执行以下命令即可。

    docker build -t api-image .

在当前目录下构建名为 api-image 的 Docker 镜像。

运行容器的命令是。

运行以下命令来启动容器："试试这个命令来启动你的容器吧："
docker run -d --name mycontainer -p 80:80 api-image

运行docker容器启动名为mycontainer的实例，并将容器的80端口映射到主机的80端口。

这个过程运作得非常好，只要满足一些前提条件，比如：

正确地组织目录和文件结构（参见：FastAPI Docker — 目录结构）；
一个正确列出应用依赖项的 requirements.txt 文件（详情请参见：FastAPI Docker — 包要求）；
main.py 文件中的代码没有问题（请参阅文档：FastAPI Docker — 创建 FastAPI 代码）。

在理解了容器的创建和使用之后，了解其他因素也非常重要，这些因素可以优化生产环境中API的使用。以下我们将详细阐述一些重要的方面，包括但不限于，比如：

HTTPS；
启动配置设置；
自动恢复；
数据复制；
内存优化。

HTTPS协议

当讨论HTTP和HTTPS协议时，重要的是要强调HTTPS提供了更高的安全级别，因为它使用加密来保护客户端和服务器间的数据传输。这对于API尤其重要，尤其是在它们与外部应用程序交互时，保护敏感数据变得尤为关键。这一点尤为重要，尤其是在它们与外部应用程序互动时。

在官方的 FastAPI 文档中，建议尽可能地使用 HTTPS，尤其是在生产部署时。许多主机提供商提供了免费的 SSL 证书，这让配置 HTTPS 连接变得更加简单。

此外，如果您的应用程序位于代理或负载均衡器后面，需要在FastAPI应用启动命令中添加相应的参数。为了确保代理发送给应用的HTTP头正确地转发到应用程序，您需要在命令中加入--proxy-headers参数。这确保FastAPI应用在代理场景中能够正确处理原始客户端（如IP地址）的信息。

这里有一个更新后的Dockerfile示例，其中包括了--proxy-headers参数。

    FROM python:3.9  

    WORKDIR /code  

    COPY ./requirements.txt /code/requirements.txt  

    RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt  

    COPY ./app /code/app  

    CMD ["fastapi", "run", "app/main.py", "--proxy-headers", "--port", "80"]

这个设置允许您的FastAPI应用程序在代理后正常运行，同时确保传输数据的安全性和完整性。

启动应用:

有几种方法可以使用 FastAPI 启动容器，从使用 Docker 到更高级的解决方案如 Kubernetes。选择合适的工具取决于 API 的复杂程度、可用的基础设施以及项目的规模。最常用的方法包括：

Docker : 一个简单又高效的解决方案，适用于本地开发和不太复杂的部署。它非常适合在隔离环境中测试和运行应用程序，所有依赖项都已预先配置好。
Docker Compose : 在多个容器需要协同工作的场合特别有用，例如当一个API依赖于数据库或其他服务时。
Kubernetes : 一个非常强大的工具，适用于大规模部署和管理容器。它提供了高可用性、可扩展性和自动负载均衡，非常适合处理大规模API和分布式系统。

在选择这些选项时应考虑项目的规模、对可扩展性的需求以及部署过程中的自动化程度需求。

重启

在生产环境中，确保FastAPI应用能够从意外故障中恢复正常运行是非常重要的。一个常见的做法是配置自动重启，以防止应用程序在错误发生后不可用。这可以通过Docker和Kubernetes提供的功能来完成。

在 API 开发中，处理已知错误时，可以这样写：在代码中直接处理这些错误，并返回合适的状态码，例如对于无效输入返回 422 (无法解析的实体)。比如说，如果用户输入的是布尔值而不是数字，代码可以返回这个状态码而不会让程序崩溃。

然而，有些错误可能是难以预料的。在这种情况下，建议使用自动重启机制，而不是让应用程序变得完全不可用。在 Docker 中，这可以通过设置 --restart 选项实现，该选项会在容器失败时自动重启。

下面是一个更新后的Dockerfile文件示例，其中包含了重启设置：

# 从Python 3.9镜像开始
FROM python:3.9  

# 设置工作目录为/code
WORKDIR /code  

# 复制requirements.txt到容器内的/code目录
COPY ./requirements.txt /code/requirements.txt  

# 安装所需的Python包
RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt  

# 复制应用代码到容器内的/code/app目录
COPY ./app /code/app  

# 启动FastAPI应用
CMD ["fastapi", "run", "app/main.py", "--proxy-headers", "--port", "80", "--restart"]

你可以在 docker-compose.yml 文件里直接添加重启设置：

# 这是一个Docker Compose配置文件，定义了应用服务的版本、镜像、重启策略和端口映射。
version: '3'
services:
  app:  # 应用服务
    image: api-image
    restart: always
    ports:
      - "80:80"

这确保在遇到意外故障时，应用程序会自动重启，从而将对生产的影响降到最低，以减少影响。

复制

在生产环境中，优化API性能的必要性是出于提高复制能力和扩展性的需求之一。在开发环境中，一般不需要在多个进程中分发请求，但在生产环境中，这种做法是确保应用程序在高用户负载下依然高效能所必需的。

进程复制（也称为使用多个工作者），是 FastAPI 文档推荐的一种处理大量请求的方法。当 API 在多核 CPU 上运行，或者单个进程无法处理高流量时，可以使用多个进程（即‘工作者’）来分担负载。这可以同时处理多个请求，从而提高效率，减少响应时间。

这种方法涉及到运行多个相同API的实例，所有实例在同一端口上监听请求，并自行分配工作。FastAPI 和其他工具如 Uvicorn 和 Gunicorn 使得配置这些多个工作实例变得简单，从而提供更大的弹性和可扩展性。

Uvicorn 和 Gunicorn 比较

Uvicorn 和 Gunicorn 都常用于运行 FastAPI 的 API，但它们在进程管理方面存在差异：

Uvicorn 是一个轻便且高效的 ASGI 服务器，适合简单的小规模场景。
Gunicorn 则是一个更强大的 WSGI 服务器，能够更高效地管理多个工作进程，尤其适合大规模生产环境中的使用。它还提供了更好的工作进程控制和自动恢复等功能，更适合高可用性需求。

然而，为了充分利用两者的优势，通常会将 Gunicorn 与 Uvicorn 结合使用（通过「uvicorn.workers.UvicornWorker」），这将带来一个功能更强大、对进程控制更精细，更灵活的服务器，更适合复杂的生产场景。

使用Uvicorn的例子:

以下是使用 Uvicorn 运行多个工人的配置示例：

    FROM python:3.9  

    WORKDIR /code  

    COPY ./requirements.txt /code/requirements.txt  

    RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt  

    COPY ./app /code/app  

    CMD ["uvicorn", "app.main:app", "--proxy-headers", "--port", "80", "--workers", "4", "--restart"]

这个示例使用4个工人来并行处理请求，从而提高了API处理多并发连接的能力。

使用Gunicorn的例子

如果应用程序需要更多的控制和弹性支持，使用 Gunicorn 和 Uvicorn 的组合是一个更为稳健的选择。下面是一个使用 Gunicorn 并配置了 4 个 worker 的 Dockerfile 示例：

    FROM 指令 python:3.9  

    WORKDIR 指令 /code  

    COPY 指令 ./requirements.txt /code/requirements.txt  

    RUN 指令 pip install --no-cache-dir --upgrade -r /code/requirements.txt  

    COPY 指令 ./app /code/app  

    CMD 指令 ["gunicorn", "-k", "uvicorn.workers.UvicornWorker", "app.main:app", "--workers", "4", "--bind", "0.0.0.0:80"]

此配置利用了 Uvicorn 的高效性，但使用了 Gunicorn 的进程管理来保持健壮性，确保在生产环境中有更高的可用性和性能。

回忆

在将API优化用于生产环境时，内存管理是需要特别注意的关键点，尤其是在涉及多个工作线程时。与其他优化不同，例如进程调整或代理设置，内存管理很大程度上依赖于对应用程序具体需求的细致分析。

每个运行你应用程序的 worker 进程都会消耗一定量的内存，这包括执行时的变量、机器学习模型（如果使用的话）、缓存和其他必要的数据。当存在多个 worker 时，重要的是要知道每个 worker 会消耗自己的内存份额，并且它们之间不会共享内存。这意味着总的内存消耗就是所有 worker 内存消耗的总和。

在配置多个工作者时，关键的一点是确保服务器或实例有足够的RAM来支持每个工作者的负载。例如，如果你的实例有10 GB的RAM，并且每个工作者大约消耗2 GB，那么启动6个工作者会导致超出内存限制，这可能导致严重问题，比如崩溃或系统变慢。

下面从视觉上展示这种情况：

在图像中，我们可以看到进程管理器是如何分配CPU使用时间给各个工作者，以及每个工作者又是如何分配一定量的内存的。这个模型清楚地展示了每个工作者都有自己的一份内存拷贝，这进一步突显了合理规划的重要性，以防止资源耗尽。

最后的思考

在这篇文章中，我们探讨了在生产环境中优化和部署FastAPI应用的最佳实践。我们涵盖了关键方面，如容器化、复制部署、内存使用和管理以及安全协议，并探讨了如何在不同生产环境下的不同生产场景中使用Gunicorn和Uvicorn。

有了这份详细的概述，你现在可以更好地根据项目的需要调整API配置。工作进程数、连接超时时间和线程使用等只是Gunicorn中可用的众多变量中的几个例子，可用于提升性能。每个调整都会直接影响到应用程序的扩展性和运行效率。

另外，还需要考虑FastAPI是否真的是你应用场景的最佳选择。虽然它非常适合于高性能API，并且易于实现，但诸如Django、Flask和Bottle这样的其他框架也提供了不同的优势，特别是在可扩展性、库集成和易用性方面。根据你的项目情况评估这些方面可以帮助你找到最适合的解决方案。

最后，请记住把 API 部署到生产环境不只是写优化的代码。使用 HTTPS 提供的安全保障、高效的内存管理和稳健的容器设置是确保成功的关键因素之一。接下来就应用这些配置，在您的环境中测试，并根据需要调整，始终力求达到应用的最大性能、稳定性和可用性。