Django学习笔记-定时器 CRONTAB

2022-01-27 19:39:26

一、Introduction

在官网上的说明：
dead simple crontab powered job scheduling for django
英语不好的我只是认为crontab能给django提供一个按照时间进行的作业调度的功能。

二、Backgoround

在做网站的时候，往往需要在某个固定的时间点，或者某个固定的时间间隔自动的触发一个事件，进行一些操作。比如每个月的财务报表在月末的时候会自动生成，然后发一个账单到你的email中。

针对这个需求，我们就要使用crontab实现定时器的功能。
但是在django中实现定时器的工具有好几种，我们使用crontab是因为它比较简单，易于使用。
celery也可以实现这个功能，这里就不讨论了。

但是crontab有个缺点：

就是他不支持在windows使用。不过幸好博主就是在linux上开发的。

三、CRONTAB

话不多说，开始使用crontab吧。

1.安装

pip install django-crontab

2.配置

在setting.py中的INSTALLED_APPS加入django_crontab

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

    'django_crontab',
]

3.添加定时任务

在app中的xxx.py中加入task()函数


# 某个app/xxx.py
def task():
   #定时任务
   ···

同时要在setting.py中添加这个定时任务

CRONJOBS = [
    # 每一分钟执行一次  
    ('*/1 * * * *', 'app名称.xxx.task')
]

具体参数解释：

前5个（*）星号：

M(分钟0-59)
H(小时0-23)
D(天1-31)
m(月1-12)
d(一星期内的天0-6,0为星期天)

特殊符号：

* 代表所有的取值范围的数字
/ 代表每的意思，*/5就是每5个单位
- 代表从某个数字到某个数字
, 分开几个离散的数字

举个列子：

每两个小时 0 /2 * *
晚上11点到早上8点之间每两个小时，早上8点 0 23-7,8 * * *
每个月的4号和每个礼拜的礼拜一到礼拜三的早上11点 0 11 4 * 1-3
1月1日早上4点 0 4 1 1 *

4.启动任务

# 将任务添加并生效
python manage.py crontab add
# 显示当前的定时任务
python manage.py crontab show
# 删除所有定时任务
python manage.py crontab remove
# 只运行定时任务试一试
python manage.py crontab run

注意：
当添加一个定时任务后：

得到了一个hash值，所以在进行run的时候：


python manage.py crontab run 2fc2215151a785c33b28c74ad5feb636

就像git一样

除此之外，要有查看crontab的文件的命令：corntab -e

四、结束

运行这个项目就会定时触发事件，执行你要的代码了。
当然要是仅仅输出一些东西，运行的时候是看不到的。

打印log，传参等等这里就不赘述了。如图

五、参考

https://github.com/kraiz/django-crontab
https://pypi.python.org/pypi/django-crontab

码农公寓