Fastapi之APScheduler

配置 APScheduler:

from fastapi import FastAPI
from apscheduler.schedulers.background import BackgroundScheduler
from apscheduler.executors.pool import ThreadPoolExecutor, ProcessPoolExecutor
import time
import logging

logging.basicConfig(level=logging.INFO)

app = FastAPI(routes=None)

# 配置 APScheduler
scheduler = BackgroundScheduler({
    'apscheduler.executors.default': ThreadPoolExecutor(20),
    'apscheduler.executors.processpool': ProcessPoolExecutor(5),
    'apscheduler.job_defaults.coalesce': False,
    'apscheduler.job_defaults.max_instances': 3,
    'apscheduler.timezone': 'Asia/Shanghai',
})

下面是对每个参数的详细解释:

配置参数详解

apscheduler.executors.default

  • 含义:定义默认的执行器。执行器负责实际执行任务。
  • ThreadPoolExecutor(20),表示使用一个线程池执行器,
### 如何在 FastAPI 中使用 APScheduler 实现定时任务调度 #### 安装依赖库 为了使 FastAPI 能够与 APScheduler 配合工作,需安装必要的 Python 库。可以通过 pip 来完成这些包的安装。 ```bash pip install fastapi uvicorn apscheduler ``` #### 初始化 FastAPIAPScheduler 创建一个新的 FastAPI 应用实例并初始化 APScheduler 的调度器对象,在应用启动时开启调度服务[^1]。 ```python from fastapi import FastAPI from apscheduler.schedulers.background import BackgroundScheduler import atexit app = FastAPI() # 创建后台调度器 scheduler = BackgroundScheduler() scheduler.start() # 注册退出事件来优雅关闭调度器 atexit.register(lambda: scheduler.shutdown()) ``` #### 添加定时任务函数 定义希望定期执行的任务逻辑,并将其注册到调度器中。这里展示了一个简单的例子,该任务每五秒打印一次消息至控制台。 ```python def my_scheduled_task(): print("This task runs every five seconds.") # 使用 date, interval 或 cron 类型触发器添加作业 scheduler.add_job(my_scheduled_task, 'interval', seconds=5) ``` #### 结合路径操作集成进 API 接口 如果想要通过 HTTP 请求触发展示当前已安排的所有任务列表,则可以像下面这样编写路由处理程序: ```python @app.get("/jobs/") async def read_jobs(): jobs = [{"id": job.id, "name": str(job)} for job in scheduler.get_jobs()] return {"jobs": jobs} ``` 以上就是如何在 FastAPI 中使用 APScheduler 进行基本的定时任务设置的方法介绍。此方法允许开发者轻松地将计划好的后台进程加入到基于 FastAPI 构建的服务当中去[^2]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值