flask使用定时任务flask_apscheduler(APScheduler)

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()}")

4.项目整体结构

5.运行效果

具体代码

https://gitee.com/jxzcode_admin/flask-project.git

参考资料

https://blog.youkuaiyun.com/m0_48770520/article/details/130735727

### 如何配置 Flask-APScheduler 的 Cron 触发器 为了在 Flask 应用程序中使用 `flask_apscheduler` 实现基于 Crontab 表达式的定时任务调度,需遵循特定的配置流程。以下是详细的说明: #### 初始化 Scheduler 并启动应用 确保在 Flask 中正确初始化并启动调度器是必要的操作之一。这可以通过调用 `scheduler.init_app(app)` 和 `scheduler.start()` 来完成[^2]。 ```python from flask import Flask from flask_apscheduler import APScheduler app = Flask(__name__) scheduler = APScheduler() # 注册到 Flask app 上下文中 scheduler.init_app(app) # 启动调度器 scheduler.start() ``` #### 定义带有 Cron 触发器的任务 定义一个函数作为要定期执行的任务,并通过装饰器方式将其添加至调度器中。这里展示了一个简单的例子,其中指定了每天上午十点整运行一次该任务[^1]。 ```python @scheduler.task('cron', id='my_job_id', day='*', hour='10', minute='0') def scheduled_task(): print("This task runs every day at 10 AM.") ``` 对于更复杂的场景,比如每周三下午三点四十五分执行某个脚本,则可以调整参数如下所示[^4]: ```python @scheduler.task( 'cron', id='complex_cron_example', week='*', day_of_week='wed', hour='15', minute='45' ) def complex_scheduled_task(): with open('/path/to/logfile.log', 'a') as f: f.write(f'This more specific cron job ran on Wednesday at 3:45 PM.\n') ``` 需要注意的是,在某些情况下可能会遇到时区问题,导致实际执行时间和预期不符。为了避免这种情况发生,建议显式指定本地时间区域名称或 UTC 时间偏移量来解决潜在的时间同步错误[^3]。 例如,如果希望所有计划都按照中国标准时间(CST)来进行计算,可以在创建任务时加入相应的 tz 参数: ```python import pytz cst_tz = pytz.timezone('Asia/Shanghai') @scheduler.task( 'cron', id='timezone_specific_job', day='*', hour='10', minute='0', timezone=cst_tz ) def timezone_sensitive_task(): print("This will execute daily at 10AM CST regardless of server location.") ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值