利用django-crontab设定定时任务

　　Django中想要设定定时任务的方法有不少，如celery、apscheduler、crontab等等，本文用crontab来实现。

　　想用apscheduler实现请看本人另外一篇博客：使用APScheduler启动Django服务时自动运行脚本（可设置定时运行）

Crontab简介

　　crond 是linux下用来周期性的执行某种任务或等待处理某些事件的一个守护进程，与windows下的计划任务相似，当安装完成操做系统后，默认会安装此服务 工具，而且会自动启动crond进程，crond进程每分钟会按期检查是否有要执行的任务，若是有要执行的任务，则自动执行该任务。

　　Linux下的任务调度分为两类，系统任务调度和用户任务调度。

• 系统任务调度：系统周期性所要执行的工做，好比写缓存数据到硬盘、日志清理等。在/etc目录下有一个crontab文件，这个就是系统任务调度的配置文件。

cat /etc/crontab

SHELL=/bin/bash

PATH=/sbin:/bin:/usr/sbin:/usr/bin

MAILTO=HOME=/

# run-parts

51 * * * * root run-parts /etc/cron.hourly

24 7 * * * root run-parts /etc/cron.daily

22 4 * * 0 root run-parts /etc/cron.weekly

42 4 1 * * root run-parts /etc/cron.monthly
"""
前四行是用来配置crond任务运行的环境变量，第一行SHELL变量指定了系统要使用哪一个shell，这里是bash，第二行PATH变量指定了系统执行 命令的路径，第三行MAILTO变量指定了crond的任务执行信息将经过电子邮件发送给root用户，若是MAILTO变量的值为空，则表示不发送任务 执行信息给用户，第四行的HOME变量指定了在执行命令或者脚本时使用的主目录。第六至九行用的是crond语法，详细含义在下文中会进行解释
"""

/etc/crontab文件内容

• 用户任务调度：用户按期要执行的工做，好比用户数据备份、定时邮件提醒等。用户可使用 crontab 工具来定制本身的计划任务。全部用户定义的crontab 文件都被保存在 /var/spool/cron目录中。其文件名与用户名一致。

"""
文件：/etc/cron.deny
说明：该文件中所列用户不容许使用crontab命令

文件：/etc/cron.allow
说明：该文件中所列用户容许使用crontab命令

文件：/var/spool/cron/
说明：全部用户crontab文件存放的目录,以用户名命名

"""

使用者权限文件

 

Django-crontab的配置及使用

　　首先咱们须要先安装好Django-crontab的第三方库

pip install django-crontab

 

　　而后咱们须要将django-crontab加入到settings.py的INSTALLED_APPS中。以下代码：

INSTALLED_APPS = (
'django_crontab',
...
)

 

　　接下来咱们须要自行配置一个Django的命令，若是你还不会自定制Django的命令的话请看这篇编写自定义django-admin命令

　　在编写完自定制命令后，咱们须要进行时间的配置，使Django知道你是想在何时运行这段程序。在settings.py中写入配置（这里咱们假设自定制命令名称为xxx）

CRONJOBS = [
    ('47 11 * * *', 'django.core.management.call_command', ['xxx'],{},'>> /var/run.log'),
]
#上述配置意思为天天11点47分运行xxx这个命令,{}为函数须要传入的参数，>>后面为打印日志的文件路径。

 

这里须要科普一下关于crontab的语法知识

　　Crontab语法用五个段来定义时间，具体含义：

*     *   *   *    *  command to be executed
-     -    -    -    -
|     |     |     |     |
|     |     |     |     +----- day of week (0 - 6) (Sunday=0)
|     |     |     +------- month (1 - 12)
|     |     +--------- day of month (1 - 31)
|     +----------- hour (0 - 23)
+------------- min (0 - 59)

#全部的值都必须在相应的范围以内，不然视为无效。在填值区域内能够是*也能够是以”，”分隔的一组值。值能够是一个数据也能够是用链接符连起来的两个数(表示范围)。
#星号（*）：表明全部可能的值，例如month字段若是是星号，则表示在知足其它字段的制约条件后每个月都执行该命令操做。
#逗号（,）：能够用逗号隔开的值指定一个列表范围，例如，“1,2,5,7,8,9”
#中杠（-）：能够用整数之间的中杠表示一个整数范围，例如“2-6”表示“2,3,4,5,6”
#正斜线（/）：能够用正斜线指定时间的间隔频率，例如“0-23/2”表示每两小时执行一次。同时正斜线能够和星号一块儿使用，例如*/10，若是用在minute字段，表示每十分钟执行一次。
注：日期的格式能够是星期，也能够是一个月中的天。假如两个都有值，则在这两个时间都会执行。

#实例1：每1分钟执行一次command
* * * * * command

#实例2：每小时的第3和第15分钟执行
3,15 * * * * command

#实例3：在上午8点到11点的第3和第15分钟执行
3,15 8-11 * * * command

#实例4：每隔两天的上午8点到11点的第3和第15分钟执行
3,15 8-11 */2 * * command

#实例5：每一个星期一的上午8点到11点的第3和第15分钟执行
3,15 8-11 * * 1 command

#实例6：每晚的21:30重启smb 
30 21 * * * /etc/init.d/smb restart

#实例7：每个月一、十、22日的4 : 45重启smb 
45 4 1,10,22 * * /etc/init.d/smb restart

#实例8：每周6、周日的1 : 10重启smb
10 1 * * 6,0 /etc/init.d/smb restart

#实例9：天天18 : 00至23 : 00之间每隔30分钟重启smb 
0,30 18-23 * * * /etc/init.d/smb restart

#实例10：每星期六的晚上11 : 00 pm重启smb 
0 23 * * 6 /etc/init.d/smb restart

#实例11：每一小时重启smb 
* */1 * * * /etc/init.d/smb restart

#实例12：晚上11点到早上7点之间，每隔一小时重启smb 
* 23-7/1 * * * /etc/init.d/smb restart

#实例13：每个月的4号与每周一到周三的11点重启smb 
0 11 4 * mon-wed /etc/init.d/smb restart

#实例14：一月一号的4点重启smb 
0 4 1 jan * /etc/init.d/smb restart

#实例15：每小时执行/etc/cron.hourly目录内的脚本
01   *   *   *   *     root run-parts /etc/cron.hourly

#注：run-parts这个参数了，若是去掉这个参数的话，后面就能够写要运行的某个脚本名，而不是目录名了

更多实例戳这里

 

　　完成上述配置后，咱们只须要运行一条命令，Django就知道在该特定的时间须要作什么特定的事了。（想要让Django作定时任务，前提条件使在该时刻Django项目处于运行状态）

python manage.py crontab add #告诉Django你配置了一个定时任务
#每次修改该任务中任何一段代码的时候，再执行一遍这条命令

python manage.py crontab remove #移除全部的任务

 

　　经过crontab -l 能够看到生成的定时任务

 

使用注意事项

环境变量问题
　　有时咱们建立了一个crontab，可是这个任务却没法自动执行，而手动执行这个任务却没有问题，这种状况通常是因为在crontab文件中没有配置环境变量引发的。

　　在 crontab文件中定义多个调度任务时，须要特别注意的一个问题就是环境变量的设置，由于咱们手动执行某个任务时，是在当前shell环境下进行的，程 序固然能找到环境变量，而系统自动执行任务调度时，是不会加载任何环境变量的，所以，就须要在crontab文件中指定任务运行所需的全部环境变量，这 样，系统执行任务调度时就没有问题了。

　　不要假定cron知道所须要的特殊环境，它其实并不知道。因此你要保证在shelll脚本中提供全部必要的路径和环境变量，除了一些自动设置的全局变量。因此注意以下3点：

　　　　1）脚本中涉及文件路径时写全局路径；

　　　　2）脚本执行要用到java或其余环境变量时，经过source命令引入环境变量，如：

　　　　　　cat start_cbp.sh

　　　　　　#!/bin/sh

　　　　　　source /etc/profile

　　　　　　export RUN_CONF=/home/d139/conf/platform/cbp/cbp_jboss.conf

　　　　　　/usr/local/jboss-4.0.5/bin/run.sh -c mev &

　　　　3）当手动执行脚本OK，可是crontab死活不执行时。这时必须大胆怀疑是环境变量惹的祸，并能够尝试在crontab中直接引入环境变量解决问题。如：

　　　　　　0 * * * * . /etc/profile;/bin/sh /var/www/java/audit_no_count/bin/restart_audit.sh

　　注意清理系统用户的邮件日志
　　每条任务调度执行完毕，系统都会将任务输出信息经过电子邮件的形式发送给当前系统用户，这样日积月累，日志信息会很是大，可能会影响系统的正常运行，所以，将每条任务进行重定向处理很是重要。

　　例如，能够在crontab文件中设置以下形式，忽略日志输出：

　　　　0 */3 * * * /usr/local/apache2/apachectl restart >/dev/null 2>&1

　　　　“/dev/null 2>&1”表示先将标准输出重定向到/dev/null，而后将标准错误重定向到标准输出，因为标准输出已经重定向到了/dev/null，所以标准错误也会重定向到/dev/null，这样日志输出问题就解决了。

系统级任务调度与用户级任务调度
　　系统级任务调度主要完成系统的一些维护操做，用户级任务调度主要完成用户自定义的一些任务，能够将用户级任务调度放到系统级任务调度来完成（不建议这么 作），可是反过来却不行，root用户的任务调度操做能够经过“crontab –uroot –e”来设置，也能够将调度任务直接写入/etc /crontab文件，须要注意的是，若是要定义一个定时重启系统的任务，就必须将任务放到/etc/crontab文件，即便在root用户下建立一个 定时重启系统的任务也是无效的。

其余注意事项
　　新建立的cron job，不会立刻执行，至少要过2分钟才执行。若是重启cron则立刻执行。

　　当crontab忽然失效时，能够尝试/etc/init.d/crond restart解决问题。或者查看日志看某个job有没有执行/报错tail -f /var/log/cron。

　　千万别乱运行crontab -r。它从Crontab目录（/var/spool/cron）中删除用户的Crontab文件。删除了该用户的全部crontab都没了。

　　在crontab中%是有特殊含义的，表示换行的意思。若是要用的话必须进行转义\%，如常常用的date ‘+%Y%m%d’在crontab里是不会执行的，应该换成date ‘+\%Y\%m\%d’。