Django实现定时任务

Lucas在澳洲

已于 2024-10-24 19:46:33 修改

阅读量1.4k

点赞数

分类专栏：后端Django Python 文章标签： django python 后端 1024程序员节

于 2023-06-19 20:26:02 首次发布

本文链接：https://blog.youkuaiyun.com/weixin_50153843/article/details/131294658

版权

Python 同时被 2 个专栏收录

69 篇文章

订阅专栏

后端Django

26 篇文章

订阅专栏

实现定时任务是很多Web应用程序中常见的需求，尤其是当我们需要执行一些定期维护、数据更新或任务调度时。在Django中，结合Celery和Django-crontab可以轻松实现这一功能。以下是详细的步骤，帮助你在Django项目中实现定时任务。

一、环境准备

在开始之前，确保你已经有一个Django项目。如果没有，可以使用以下命令创建一个新的Django项目：

django-admin startproject myproject
cd myproject

然后创建一个新的应用（假设为myapp）：

python manage.py startapp myapp

二、安装Celery和Django-crontab

接下来，我们需要安装Celery和Django-crontab。这两个库分别用于处理异步任务和定时任务调度。使用以下命令进行安装：

pip install celery django-crontab redis

我们使用Redis作为Celery的消息代理（Broker），因此需要确保你的系统中已安装并运行Redis。

三、配置Django项目

1. 修改`settings.py`

打开Django项目中的settings.py文件，添加以下配置：

# settings.py

INSTALLED_APPS = [
    # ...
    'django_crontab',
    'myapp',  # 确保添加你的应用
]

# Celery配置
CELERY_BROKER_URL = 'redis://localhost:6379/0'  # 配置Celery的Broker
CELERY_RESULT_BACKEND = 'redis://localhost:6379/0'  # 配置Celery的结果后端

# Django-crontab配置
CRONJOBS = [
    # 每小时的0分钟执行write_article任务
    ('0 * * * *', 'myapp.tasks.write_article'),  # 注意替换为你的应用名称
]

在这里，我们添加了django_crontab到INSTALLED_APPS中，配置了Celery的Broker和结果后端，同时定义了定时任务。

2. 创建`celery.py`

在Django项目的根目录（与settings.py同级）下创建一个名为celery.py的文件，并添加以下代码：

# celery.py

import os
from celery import Celery

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'myproject.settings')

app = Celery('myproject')
app.config_from_object('django.conf:settings', namespace='CELERY')
app.autodiscover_tasks()

3. 修改`init.py`

在项目根目录下的__init__.py中，确保Celery应用在启动时被加载。添加以下代码：

# __init__.py

from .celery import app as celery_app

__all__ = ('celery_app',)

四、创建Celery任务

在你的Django应用中（例如myapp），创建一个名为tasks.py的文件，并添加以下代码：

# tasks.py

from celery import shared_task
import datetime

@shared_task
def write_article():
    # 在这里编写你的写文章逻辑
    # 示例：记录当前时间到日志
    now = datetime.datetime.now()
    print(f'Article written at {now}')

在这个例子中，我们创建了一个名为write_article的Celery任务，它将在每次调用时记录当前时间。你可以在这里添加你自己的逻辑，例如创建新的文章并将其保存到数据库中。

五、配置定时任务

1. 在`settings.py`中添加Cron配置

我们已经在settings.py中添加了定时任务配置。CRONJOBS部分定义了定时任务的执行时间，这里我们设置为每小时的0分钟执行write_article任务。

2. 启动Celery Worker

在终端中，启动Celery worker，以便它可以处理任务：

celery -A myproject worker -l info

这个命令会启动Celery worker，并输出相关的日志信息。

3. 启动Django-crontab

现在，我们需要确保Django-crontab能够识别并运行我们的定时任务。在终端中运行以下命令来添加Cron作业：

python manage.py crontab add

要查看当前的Cron作业，可以使用以下命令：

python manage.py crontab show

六、测试定时任务

一切配置完成后，你可以等待下一个小时的0分钟，或者手动触发write_article任务进行测试。你可以在Celery worker的日志中看到输出。

1. 手动触发任务（可选）

如果你想立即测试write_article任务，可以在Django shell中手动调用：

python manage.py shell

然后在shell中执行：

from myapp.tasks import write_article
write_article.delay()  # 使用delay()异步调用任务

七、查看结果和日志

你可以在Celery worker的终端中查看日志输出。定时任务执行成功后，将会在日志中看到记录的时间信息。

八、扩展功能

1. 处理失败任务

可以在Celery任务中实现失败重试机制。例如：

@shared_task(bind=True, max_retries=3)
def write_article(self):
    try:
        # 你的逻辑代码
    except Exception as exc:
        raise self.retry(exc=exc, countdown=60)  # 60秒后重试