FastAPI 如何在FastAPI中在关闭时停止循环

在本文中，我们将介绍如何在FastAPI应用程序中实现在应用关闭时停止循环的功能。

FastAPI简介

FastAPI是一个高性能的现代Web框架，它基于Python 3.7+的asyncio和type hints技术，兼具快速和易用性。它提供了一个简单而强大的接口，可以使开发人员能够快速构建高性能的Web应用程序。

停止循环的需求

在某些情况下，我们可能需要在应用程序关闭时停止正在进行的循环任务，以确保资源的正确释放和数据的保存。例如，我们可能有一个后台任务，定期从数据库中读取数据，并进行某些处理。当我们要关闭应用程序时，我们需要停止这个后台任务，以免数据丢失或资源泄漏。

解决方案

FastAPI提供了一个名为on_event的装饰器，用于定义应用程序启动和关闭时执行的操作。我们可以使用on_event装饰器来注册一个函数，以在应用程序关闭时执行我们的停止循环逻辑。

首先，让我们定义一个可以启动和停止的循环任务：

import asyncio

async def my_background_task():
    while True:
        print("Running background task...")
        await asyncio.sleep(1)

bg_task = asyncio.create_task(my_background_task())

在上面的示例中，我们创建了一个名为my_background_task的循环任务，它每秒钟输出一条消息。asyncio.create_task()函数用于在后台开始这个任务。

然后，我们使用on_event装饰器来注册一个函数，在应用程序关闭时停止循环任务：

from fastapi import FastAPI
from fastapi import FastAPI, HTTPException, status
from fastapi import Request
from fastapi import BackgroundTasks
from fastapi.responses import HTMLResponse

app = FastAPI()

@app.on_event("shutdown")
async def stop_background_task():
    bg_task.cancel()
    await bg_task

在上面的示例中，我们使用on_event装饰器将stop_background_task函数注册为应用程序关闭时执行的操作。在此函数中，我们使用bg_task.cancel()来停止循环任务，并使用await bg_task来等待任务的完成。

现在，当我们关闭FastAPI应用程序时，循环任务将会被正确地停止。

完整示例

下面是一个完整的示例，演示了如何在FastAPI应用程序中停止循环任务：

import asyncio
from fastapi import FastAPI

app = FastAPI()

async def my_background_task():
    while True:
        print("Running background task...")
        await asyncio.sleep(1)

bg_task = asyncio.create_task(my_background_task())

@app.on_event("shutdown")
async def stop_background_task():
    bg_task.cancel()
    await bg_task

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

在上面的示例中，我们定义了一个名为my_background_task的循环任务，并使用asyncio.create_task()来在后台执行这个任务。然后，我们使用app.on_event("shutdown")装饰器将stop_background_task函数注册为关闭应用程序时执行的操作。