《基于FastAPI与APScheduler的API调度任务实践》

随心￥

于 2025-03-10 11:26:45 发布

阅读量1k

点赞数 19

文章标签： fastapi python

本文链接：https://blog.csdn.net/m0_74638616/article/details/146148530

版权

在现代Web开发中，API调度任务是一种常见的需求，它允许开发者根据特定的时间间隔或条件来自动触发某些操作。FastAPI作为一款现代且高效的Python Web框架，结合功能强大的任务调度库APScheduler，能够方便地实现灵活的API调度任务。

一、FastAPI简介

FastAPI是一个基于标准Python类型提示的高性能Web框架，它结合了Python 3.6+的类型注解和异步编程能力，提供了快速、简洁且可扩展的API开发体验。与传统的Web框架相比，FastAPI具有更高的性能和更低的内存占用，适用于构建各种类型的Web应用程序。

二、APScheduler简介

APScheduler是一个灵活的Python库，用于在Python应用程序中调度任务。它支持多种调度方式，如定时调度、间隔调度、日期调度等，并且可以持久化任务到不同的后端存储，如内存、SQLAlchemy、Redis等。APScheduler提供了丰富的功能和简单的API，使得任务调度变得非常容易。

三、环境搭建与依赖安装

（一）创建项目

首先，创建一个新的Python项目目录，并在其中初始化一个虚拟环境，以隔离项目依赖。然后，在项目目录下创建一个主文件，如main.py。

（二）安装依赖

使用pip命令安装FastAPI和APScheduler等相关依赖库。确保安装的库版本与Python版本兼容，以避免出现兼容性问题。

四、创建基本的FastAPI应用

在main.py文件中，导入FastAPI的相关模块，创建一个FastAPI实例。定义一个简单的根路由，返回一个欢迎消息，以验证FastAPI应用是否正常运行。例如：

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
async def read_root():
    return {"message": "Hello, FastAPI with APScheduler!"}

五、集成APScheduler

（一）初始化调度器

创建一个调度器实例，并配置相关的参数，如任务存储方式、时间区域等。可以选择将任务存储在内存中，也可以选择持久化到数据库中，根据实际需求进行配置。

from apscheduler.schedulers.background import BackgroundScheduler
from datetime import datetime

scheduler = BackgroundScheduler(timezone="Asia/Shanghai")
scheduler.start()

（二）定义任务函数

定义一个需要定时执行的任务函数。例如，一个简单的打印当前时间的任务函数可以如下编写：

def print_current_time():
    print("Current time:", datetime.now())

（三）添加任务到调度器

使用调度器的add_job方法将任务添加到调度器中，并设置任务的触发规则和间隔时间等参数。例如，每隔5秒执行一次print_current_time任务：

scheduler.add_job(print_current_time, 'interval', seconds=5)

六、创建API控制任务调度

（一）定义任务列表和操作接口

创建一个任务列表，用于存储和管理所有的调度任务。然后，定义一组API接口，用于实现对任务的添加、删除、修改和查询等操作。例如：

from fastapi import APIRouter, HTTPException
from typing import List, Dict

router = APIRouter()
tasks: List[Dict] = []

@router.post("/tasks")
async def add_task(task: Dict):
    tasks.append(task)
    return {"message": "Task added successfully."}

@router.delete("/tasks/{task_id}")
async def delete_task(task_id: int):
    global tasks
    tasks = [t for t in tasks if t["id"] != task_id]
    return {"message": "Task deleted successfully."}

（二）关联API与任务调度

当通过API添加一个新任务时，根据任务的配置信息动态地将任务添加到APScheduler调度器中。同样，当删除或修改任务时，同步更新调度器中的任务状态。例如：

@router.put("/tasks/{task_id}")
async def update_task(task_id: int, updates: Dict):
    global tasks
    for task in tasks:
        if task["id"] == task_id:
            task.update(updates)
            # 这里可以根据更新后的任务信息重新调整调度器中的任务参数
            return {"message": "Task updated successfully."}
    raise HTTPException(status_code=404, detail="Task not found")