<h1>APScheduler定时任务</h1><p>上次测试女神听了我的建议，已经做好了要给项目添加定时任务的决定了。但是之前提供的四种方式中，她不知道具体选择哪一个。为了和女神更近一步，我把我入行近10年收藏的干货免费拿出来分享给女神，希望女神凌晨2点再找我的时候，不再是因为要给他调程序了。</p><p>Python中定时任务的解决方案，总体来说有四种，分别是：crontab、 scheduler、 Celery、 APScheduler，其中 crontab不适合多台服务器的配置、scheduler太过于简单、 Celery依赖的软件比较多，比较耗资源。最好的解决方案就是 APScheduler。</p><p>APScheduler使用起来十分方便。提供了基于日期、固定时间间隔以及 crontab类型的任务。还可以在程序运行过程中动态的新增任务和删除任务。在任务运行过程中，还可以把任务存储起来，下次启动运行依然保留之前的状态。另外最重要的一个特点是，因为他是基于 Python语言的库，所以是可以跨平台的，一段代码，处处运行！</p><p>在这里我来给大家详细介绍一下具体的用法。</p><h2>一、安装：</h2><p>安装非常简单，通过 pip install apscheduler即可。</p><h2>二、基本使用：</h2><p>先来看一段代码，然后再来给大家详细讲解其中的细节：</p><ol><li><p><img src="https://upload-images.jianshu.io/upload_images/6620012-1e0fa8a3ec47c84b.png" class="uploaded-img" width="auto" height="auto">
</p></li></ol><p>其中 BlockingScheduler是阻塞性的调度器，是最基本的调度器，下面调用 start方法就会阻塞当前进程，所以如果你的程序除了调度进程没有其他后台进程，那么是可以是否的，否则这个调度器会阻塞你程序的正常执行。</p><p>接下来就是定义一个 my_clock函数，这个函数就是需要定时调度的任务代码。</p><p>然后就是实例化一个 BlockingScheduler对象，并把 my_clock添加到任务调度中。然后看 interval参数，这里用的是间隔的方式来调度，调度频率是 seconds=3，也就是每3秒执行一次。</p><p>执行结果如下：<img src="https://upload-images.jianshu.io/upload_images/6620012-219c233a62973760.jpeg" class="uploaded-img" width="auto" height="auto"></p><p>可以看到每隔3秒钟的时间会执行一次。说明定时任务已经成功执行了！</p><p>在了解了 APScheduler的基本使用后，再来对 APScheduler的四个基本对象做个了解，这样才能从全局掌握 APScheduler。</p><h2>三、四个基本对象：</h2><h3>1. 触发器（triggers）：</h3><p>触发器就是根据你指定的触发方式，比如是按照时间间隔，还是按照 crontab触发，触发条件是什么等。每个任务都有自己的触发器。</p><h3>2. 任务存储器（job stores）：</h3><p>任务存储器是可以存储任务的地方，默认情况下任务保存在内存，也可将任务保存在各种数据库中。任务存储进去后，会进行序列化，然后也可以反序列化提取出来，继续执行。</p><h3>3. 执行器（executors）：</h3><p>执行器的目的是安排任务到线程池或者进程池中运行的。</p><h3>4. 调度器（schedulers）：</h3><p>任务调度器是属于整个调度的总指挥官。他会合理安排作业存储器、执行器、触发器进行工作，并进行添加和删除任务等。调度器通常是只有一个的。开发人员很少直接操作触发器、存储器、执行器等。因为这些都由调度器自动来实现了。</p><p><img src="https://upload-images.jianshu.io/upload_images/6620012-d7462dd83dc8a2ee.jpeg" class="uploaded-img" width="auto" height="auto"></p><h2>四、触发器：</h2><p>触发器有两种，第一种是 interval，第二种是 crontab。interval可以具体指定多少时间间隔执行一次。crontab可以指定执行的日期策略。以下分别进行讲解。</p><h3>1. date触发器：</h3><p>在某个日期时间只触发一次事件。示例代码如下：</p><ol><li><p><img src="https://upload-images.jianshu.io/upload_images/6620012-80b31cb26acd3ef7.png" class="uploaded-img" width="auto" height="auto">
</p></li></ol><p>更多请参考：https://apscheduler.readthedocs.io/en/stable/modules/triggers/date.html</p><h3>2. interval触发器：</h3><p>想要在固定的时间间隔触发事件。interval的触发器可以设置以下的触发参数：</p><ol><li><p>weeks：周。整形。</p></li><li><p>days：一个月中的第几天。整形。</p></li><li><p>hours：小时。整形。</p></li><li><p>minutes：分钟。整形。</p></li><li><p>seconds：秒。整形。</p></li><li><p>start_date：间隔触发的起始时间。</p></li><li><p>end_date：间隔触发的结束时间。</p></li><li><p>jitter：触发的时间误差。</p></li></ol><ol><li><p><img src="https://upload-images.jianshu.io/upload_images/6620012-ffa0348917bdfa7b.png" class="uploaded-img" width="auto" height="auto">
</p></li></ol><p>在每天的11点24分触发事件。更多请参考：https://apscheduler.readthedocs.io/en/stable/modules/triggers/interval.html</p><h3>3. crontab触发器：</h3><p>在某个确切的时间周期性的触发事件。可以使用的参数如下：</p><ol><li><p>year：4位数字的年份。</p></li><li><p>month：1-12月份。</p></li><li><p>day：1-31日。</p></li><li><p>week：1-53周。</p></li><li><p>day_of_week：一个礼拜中的第几天（ 0-6或者 mon、 tue、 wed、 thu、 fri、 sat、 sun）。</p></li><li><p>hour： 0-23小时。</p></li><li><p>minute： 0-59分钟。</p></li><li><p>second： 0-59秒。</p></li><li><p>start_date： datetime类型或者字符串类型，起始时间。</p></li><li><p>end_date： datetime类型或者字符串类型，结束时间。</p></li><li><p>timezone：时区。</p></li><li><p>jitter：任务触发的误差时间。</p></li></ol><p>也可以用表达式类型，可以用以下方式：</p><p><img src="https://upload-images.jianshu.io/upload_images/6620012-6e55bcdb764984f5.png" class="uploaded-img" width="auto" height="auto">
</p><p>示例如下：</p><ol><li><p><img src="https://upload-images.jianshu.io/upload_images/6620012-45883e58e1b4cabe.png" class="uploaded-img" width="auto" height="auto">
</p></li></ol><h2>五、调度器：</h2><ol><li><p>BlockingScheduler：适用于调度程序是进程中唯一运行的进程，调用 start函数会阻塞当前线程，不能立即返回。</p></li><li><p>BackgroundScheduler：适用于调度程序在应用程序的后台运行，调用 start后主线程不会阻塞。</p></li><li><p>AsyncIOScheduler：适用于使用了 asyncio模块的应用程序。</p></li><li><p>GeventScheduler：适用于使用 gevent模块的应用程序。</p></li><li><p>TwistedScheduler：适用于构建 Twisted的应用程序。</p></li><li><p>QtScheduler：适用于构建 Qt的应用程序。</p></li></ol><h2>六、任务存储器：</h2><p>任务存储器的选择有两种。一是内存，也是默认的配置。二是数据库。使用内存的方式是简单高效，但是不好的是，一旦程序出现问题，重新运行的话，会把之前已经执行了的任务重新执行一遍。数据库则可以在程序崩溃后，重新运行可以从之前中断的地方恢复正常运行。有以下几种选择：</p><ol><li><p>MemoryJobStore：没有序列化，任务存储在内存中，增删改查都是在内存中完成。</p></li><li><p>SQLAlchemyJobStore：使用 SQLAlchemy这个 ORM框架作为存储方式。</p></li><li><p>MongoDBJobStore：使用 mongodb作为存储器。</p></li><li><p>RedisJobStore：使用 redis作为存储器。</p></li></ol><h2>七、执行器：</h2><p>执行器的选择取决于应用场景。通常默认的 ThreadPoolExecutor已经在大部分情况下是可以满足我们需求的。如果我们的任务涉及到一些 CPU密集计算的操作。那么应该考虑 ProcessPoolExecutor。然后针对每种程序， apscheduler也设置了不同的 executor：</p><ol><li><p>ThreadPoolExecutor：线程池执行器。</p></li><li><p>ProcessPoolExecutor：进程池执行器。</p></li><li><p>GeventExecutor： Gevent程序执行器。</p></li><li><p>TornadoExecutor： Tornado程序执行器。</p></li><li><p>TwistedExecutor： Twisted程序执行器。</p></li><li><p>AsyncIOExecutor： asyncio程序执行器。</p></li></ol><h2>八、定时任务调度配置：</h2><p>这里我们用一个例子来说明。比如我想这样配置</p><ol><li><p>执行器：</p></li><ul><li><p>配置 default执行器为 ThreadPoolExecutor，并且设置最多的线程数是20个。</p></li><li><p><</p></li></ul><li><p>存储器：</p></li><ul><li><p>配置 default的任务存储器为 SQLAlchemyJobStore(使用SQLite)。</p></li><li><p><</p></li></ul><li><p>任务配置：</p></li><li><p>设置 coalesce为 False：设置这个目的是，比如由于某个原因导致某个任务积攒了很多次没有执行（比如有一个任务是1分钟跑一次，但是系统原因断了5分钟），如果 coalesce=True，那么下次恢复运行的时候，会只执行一次，而如果设置 coalesce=False，那么就不会合并，会5次全部执行。</p></li><li><p>max_instances=5：同一个任务同一时间最多只能有5个实例在运行。比如一个耗时10分钟的job，被指定每分钟运行1次，如果我 max_instance值5，那么在第6~10分钟上，新的运行实例不会被执行，因为已经有5个实例在跑了。</p></li></ol><p>那么代码如下：</p><ol><li><p><img src="https://upload-images.jianshu.io/upload_images/6620012-e6d38e76ad9fbb9e.png" class="uploaded-img" width="auto" height="auto"><img src="https://upload-images.jianshu.io/upload_images/6620012-834ebd16476ff0c7.png" class="uploaded-img" width="auto" height="auto"><img src="https://upload-images.jianshu.io/upload_images/6620012-2514436bb55ba32b.png" class="uploaded-img" width="auto" height="auto">
</p></li><li><p><span style="color: rgba(0, 0, 0, 0.85); font-size: x-large;">九、任务操作：</span></p></li></ol><h3>1. 添加任务：</h3><p>使用 scheduler.add_job(job_obj,args,id,trigger,trigger_kwargs)。</p><h3>2. 删除任务：</h3><p>使用 scheduler.remove_job(job_id,jobstore=None)。</p><h3>3. 暂停任务：</h3><p>使用 scheduler.pause_job(job_id,jobstore=None)。</p><h3>4. 恢复任务：</h3><p>使用 scheduler.resume_job(job_id,jobstore=None)。</p><h3>5. 修改某个任务属性信息：</h3><p>使用 scheduler.modify_job(job_id,jobstore=None,changes)。</p><h3>6. 修改单个作业的触发器并更新下次运行时间：</h3><p>使用 scheduler.reschedule_job(job_id,jobstore=None,trigger=None,**trigger_args)</p><h3>7. 输出作业信息：</h3><p>使用 scheduler.print_jobs(jobstore=None,out=sys.stdout)</p><h2>十、异常监听：</h2><p>当我们的任务抛出异常后，我们可以监听到，然后把错误信息进行记录。示例代码如下：</p><ol><li><p>from apscheduler.schedulers.blocking import BlockingScheduler</p></li><li><p>from apscheduler.events import EVENT_JOB_EXECUTED, EVENT_JOB_ERROR</p></li><li><p>import datetime</p></li><li><p>import logging</p></li><li><p>
</p></li><li><p># 配置日志显示</p></li><li><p><img src="https://upload-images.jianshu.io/upload_images/6620012-9595d5363d1baf09.png" class="uploaded-img" width="auto" height="auto"><img src="https://upload-images.jianshu.io/upload_images/6620012-9ac054139f51377a.png" class="uploaded-img" width="auto" height="auto"><img src="https://upload-images.jianshu.io/upload_images/6620012-aa37af931f761ee0.png" class="uploaded-img" width="auto" height="auto">
</p></li></ol><p>以上便是 APScheduler库的详细用法了。如果我们需要在项目中开一个定时功能，完全可以选择 APScheduler，轻量又功能强大。</p><p>这次女神再也不用2点跑到公司去加班啦~</p><p><img src="https://upload-images.jianshu.io/upload_images/6620012-5e2e6e8c43b1338a.png" class="uploaded-img" width="auto" height="auto">
</p>