flask使用定时任务flask_apscheduler(APScheduler)

news2025/10/31 9:18:12

Flask-APScheduler描述:

Flask-APScheduler 是一个 Flask 扩展，增加了对 APScheduler 的支持。

APScheduler 有三个内置的调度系统可供您使用：

Cron 式调度（可选开始/结束时间）
基于间隔的执行（以偶数间隔运行作业，可选开始/结束时间）
一次性延迟执行（在设定的日期/时间运行一次作业）

1.安装 flask_apscheduler 库

pip install flask_apscheduler

2.app.py中的代码

2.1初始化APScheduler

# 创建Flask应用
app = Flask(__name__)
# 初始化APScheduler
scheduler = APScheduler()

2.2使用方式

描述这里使用cron表达式

cron表达式生成器地址：https://cron.ciding.cc/

方式一: 硬编码方式使用

# 创建Flask应用
app = Flask(__name__)
# 初始化APScheduler
scheduler = APScheduler()

# 方式一硬编码；
# 这些代码也可以放在if __name__ == '__main__':内,与调试运行方式有关，
# 1.flask服务方式运行不会走if __name__ == '__main__':内代码;
# 2.以Python文件(app.py)方式运行会走if __name__ == '__main__':内代码;
scheduler.add_job(func=MyService.my_job, id='my_job', trigger='cron', second='0/5')
scheduler.init_app(app=app)
scheduler.start()

方式二: 读取配置方式使用

配置中代码

class Config:
    JOBS = [
        {
            'id': 'job1',
            'func': 'app:MyService.my_job',  # 注意这里的格式，app 是 Flask 应用对象的名称(app.py)，: 后面是任务函数名
            'trigger': 'cron',
            # 'day_of_week': '0-6',  # 每天执行
            # 'hour': 18,  # 18 点执行
            # 'inute': 30,  # 30 分执行
            # 'econd': 5  # 0 秒执行
            'second': '0/5'
        }
        # ,
        # {
        #     'id': 'job2',
        #     'func': task2,  # 也可以直接使用函数名
        #     'trigger': 'interval',
        #     'econds': 30  # 每隔 30 秒执行一次
        # }
    ]
    SCHEDULER_API_ENABLED = True

# 创建Flask应用
app = Flask(__name__)
# 初始化APScheduler
scheduler = APScheduler()

# 方式一硬编码
# scheduler.add_job(func=MyService.my_job, id='my_job', trigger='cron', second='0/5')
# 方式二读取配置
app.config.from_object(Config())
scheduler.init_app(app=app)
scheduler.start()

3.my_service.py中(MyService类)代码

from datetime import datetime

from flask import Flask


class MyService:
    @classmethod
    def my_job(cls):
        print(f"my_job,当前时间{datetime.now()}")