Django集成django-crontab实现服务端定时任务详解

安装与配置

安装django-crontab库。

 pip install django-crontab 

在Django项目中使用该库，需在配置文件中注册应用。

修改项目的settings.py文件。

INSTALLED_APPS = (
  'django.contrib.admin',
  'django.contrib.auth',
  'django.contrib.contenttypes',
  'django.contrib.sessions',
  'django.contrib.messages',
  'django.contrib.staticfiles',
  'django_crontab'
)

在INSTALLED_APPS中添加'django_crontab'以启用应用。

CRONJOBS=(
  # 每一分钟执行一次你的定时函数
  ('*/ * * * *', 'appname.cron.test'),
  # 定时函数输出的内容到指定文件（如果该路径或文件不存在将会自动创建）
  ('0 0 1 * *', 'app名.定时函数所在文件名.定时函数名', '>输出文件路径和名称'),
  # 在12点10分执行命令
  ('10 12 * * *', 'django.core.management.call_command', ['要执行的命令']),
)

参考官方提供的示例代码进行配置。

CRONJOBS = [
  ('*/5 * * * *', 'myapp.cron.my_scheduled_job'),

  # format 1
  ('0  0 1 * *', 'myapp.cron.my_scheduled_job', '>> /tmp/scheduled_job.log'),

  # format 2
  ('0  0 1 * *', 'myapp.cron.other_scheduled_job', ['myapp']),
  ('0  0 * * 0', 'django.core.management.call_command', ['dumpdata', 'auth'], {'indent': 4}, '> /home/john/backups/last_sunday_auth_backup.json'),
]

参数详解

上述示例中各参数的具体含义说明如下：

• 参数1：Cron定时表达式，例如'47 11 * * *'表示每天11时47分执行任务。
• 参数2：目标方法的Python模块路径；若需执行Django管理命令，则填写'django.core.management.call_command'。
• 参数3：方法的位置参数列表，默认值为[]；若执行Django管理命令，此处填写所需命令名称，例如在polls应用中定义的closepoll。
• 参数4：方法的关键字参数字典，默认值为{}。
• 参数5：执行日志的存放位置，即将输出重定向到指定文件，默认为空字符串。

其他配置项

其余相关配置参数的说明如下：

• CRONTAB_LOCK_JOBS：控制任务锁定的配置。
• CRONTAB_EXECUTABLE：指定可执行文件路径。
• CRONTAB_DJANGO_PROJECT_NAME：Django项目名称。
• CRONTAB_DJANGO_MANAGE_PATH：manage.py的路径。
• CRONTAB_DJANGO_SETTINGS_MODULE：Django设置模块路径。
• CRONTAB_PYTHON_EXECUTABLE：Python解释器路径。
• CRONTAB_COMMAND_PREFIX：命令前缀。
• CRONTAB_COMMAND_SUFFIX：命令后缀。
• CRONTAB_COMMENT：注释信息。
• 具体使用方法可参考官方文档，其中包含详细说明。

应用开发与命令操作

在应用目录下（与views.py同级）新建cron.py文件，文件名可自定义。

def test():
  print('django_crontab test')

常用操作命令如下：

• python manage.py crontab add：添加定时任务。
• python manage.py crontab remove：移除定时任务。
• python manage.py crontab show：查看当前定时任务列表。

Cron表达式语法

扩展知识：Cron表达式基础。

前5个星号分别代表不同的时间单位。

M代表分钟（0-59），H代表小时（0-23），D代表天（1-31），m代表月（1-12），d代表星期（0-6，其中0表示星期天）。

Cron表达式中常用的特殊符号。

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

示例如下：

0 14 * * 1-5 周一到周五每天下午两点触发任务
0 10 * * 0,6 周六、周天早上十点触发任务
*/5 9-10 * * 1-5 周一到周五九点到十点每五分钟触发任务

日志打印配置示例。

 ('*/ * * * *', 'appname.cron.test','> appname.txt'),

参考文档链接。

django-crontab的GitHub地址。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持本站。