1. 说明
在微服务+docker架构下，经常会有一些定时任务需要执行。但是，采用docker执行定时任务，Swarm支持不稳定，尤其Aliyun的Swarm对定时任务的执行，绝对是一个坑。（可能K8S支持更好）
在这种情况下，只能在docker容器内部控制定时任务的执行，于是，APScheduler就是一个不错的选择。
APScheduler基于Quartz的一个Python定时任务框架，实现了Quartz的所有功能，使用起来十分方便。提供了基于日期、固定时间间隔以及crontab类型的任务，并且可以持久化任务。基于这些功能，我们可以很方便的实现一个python定时任务系统。
2. Demo源码
- sched.py
from apscheduler.schedulers.blocking import BlockingScheduler
from src.libs.logging import logger
from subprocess import check_call, CalledProcessError
from datetime import datetime
import sys
from time import time
def schedule(command, interval):
sched = BlockingScheduler()
@sched.scheduled_job('interval', seconds=int(interval), next_run_time=datetime.now(), coalesce=True)
def _sync():
start_time = time()
try:
logger.info('run {}. '.format(command))
check_call(command)
except CalledProcessError as cpe:
logger.exception('call "{}" failed with error code {}'.format(command, cpe.returncode))
except Exception:
logger.exception('in schedule')
logger.info('done run in {} seconds.'.format(time() - start_time))
sched.start()
if __name__ == "__main__":
if len(sys.argv) < 3:
logger.exception('python sched.py interval command')
exit(1)
interval = int(sys.argv[1])
command = sys.argv[2:]
schedule(command, interval)
- 执行脚本
python sched.py 60 python x.py user send_emails
3. 三种执行方式
3.1. cron定时调度（某一定时时刻执行）
- 参数说明
(int|str) 表示参数既可以是int类型，也可以是str类型
(datetime | str) 表示参数既可以是datetime类型，也可以是str类型
year (int|str) – 4-digit year -（表示四位数的年份，如2008年）
month (int|str) – month (1-12) -（表示取值范围为1-12月）
day (int|str) – day of the (1-31) -（表示取值范围为1-31日）
week (int|str) – ISO week (1-53) -（格里历2006年12月31日可以写成2006年-W52-7（扩展形式）或2006W527（紧凑形式））
day_of_week (int|str) – number or name of weekday (0-6 or mon,tue,wed,thu,fri,sat,sun) - （表示一周中的第几天，既可以用0-6表示也可以用其英语缩写表示）
hour (int|str) – hour (0-23) - （表示取值范围为0-23时）
minute (int|str) – minute (0-59) - （表示取值范围为0-59分）
second (int|str) – second (0-59) - （表示取值范围为0-59秒）
start_date (datetime|str) – earliest possible date/time to trigger on (inclusive) - （表示开始时间）
end_date (datetime|str) – latest possible date/time to trigger on (inclusive) - （表示结束时间）
timezone (datetime.tzinfo|str) – time zone to use for the date/time calculations (defaults to scheduler timezone) -（表示时区取值）
-
参数的取值格式
取值格式.png 例子
#表示2017年3月22日17时19分07秒执行该程序
sched.add_job(my_job, 'cron', year=2017,month = 03,day = 22,hour = 17,minute = 19,second = 07)
#表示任务在6,7,8,11,12月份的第三个星期五的00:00,01:00,02:00,03:00 执行该程序
sched.add_job(my_job, 'cron', month='6-8,11-12', day='3rd fri', hour='0-3')
#表示从星期一到星期五5:30（AM）直到2014-05-30 00:00:00
sched.add_job(my_job(), 'cron', day_of_week='mon-fri', hour=5, minute=30,end_date='2014-05-30')
#表示每5秒执行该程序一次，相当于interval 间隔调度中seconds = 5
sched.add_job(my_job, 'cron',second = '*/5')
3.2. interval 间隔调度（每隔多久执行）
- 参数说明
weeks (int) – number of weeks to wait
days (int) – number of days to wait
hours (int) – number of hours to wait
minutes (int) – number of minutes to wait
seconds (int) – number of seconds to wait
start_date (datetime|str) – starting point for the interval calculation
end_date (datetime|str) – latest possible date/time to trigger on
timezone (datetime.tzinfo|str) – time zone to use for the date/time calculations
- 例子
#表示每隔3天17时19分07秒执行一次任务
sched.add_job(my_job, 'interval',days = 03,hours = 17,minutes = 19,seconds = 07)
3.3. date 定时调度（作业只会执行一次）
- 参数说明
run_date (datetime|str) – the date/time to run the job at -（任务开始的时间）
timezone (datetime.tzinfo|str) – time zone for run_date if it doesn’t have one already
- 例子
# The job will be executed on November 6th, 2009
sched.add_job(my_job, 'date', run_date=date(2009, 11, 6), args=['text'])
# The job will be executed on November 6th, 2009 at 16:30:05
sched.add_job(my_job, 'date', run_date=datetime(2009, 11, 6, 16, 30, 5), args=['text'])
4. 更多资料
apscheduler官宣
https://apscheduler.readthedocs.io/en/latest/定时任务框架APScheduler学习详解
http://www.cnblogs.com/luxiaojun/p/6567132.html
