极客笔记FastAPI 如何触发 FastAPI/Uvicorn 的干净关闭
在本文中，我们将介绍如何触发 FastAPI/Uvicorn 的干净关闭。在开发和部署 FastAPI 应用程序时，我们常常需要确保在关闭应用程序时，所有正在进行的操作都能正确地完成，并且资源能够被正确地释放，以避免潜在的内存泄漏或数据损坏的问题。
阅读更多：FastAPI 教程
什么是 FastAPI 和 Uvicorn
在深入了解如何触发 FastAPI/Uvicorn 的干净关闭之前，我们先简要介绍一下 FastAPI 和 Uvicorn。
FastAPI 是一个基于 Python 的现代、快速（高性能）的 Web 框架，用于构建 Web API。它提供了很多有用的功能和工具，例如异步支持、数据验证、依赖注入等，使得构建高性能的 Web API 变得容易和快速。
Uvicorn 则是一个基于 ASGI（Asynchronous Server Gateway Interface）的 Web 服务器，它可以运行 FastAPI 应用程序。Uvicorn 是一个快速的 Web 服务器，支持异步请求处理，提供了高性能和可伸缩性。
触发 FastAPI/Uvicorn 的干净关闭
为了触发 FastAPI/Uvicorn 的干净关闭，我们可以使用 Python 的信号处理机制来监听系统信号，当接收到特定的系统信号时，执行相应的关闭操作。
首先，我们需要导入 signal 和 sys 模块，以及 FastAPI 和 Uvicorn 的相关模块：
import signal
import sys
from fastapi import FastAPI
from uvicorn import run
接下来，我们可以创建一个 FastAPI 应用程序，并定义一些路由和处理程序，以展示如何触发干净关闭：
app = FastAPI()
@app.get("/")
def read_root():
return {"Hello": "World"}
@app.on_event("shutdown")
def shutdown_event():
# 在此处添加任何需要在关闭时执行的代码
print("Performing clean shutdown...")
在上述代码中，我们定义了一个根路由 /，当我们访问该路由时，返回一个 JSON 响应。我们还定义了一个 shutdown_event 事件，在应用程序关闭时会触发该事件，并执行其中的代码块。
接下来，我们可以创建一个函数来处理系统信号，并在收到特定的系统信号时触发应用程序的关闭：
def handle_shutdown(signum, frame):
sys.exit(0)
if __name__ == "__main__":
signal.signal(signal.SIGINT, handle_shutdown)
signal.signal(signal.SIGTERM, handle_shutdown)
# 运行 FastAPI 应用程序
run(app, host="0.0.0.0", port=8000)
在上述代码中，我们定义了一个 handle_shutdown 函数，用于处理系统信号。我们使用 signal 模块的 signal.signal 函数来注册该函数，并指定要监听的系统信号。在收到特定的系统信号时，该函数会调用 sys.exit(0)，从而触发应用程序的关闭。
当我们运行上述代码时，我们可以通过按下 Ctrl + C 或发送 SIGINT 信号来触发干净关闭。应用程序会接收到系统信号，并执行相应的关闭操作，包括在 shutdown_event 事件中定义的操作代码。
示例说明
让我们通过一个示例来说明如何触发 FastAPI/Uvicorn 的干净关闭。假设我们有一个 FastAPI 应用程序，用于处理用户注册和登录的请求。
首先，我们创建一个名为 main.py 的文件，并编写如下代码：
import signal
import sys
from fastapi import FastAPI
from uvicorn import run
app = FastAPI()
@app.get("/")
def read_root():
return {"Hello": "World"}
@app.on_event("shutdown")
def shutdown_event():
# 模拟关闭时需要处理的操作
print("Performing clean shutdown...")
print("Closing database connection...")
print("Releasing resources...")
def handle_shutdown(signum, frame):
sys.exit(0)
if __name__ == "__main__":
signal.signal(signal.SIGINT, handle_shutdown)
signal.signal(signal.SIGTERM, handle_shutdown)
run(app, host="0.0.0.0", port=8000)
在这个示例中，我们创建了一个根路由 /，并定义了一个 shutdown_event 事件，在关闭应用程序时会执行其中的操作。这些操作可以包括关闭数据库连接、释放资源等。
然后，我们可以使用以下命令来运行该应用程序：
uvicorn main:app --reload
现在，我们可以在浏览器中访问 http://localhost:8000，应该能够看到一个返回 “Hello World” 的 JSON 响应。
接下来，我们通过按下 Ctrl + C 或发送 SIGINT 信号来关闭应用程序。此时，应用程序将接收到系统信号，并执行我们在 shutdown_event 事件中定义的操作代码。
Performing clean shutdown...
Closing database connection...
Releasing resources...
如上所示，应用程序成功地进行了干净的关闭，并执行了相应的操作。
总结
通过使用 Python 的信号处理机制，我们可以很容易地触发 FastAPI/Uvicorn 的干净关闭，并确保在关闭应用程序时，所有的操作都能正确地完成。在本文中，我们介绍了如何监听系统信号，并在收到特定的系统信号时执行关闭操作的示例代码。在实际的开发和部署过程中，我们可以根据具体的需求，在 shutdown_event 事件中添加自己的操作代码，来完成一些特定的清理操作。