Django中想要设定定时任务的方法有很多,如celery、apscheduler、crontab等等,本文用crontab来实现。
想用apscheduler实现请看本人另一篇博客:使用APScheduler启动Django服务时自动运行脚本(可设置定时运行)
Crontab简介
crond 是linux下用来周期性的执行某种任务或等待处理某些事件的一个守护进程,与windows下的计划任务类似,当安装完成操作系统后,默认会安装此服务 工具,并且会自动启动crond进程,crond进程每分钟会定期检查是否有要执行的任务,如果有要执行的任务,则自动执行该任务。
Linux下的任务调度分为两类,系统任务调度和用户任务调度。
- 系统任务调度:系统周期性所要执行的工作,比如写缓存数据到硬盘、日志清理等。在/etc目录下有一个crontab文件,这个就是系统任务调度的配置文件。
![](https://i-blog.csdnimg.cn/blog_migrate/8f900a89c6347c561fdf2122f13be562.gif)
![](https://i-blog.csdnimg.cn/blog_migrate/961ddebeb323a10fe0623af514929fc1.gif)
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语法,详细含义在下文中会进行解释 """
- 用户任务调度:用户定期要执行的工作,比如用户数据备份、定时邮件提醒等。用户可以使用 crontab 工具来定制自己的计划任务。所有用户定义的crontab 文件都被保存在 /var/spool/cron目录中。其文件名与用户名一致。
![](https://i-blog.csdnimg.cn/blog_migrate/8f900a89c6347c561fdf2122f13be562.gif)
![](https://i-blog.csdnimg.cn/blog_migrate/961ddebeb323a10fe0623af514929fc1.gif)
""" 文件:/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字段,表示每十分钟执行一次。 注:日期的格式可以是星期,也可以是一个月中的天。假如两个都有值,则在这两个时间都会执行。
![](https://i-blog.csdnimg.cn/blog_migrate/8f900a89c6347c561fdf2122f13be562.gif)
![](https://i-blog.csdnimg.cn/blog_migrate/961ddebeb323a10fe0623af514929fc1.gif)
#实例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:每月1、10、22日的4 : 45重启smb 45 4 1,10,22 * * /etc/init.d/smb restart #实例8:每周六、周日的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’。