定时任务框架APScheduler学习详解

「爱情、让人受尽委屈。」 2021-11-23 02:46 281阅读 0赞

[定时任务框架APScheduler学习详解][APScheduler]

# APScheduler简介 #

在平常的工作中几乎有一半的功能模块都需要定时任务来推动，例如项目中有一个定时统计程序，定时爬出网站的URL程序，定时检测钓鱼网站的程序等等，都涉及到了关于定时任务的问题，第一时间想到的是利用time模块的time.sleep()方法使程序休眠来达到定时任务的目的，虽然这样也可以，但是总觉得不是那么的专业，^\_^所以就找到了python的定时任务模块APScheduler：

A**PScheduler基于Quartz的一个Python定时任务框架，实现了Quartz的所有功能，使用起来十分方便。提供了基于日期、固定时间间隔以及crontab类型的任务，并且可以持久化任务。基于这些功能，我们可以很方便的实现一个python定时任务系统。**

# 安装 #

### 1、利用pip进行安装 ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>$ pip install apscheduler</code> </td> 
 </tr> 
 </tbody> 
</table>

### 2、源码安装（https://pypi.python.org/pypi/APScheduler/） ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>$ python setup.py install</code> </td> 
 </tr> 
 </tbody> 
</table>

# APScheduler有四种组成部分： #

**触发器(trigger)**包含调度逻辑，每一个作业有它自己的触发器，用于决定接下来哪一个作业会运行。除了他们自己初始配置意外，触发器完全是无状态的。

**作业存储(job store)**存储被调度的作业，默认的作业存储是简单地把作业保存在内存中，其他的作业存储是将作业保存在数据库中。一个作业的数据讲在保存在持久化作业存储时被序列化，并在加载时被反序列化。调度器不能分享同一个作业存储。

**执行器(executor)**处理作业的运行，他们通常通过在作业中提交制定的可调用对象到一个线程或者进城池来进行。当作业完成时，执行器将会通知调度器。

**调度器(scheduler)**是其他的组成部分。你通常在应用只有一个调度器，应用的开发者通常不会直接处理作业存储、调度器和触发器，相反，调度器提供了处理这些的合适的接口。配置作业存储和执行器可以在调度器中完成，例如添加、修改和移除作业。

# 简单应用： #

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>import</code>&nbsp;<code>time</code> <code>from</code>&nbsp;<code>apscheduler.schedulers.blocking&nbsp;</code><code>import</code>&nbsp;<code>BlockingScheduler</code> &nbsp; <code>def</code>&nbsp;<code>my_job():</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>time.strftime(</code><code>'%Y-%m-%d %H:%M:%S'</code><code>, time.localtime(time.time()))</code> &nbsp; <code>sched&nbsp;</code><code>=</code>&nbsp;<code>BlockingScheduler()</code> <code>sched.add_job(my_job,&nbsp;</code><code>'interval'</code><code>, seconds</code><code>=</code><code>5</code><code>)</code> <code>sched.start()</code> </td> 
 </tr> 
 </tbody> 
</table>

上面的例子表示每隔5s执行一次my\_job函数，输出当前时间信息

# 操作作业 #

## 1. 添加作业 ##

上面是通过add\_job()来添加作业，另外还有一种方式是通过scheduled\_job()修饰器来修饰函数

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>import</code>&nbsp;<code>time</code> <code>from</code>&nbsp;<code>apscheduler.schedulers.blocking&nbsp;</code><code>import</code>&nbsp;<code>BlockingScheduler</code> &nbsp; <code>sched&nbsp;</code><code>=</code>&nbsp;<code>BlockingScheduler()</code> &nbsp; <code>@sched</code><code>.scheduled_job(</code><code>'interval'</code><code>, seconds</code><code>=</code><code>5</code><code>)</code> <code>def</code>&nbsp;<code>my_job():</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code>&nbsp;<code>time.strftime(</code><code>'%Y-%m-%d %H:%M:%S'</code><code>, time.localtime(time.time()))</code> &nbsp; <code>sched.start()</code> </td> 
 </tr> 
 </tbody> 
</table>

## 2. 移除作业 ##

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>job&nbsp;</code><code>=</code>&nbsp;<code>scheduler.add_job(myfunc,&nbsp;</code><code>'interval'</code><code>, minutes</code><code>=</code><code>2</code><code>)</code> <code>job.remove()</code> <code>#如果有多个任务序列的话可以给每个任务设置ID号，可以根据ID号选择清除对象，且remove放到start前才有效</code> <code>sched.add_job(myfunc,&nbsp;</code><code>'interval'</code><code>, minutes</code><code>=</code><code>2</code><code>,&nbsp;</code><code>id</code><code>=</code><code>'my_job_id'</code><code>)</code> <code>sched.remove_job(</code><code>'my_job_id'</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

## 3. 暂停和恢复作业 ##

暂停作业:

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>apsched.job.Job.pause()</code> <code>apsched.schedulers.base.BaseScheduler.pause_job()</code> </td> 
 </tr> 
 </tbody> 
</table>

恢复作业:

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>apsched.job.Job.resume()</code> <code>apsched.schedulers.base.BaseScheduler.resume_job()</code> </td> 
 </tr> 
 </tbody> 
</table>

## 4. 获得job列表 ##

获得调度作业的列表，可以使用`get_jobs()`来完成，它会返回所有的job实例。或者使用`print_jobs()`来输出所有格式化的作业列表。也可以利用get\_job(任务ID)获取指定任务的作业列表

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>job&nbsp;</code><code>=</code>&nbsp;<code>sched.add_job(my_job,&nbsp;</code><code>'interval'</code><code>, seconds</code><code>=</code><code>2</code>&nbsp;<code>,</code><code>id</code><code>=</code><code>'123'</code><code>)</code> <code>print</code>&nbsp;<code>sched.get_job(job_id</code><code>=</code><code>'123'</code><code>)</code> <code>print</code>&nbsp;<code>sched.get_jobs()</code> </td> 
 </tr> 
 </tbody> 
</table>

## 5. 关闭调度器 ##

默认情况下调度器会等待所有正在运行的作业完成后，关闭所有的调度器和作业存储。如果你不想等待，可以将wait选项设置为False。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>sched.shutdown()</code> <code>sched.shutdown(wait</code><code>=</code><code>False</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

# 作业运行的控制（trigger） #

add\_job的第二个参数是trigger，它管理着作业的调度方式。它可以为date, interval或者cron。对于不同的trigger，对应的参数也相同。

## (1). cron定时调度（某一定时时刻执行） ##

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 </td> 
 <td> <code>(</code><code>int</code><code>|</code><code>str</code><code>) 表示参数既可以是</code><code>int</code><code>类型，也可以是</code><code>str</code><code>类型</code> <code>(datetime |&nbsp;</code><code>str</code><code>) 表示参数既可以是datetime类型，也可以是</code><code>str</code><code>类型</code> &nbsp; <code>year (</code><code>int</code><code>|</code><code>str</code><code>) –&nbsp;</code><code>4</code><code>-</code><code>digit year&nbsp;</code><code>-</code><code>（表示四位数的年份，如</code><code>2008</code><code>年）</code> <code>month (</code><code>int</code><code>|</code><code>str</code><code>) – month (</code><code>1</code><code>-</code><code>12</code><code>)&nbsp;</code><code>-</code><code>（表示取值范围为</code><code>1</code><code>-</code><code>12</code><code>月）</code> <code>day (</code><code>int</code><code>|</code><code>str</code><code>) – day of the (</code><code>1</code><code>-</code><code>31</code><code>)&nbsp;</code><code>-</code><code>（表示取值范围为</code><code>1</code><code>-</code><code>31</code><code>日）</code> <code>week (</code><code>int</code><code>|</code><code>str</code><code>) – ISO week (</code><code>1</code><code>-</code><code>53</code><code>)&nbsp;</code><code>-</code><code>（格里历</code><code>2006</code><code>年</code><code>12</code><code>月</code><code>31</code><code>日可以写成</code><code>2006</code><code>年</code><code>-</code><code>W52</code><code>-</code><code>7</code><code>（扩展形式）或</code><code>2006W527</code><code>（紧凑形式））</code> <code>day_of_week (</code><code>int</code><code>|</code><code>str</code><code>) – number&nbsp;</code><code>or</code>&nbsp;<code>name of weekday (</code><code>0</code><code>-</code><code>6</code>&nbsp;<code>or</code>&nbsp;<code>mon,tue,wed,thu,fri,sat,sun)&nbsp;</code><code>-</code>&nbsp;<code>（表示一周中的第几天，既可以用</code><code>0</code><code>-</code><code>6</code><code>表示也可以用其英语缩写表示）</code> <code>hour (</code><code>int</code><code>|</code><code>str</code><code>) – hour (</code><code>0</code><code>-</code><code>23</code><code>)&nbsp;</code><code>-</code>&nbsp;<code>（表示取值范围为</code><code>0</code><code>-</code><code>23</code><code>时）</code> <code>minute (</code><code>int</code><code>|</code><code>str</code><code>) – minute (</code><code>0</code><code>-</code><code>59</code><code>)&nbsp;</code><code>-</code>&nbsp;<code>（表示取值范围为</code><code>0</code><code>-</code><code>59</code><code>分）</code> <code>second (</code><code>int</code><code>|</code><code>str</code><code>) – second (</code><code>0</code><code>-</code><code>59</code><code>)&nbsp;</code><code>-</code>&nbsp;<code>（表示取值范围为</code><code>0</code><code>-</code><code>59</code><code>秒）</code> <code>start_date (datetime|</code><code>str</code><code>) – earliest possible date</code><code>/</code><code>time to trigger on (inclusive)&nbsp;</code><code>-</code>&nbsp;<code>（表示开始时间）</code> <code>end_date (datetime|</code><code>str</code><code>) – latest possible date</code><code>/</code><code>time to trigger on (inclusive)&nbsp;</code><code>-</code>&nbsp;<code>（表示结束时间）</code> <code>timezone (datetime.tzinfo|</code><code>str</code><code>) – time zone to use&nbsp;</code><code>for</code>&nbsp;<code>the date</code><code>/</code><code>time calculations (defaults to scheduler timezone)&nbsp;</code><code>-</code><code>（表示时区取值）</code> </td> 
 </tr> 
 </tbody> 
</table>

### 参数的取值格式： ###

![aHR0cHM6Ly9pbWFnZXMyMDE1LmNuYmxvZ3MuY29tL2Jsb2cvOTQwMTY3LzIwMTcwMy85NDAxNjctMjAxNzAzMjIxNzU2MzYzNzctOTczOTk0NjY1LnBuZw][]

### 例子： ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 </td> 
 <td> <code>#表示2017年3月22日17时19分07秒执行该程序</code> <code>sched.add_job(my_job,&nbsp;</code><code>'cron'</code><code>, year</code><code>=</code><code>2017</code><code>,month&nbsp;</code><code>=</code>&nbsp;<code>03</code><code>,day&nbsp;</code><code>=</code>&nbsp;<code>22</code><code>,hour&nbsp;</code><code>=</code>&nbsp;<code>17</code><code>,minute&nbsp;</code><code>=</code>&nbsp;<code>19</code><code>,second&nbsp;</code><code>=</code>&nbsp;<code>07</code><code>)</code> &nbsp; <code>#表示任务在6,7,8,11,12月份的第三个星期五的00:00,01:00,02:00,03:00 执行该程序</code> <code>sched.add_job(my_job,&nbsp;</code><code>'cron'</code><code>, month</code><code>=</code><code>'6-8,11-12'</code><code>, day</code><code>=</code><code>'3rd fri'</code><code>, hour</code><code>=</code><code>'0-3'</code><code>)</code> &nbsp; <code>#表示从星期一到星期五5:30（AM）直到2014-05-30 00:00:00</code> <code>sched.add_job(my_job(),&nbsp;</code><code>'cron'</code><code>, day_of_week</code><code>=</code><code>'mon-fri'</code><code>, hour</code><code>=</code><code>5</code><code>, minute</code><code>=</code><code>30</code><code>,end_date</code><code>=</code><code>'2014-05-30'</code><code>)</code> &nbsp; <code>#表示每5秒执行该程序一次，相当于interval 间隔调度中seconds = 5</code> <code>sched.add_job(my_job,&nbsp;</code><code>'cron'</code><code>,second&nbsp;</code><code>=</code>&nbsp;<code>'*/5'</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

## (2). interval 间隔调度（每隔多久执行） ##

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>weeks (</code><code>int</code><code>) – number of weeks to wait</code> <code>days (</code><code>int</code><code>) – number of days to wait</code> <code>hours (</code><code>int</code><code>) – number of hours to wait</code> <code>minutes (</code><code>int</code><code>) – number of minutes to wait</code> <code>seconds (</code><code>int</code><code>) – number of seconds to wait</code> <code>start_date (datetime|</code><code>str</code><code>) – starting point&nbsp;</code><code>for</code>&nbsp;<code>the interval calculation</code> <code>end_date (datetime|</code><code>str</code><code>) – latest possible date</code><code>/</code><code>time to trigger on</code> <code>timezone (datetime.tzinfo|</code><code>str</code><code>) – time zone to use&nbsp;</code><code>for</code>&nbsp;<code>the date</code><code>/</code><code>time calculations</code> </td> 
 </tr> 
 </tbody> 
</table>

### 例子： ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>#表示每隔3天17时19分07秒执行一次任务</code> <code>sched.add_job(my_job,&nbsp;</code><code>'interval'</code><code>,days&nbsp;&nbsp;</code><code>=</code>&nbsp;<code>03</code><code>,hours&nbsp;</code><code>=</code>&nbsp;<code>17</code><code>,minutes&nbsp;</code><code>=</code>&nbsp;<code>19</code><code>,seconds&nbsp;</code><code>=</code>&nbsp;<code>07</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

## (3). date 定时调度（作业只会执行一次） ##

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>run_date (datetime|</code><code>str</code><code>) – the date</code><code>/</code><code>time to run the job at&nbsp;&nbsp;</code><code>-</code><code>（任务开始的时间）</code> <code>timezone (datetime.tzinfo|</code><code>str</code><code>) – time zone&nbsp;</code><code>for</code>&nbsp;<code>run_date&nbsp;</code><code>if</code>&nbsp;<code>it doesn’t have one already</code> </td> 
 </tr> 
 </tbody> 
</table>

### 例子： ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code># The job will be executed on November 6th, 2009</code> <code>sched.add_job(my_job,&nbsp;</code><code>'date'</code><code>, run_date</code><code>=</code><code>date(</code><code>2009</code><code>,&nbsp;</code><code>11</code><code>,&nbsp;</code><code>6</code><code>), args</code><code>=</code><code>[</code><code>'text'</code><code>])</code> <code># The job will be executed on November 6th, 2009 at 16:30:05</code> <code>sched.add_job(my_job,&nbsp;</code><code>'date'</code><code>, run_date</code><code>=</code><code>datetime(</code><code>2009</code><code>,&nbsp;</code><code>11</code><code>,&nbsp;</code><code>6</code><code>,&nbsp;</code><code>16</code><code>,&nbsp;</code><code>30</code><code>,&nbsp;</code><code>5</code><code>), args</code><code>=</code><code>[</code><code>'text'</code><code>])</code> </td> 
 </tr> 
 </tbody> 
</table>

[APScheduler]: https://www.cnblogs.com/luxiaojun/p/6567132.html
[aHR0cHM6Ly9pbWFnZXMyMDE1LmNuYmxvZ3MuY29tL2Jsb2cvOTQwMTY3LzIwMTcwMy85NDAxNjctMjAxNzAzMjIxNzU2MzYzNzctOTczOTk0NjY1LnBuZw]: /images/20211122/ce83342858a5498683e4b1fc713b80f1.png