django-crontab 和 django-cron
有时候需要django在后台不断的执行一个任务,简单的可以通过中间件来实现,但是中间件是根据请求触发的。如果需要定时执行任务,则需要使用到一些插件。
django-crontab 和 django-cron 是常用的用于处理定时任务的插件库,两者区别在于:
- django-cron 完全运行在 django 服务器内部的库,它通过定期检查当前时间与定义的任务计划是否匹配来执行任务。它不依赖于系统级的cron守护进程,而是基于 django 自身的请求周期触发任务检查
- django-crontab 是利用操作系统的 cron 守护进程来调度任务。用户在 django 项目中定义好任务后, django-crontab 会将这些任务写入到系统的 crontab 文件中。当 cron 守护进程执行任务时,实际上会调用 django 管理命令或 url 来执行特定的操作。
django-crontab
使用 django-crontab 需要以下步骤:
- 安装 django-crontab 模块
- 在 settings.py 中注册应用
- 创建定时执行的任务(可以是自定义的函数或自定义的命令)
- 在 settings.py 中配置执行任务
- 执行任务
需要注意的是 django-crontab 只能运行在 linux 环境中,且需要使用到 root 权限。另外需要启动 cron 服务
# 查看 cron 服务状态
service cron status
# 开启 cron 服务
service cron start
# 查看定时任务
crontab -l
# 添加定时任务
crontab -e
安装 django-crontab
pip install django-crontab
注册应用
在 settings.py 中注册 django-crontab 应用
INSTALLED_APPS = [
...
'django_crontab',
]
创建任务
创建定时执行的任务
创建定时执行函数
在任意 app 下均可创建定时执行函数
# app1/task.py
def scheduleTask(): # 定时执行函数
from time import strftime, localtime
print(strftime("%Y-%m-%d %H:%M:%S", localtime()), end='')
print("执行了scheduleTask函数")
def scheduleTaskWithPara(in_str): # 带参数的定时执行函数
import datetime
now_time = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')
print(f"在 {
now_time} 执行了定时函数,输入信息{
in_str}")
创建定时执行命令
在任意 app 下创建 management 模块(含有 __init__.py
文件),并在此模块下创建 commands 模块。在 commands 模块下创建具体的执行脚本文件。例如:
# app1/management/commands/mycommand1.py
from django.core.management.base import BaseCommand, CommandError
from time import strftime, localtime
class Command(BaseCommand):
help = '这是第一个command测试指令'
# 为handle中添加参数解析,
def add_arguments(self, parser):
parser.add_argument(
'-p', # 设置参数的时候 前边携带
'--param',
action='store',
dest='param', # 自定义传入的参数键名ss
default='close', # 默认的键值
help='name of author.',
)
def handle(self,