使用flask-apscheduler控制定时任务

清风徐来

一个CURD程序员只能在适当的时候不CURD...

简介

有时候我们可能需要在我们的应用中开启定时任务，比如在每天的某个时间定时在数据库中新增一条数据，再或者每间隔几秒启动一个定时任务。如果你的服务部署在Linux服务器中，那么你也可以使用cron来进行定时任务配置，但是这样的话，如果服务迁移那就不能保证整个系统的统一性了，需要重新做一些配置。我们可以使用APScheduler这个Python第三方库实现定时任务。

Flask-APScheduler介绍

Flask-APScheduler是基于APScheduler库开发的Flask拓展库。APScheduler的全称是Advanced Python Scheduler。允许您将Python代码安排为稍后执行，可以只执行一次，也可以定期执行。您可以随时添加新作业或删除旧作业。如果您将作业存储在数据库中，那么调度程序重启后它们也将存活下来并保持其状态。当调度器重新启动时，它将运行它在离线时应该运行的所有作业， APScheduler文档。

社区的强大性，让我们在使用flask的时候可以很方便的调用APScheduler库，我们可以通过flask-apscheduler来调用APScheduler库。进入你的pyhton虚拟环境，安装flask-apscheduler库

pip install flask-apscheduler

顺利的话，我们可以使用这个第三方库了。

使用flask配置启动定时任务

APSchedule可以使用很多方式进行启动任务，比如interval，或者cron等等，下面就分别介绍一下这两种方式启动任务。

interval间隔时间执行

我们可以通过配置如下参数来每间隔多少时间来启动任务

JOBS = [
            'id': 'job1',
            'func': 'scheduler:task',
            'args': (1, 2),
            'trigger': 'interval',
            'seconds': 10
    ]

其中 func 表示你要启动的函数， trigger 表示触发方式，这里使用的 interval 表示间隔触发， second 表示间隔的时间长短。

我们可以通过flask配置启动定时任务，栗子如下

"""
# coding:utf-8
@Time    : 2020/11/19
@Author  : jiangwei
@File    : scheduler.py
@Software: PyCharm
from flask import Flask
import datetime
from flask_apscheduler import APScheduler
aps = APScheduler()
class Config(object):
    JOBS = [
            'id': 'job1',
            'func': 'scheduler:task',
            'args': (1, 2),
            'trigger': 'interval',
            'seconds': 10
    SCHEDULER_API_ENABLED = True
def task(a, b):
    print(str(datetime.datetime.now()) + ' execute task ' + '{}+{}={}'.format(a, b, a + b))
if __name__ == '__main__':
    app = Flask(__name__)
    app.config.from_object(Config())
    scheduler = APScheduler()
    scheduler.init_app(app)
    scheduler.start()
    app.run(port=8000)

上述代码中， 通过APScheduler每间隔10秒钟执行一次task函数。

输出结果如下图，我们可以看到每隔10s中执行了一次函数。

上面的例子中，将需要执行的函数定义在该文件内部，如果我们的函数定义在其他文件中，可以通过导包的方式引用。比如下面的栗子， task.py 位于当前文件的上一层目录中。

# task.py
def task_1(a, b):
    print(a+b)

那么我们可以如下定义JOBS

JOBS = [
            'id': 'job1',
            'func': '.task:task_1',
            'args': (1, 2),
            'trigger': 'interval',
            'seconds': 10
    ]

cron启动任务

crontab是Linux中定时任务启动程序，我们可以通过配置crontab的配置文件来定时启动任务。在APScheduler中也可以通过cron的形式来定时启动任务。下载的例子来说明配置方式。

from flask import Flask
import datetime
from flask_apscheduler import APScheduler
aps = APScheduler()
class Config(object):
    JOBS = [
            'id': 'job1',
            'func': 'scheduler:task',
            'args': (1, 2),
            'trigger': 'cron',
            'day': '*',
            'hour': '13',
            'minute': '16',
            'second': '20'
    SCHEDULER_API_ENABLED = True
def task(a, b):
    print(str(datetime.datetime.now()) + ' execute task ' + '{}+{}={}'.format(a, b, a + b))
if __name__ == '__main__':
    app = Flask(__name__)
    app.config.from_object(Config())
    scheduler = APScheduler()
    scheduler.init_app(app)
    scheduler.start()
    app.run(port=8000)

上述的代码表示，在 每天的13:16:20秒 启动 task() 函数。其实看配置就能理解意思，一目了然，其中*代表任意的意思。上述代码运行输出如下:

使用装饰器定时启动任务

除了上面通过配置的方式来启动定时任务外，我们还可以使用装饰器的方式来定时启动任务。例子如下所示

from flask import Flask
from flask_apscheduler import APScheduler
import datetime
class Config(object):
    SCHEDULER_API_ENABLED = True
scheduler = APScheduler()
# interval examples
@scheduler.task('interval', id='do_job_1', seconds=30, misfire_grace_time=900)
def job1():
    print(str(datetime.datetime.now()) + ' Job 1 executed')
# cron examples
@scheduler.task('cron', id='do_job_2', minute='*')
def job2():
    print(str(datetime.datetime.now()) + ' Job 2 executed')
@scheduler.task('cron', id='do_job_3', week='*', day_of_week='sun')
def job3():
    print(str(datetime.datetime.now()) + ' Job 3 executed')
@scheduler.task('cron', id='do_job_3', day='*', hour='13', minute='26', second='05')
def job4():
    print(str(datetime.datetime.now()) + ' Job 4 executed')
if __name__ == '__main__':
    app = Flask(__name__)
    app.config.from_object(Config())