django 任务管理-crontab

背景

Django crontab 最终是通过配置调用Django相关函数，然后在对应的服务器配置crontab任务，当然，想让任务借助于主机cron服务运行，也就需要确保启动了 cron 服务

安装和使用

1、安装

pip install django-crontab
1

2、配置

修改项目的 settings.py 配置文件，在 INSTALLED_APPS中添加 django_crontab ，注意这里是 下划线 而不是 中横线

INSTALLED_APPS = [
    ... ...,
    'django_crontab',
    ... ...
]
1
2
3
4
5

3、新增APP然后创建cron.py 文件开发定时任务

这里文件名一般建议命名成 cron.py， 当然也可以根据自己喜好进行命名

# demoapp/cron.py
import datetime

# 定时任务，不带参数
def demo_cron_task():
    now_time = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')
    print(f"This is a demo Crontab Task at {now_time}")

# 定时任务，带参数
def demo_cron_hello(name):
    now_time = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')
    print(f"This is a demo Crontab Task at {now_time} , say hello to {name}")
1
2
3
4
5
6
7
8
9
10
11
12

4、配置Django添加CRONJOBS 参数

# 定时任务配置
CRONJOBS = [
    # 无参数任务
    ('*/1 * * * *', 'cronapp.cron.demo_cron_task', '>> /tmp/django-crontab.log'),
    # 带参数任务
    ('*/1 * * * *', 'cronapp.cron.demo_cron_hello', ['James'], {}, '>> /tmp/django-crontab.log')
]
1
2
3
4
5
6
7

5、通过 Django 相关命令进行 任务管理

# 添加任务（到 主机crontab中去）
python manage.py crontab add

# 查看任务
python manage.py crontab show

# 删除任务
python manage.py crontab remove
1
2
3
4
5
6
7
8

在主机上可以通过crontab -l 来查看任务是否添加成功

如果任务有输出，也通过查看日志输出来确认任务的执行情况

---

Django crontab的优缺点

1、优点：

简单、方便、易于管理。与django服务本身是分离的，不会影响到django对外提供的web服务。

2、缺点：

• 无法在Windows平台上运行

因为django_crontab必须在Linux的crontab开启的情况下才可以使用，不然会出现不执行的情况

遇到的问题汇总

1、关于 CRONJOBS 参数配置

主要是对应的任务是否有参数

1.1、如果是无参数任务，则CRONJOBS中每个记录，有三个参数， 最后一个参数可选

• 第一个参数：任务执行时间设定

• 第二个参数：调用的Django对应的任务函数

• 第三个参数：是任务结果写入的文件

这里需要强调说明几个点：

4.1.1、任务结果写入的文件，如果是带路径的，需要提前确保路径存在且有权限

4.1.2、这里结果文件不能使用带动态时间的路径（一般是想通过时间来把每天的执行结果放到独立的文件中去）。

原因在于， Django crontab生产任务写入主机(linux)crontab的时候，会对任务整理生成一个hash值，如果第三部分参数发生变化，任务hash值 就发生变化，导致之后的任务无法执行

1.2、如果是有参数任务，则CRONJOBS中每个记录，有五个参数， 最后一个参数可选

• 第一个参数、第二个参数和第五个参数 与上面无参数任务一致

• 第三个参数：是任务方法的位置参数列表，默认值 []

• 第四个参数：是任务方法的关键字参数列表，默认值 {}

需要特别注意的就是，位置参数和关键字参数，另外一个不存在的时候也要保留位置，填写其对应的默认值

比如demo_cron_hello只有位置参数，没有关键字参数，那也要配置成

CRONJOBS = [
    ('*/1 * * * *', 'cronapp.cron.demo_cron_hello', ['James'], {}, '>> /tmp/django-crontab.log')
]
1
2
3

而不能配置成如下，忽略了关键字参数的位置，否则任务无法执行

CRONJOBS = [
    ('*/1 * * * *', 'cronapp.cron.demo_cron_hello', ['James'], '>> /tmp/django-crontab.log')
]
1
2
3

2、关于 Django crontab的命令使用

查看命令的用法

python manage.py crontab --help
usage: manage.py crontab [-h] [--version] [-v {0,1,2,3}] [--settings SETTINGS] [--pythonpath PYTHONPATH] [--traceback] [--no-color]
                         [--force-color] [--skip-checks]
                         {add,show,remove,run} [jobhash]

run this command to add, show or remove the jobs defined in CRONJOBS setting from/to crontab

positional arguments:
  {add,show,remove,run}
  jobhash
1
2
3
4
5
6
7
8
9
10

我们知道 show/remove/run 后面可以输入对应的任务 hash值来对具体的任务进行操作，但是实际操作的时候，添加与否都会针对所有任务操作。

用到的版本信息

Django                           4.0.6
django-crontab                   0.7.1
1
2

---

如果觉得文章对你有所帮忙，欢迎点赞收藏，或者可以关注个人公众号 全栈运维 哦，一起学习，一起健身~