Django集成Celery实现定时任务与异步处理的完整指南
本文详细记录如何在Django项目中整合Celery与django-celery,利用Redis作为消息中间件实现异步与定时任务。内容涵盖环境配置、Celery实例创建、Worker与Beat进程启动,以及通过Django Admin界面管理定时任务的完整流程,旨在帮助开发者构建可靠的后台任务调度系统。
Django集成Celery概述
本文旨在解决在Django框架下实现计划任务的需求,例如定时轮换值班人员姓名或定期执行脚本。经过多次尝试与排查,最终成功部署了该方案。由于作者英语能力有限,且本文仅侧重于实现类似crontab的功能,未必完全准确或深入,建议英语较好或有深入学习需求的读者直接参考官方文档。
希望深入学习的读者可参考 http://docs.jinkan.org/docs/celery/ 。
首先简要介绍Celery。Celery是一个强大的分布式任务队列系统,允许任务执行完全脱离主程序,甚至分发到其他主机运行。它通常用于处理异步任务(async task)和定时任务(crontab)。其架构组成如下图所示。

从架构图中可以看出,Celery主要包含以下几个核心模块:
任务模块 Task
该模块包含异步任务和定时任务。异步任务通常在业务逻辑中被触发并发送至任务队列,而定时任务则由Celery Beat进程周期性地将任务发送至任务队列。
消息中间件 Broker
Broker即任务调度队列,负责接收任务生产者发送的消息(即任务)并将其存入队列。Celery本身不提供队列服务,官方推荐使用RabbitMQ或Redis等作为中间件。
任务执行单元 Worker
Worker是执行任务的处理单元,它实时监控消息队列,获取队列中调度的任务并执行它。
任务结果存储 Backend
Backend用于存储任务的执行结果,以供后续查询。与消息中间件类似,存储后端也可使用RabbitMQ、Redis或MongoDB等。
异步任务
使用Celery实现异步任务主要包含以下三个步骤:
创建一个Celery实例
启动Celery Worker
应用程序调用异步任务
环境准备与快速入门
一、快速入门
本地运行环境如下:
OS:centOS6.5 django-1.9 python-2.7.11 celery==3.1.20 django-celery
Python、pip及Django的相关安装此处不再赘述,可直接参考相关教程;
pip install django==1.9 安装django
pip install celery==3.1.20 安装celery
pip install django-celery 安装django-celery
若安装过程中出现失败,请自行解决所需的依赖环境,例如mysql-python等;
本文使用Redis作为消息中间件,需先安装Redis:
略
Django项目配置与Celery集成
二、创建Django项目开始测试
1、创建Django工程,命名为djtest
django-admin.py startproject djtest1
2、创建App,命名为apps
cd djtest
python manage.py startapp apps1
3、创建完成后,Django目录结构如下:
djtest1
├── apps1
│ ├── admin.py
│ ├── apps.py
│ ├── init.py
│ ├── migrations
│ │ └── init.py
│ ├── models.py
│ ├── tests.py
│ └── views.py
├── djtest1
│ ├── init.py
│ ├── init.pyc
│ ├── settings.py
│ ├── settings.pyc
│ ├── urls.py
│ └── wsgi.py
└── manage.py
4、修改setting.py Django配置文件,增加如下配置:
import djcelery ###
djcelery.setup_loader() ###
CELERY_TIMEZONE='Asia/Shanghai' #并没有北京时区,与下面TIME_ZONE应该一致
BROKER_URL='redis://192.168.217.77:16379/8' #任何可用的redis都可以,不一定要在django server运行的主机上
CELERYBEAT_SCHEDULER = 'djcelery.schedulers.DatabaseScheduler' ###
INSTALLED_APPS = (
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'djcelery', ### 加入djcelery应用
'apps1', ### 加入新创建的apps1
)
TIME_ZONE='Asia/Shanghai' ###
在文件开头增加上述配置,需根据实际环境配置Redis的地址和端口。时区必须设置为 Asia/Shanghai ,否则时间不准确会影响定时任务的运行。
上述代码首先导出djcelery模块,并调用setup_loader方法加载相关配置。注意配置时区,否则默认使用UTC时间会比东八区慢8个小时。其中INSTALLED_APPS末尾添加两项,分别表示添加celery服务和自定义的apps服务。
5、编写celery文件:djtest/djtest/celery.py
#!/bin/python
from __future__ import absolute_import
import os
from celery import Celery
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'djtest1.settings')
#Specifying the settings here means the celery command line program will know where your Django project is.
#This statement must always appear before the app instance is created, which is what we do next:
from django.conf import settings
app = Celery('djtest1')
app.config_from_object('django.conf:settings')
#This means that you don't have to use multiple configuration files, and instead configure Celery directly from the Django settings.
#You can pass the object directly here, but using a string is better since then the worker doesn't have to serialize the object.
app.autodiscover_tasks(lambda: settings.INSTALLED_APPS)
#With the line above Celery will automatically discover tasks in reusable apps if you define all tasks in a separate tasks.py module.
#The tasks.py should be in dir which is added to INSTALLED_APP in settings.py.
#So you do not have to manually add the individual modules to the CELERY_IMPORT in settings.py.
@app.task(bind=True)
def debug_task(self):
print('Request: {0!r}'.format(self.request)) #dumps its own request information
6、修改djtest1/djtest1/ init .py
#!/bin/python
from __future__ import absolute_import
# This will make sure the app is always imported when
# Django starts so that shared_task will use this app.
from .celery import app as celery_app
7、接下来编写希望Django完成的App,本文中需编写在INSTALLED_APPS中注册的apps。在celery.py中设定了对settings.py中INSTALLED_APPS做autodiscover_tasks,本文希望apps中能够接受这样的目录组织:所有的App都可以放到apps下面,而且每个App都有独立的目录,就和上面的app1、app2一样,每个App各自有各自的 init .py和tasks.py(注意,每个App都需要 init .py文件,可以是空白的)。但是这样的结构组织在启动时会报错说module apps找不到。然后在apps下增加了一个 init .py文件,这时报错没了,但是apps下每个App的tasks.py中的任务函数还是无法被Django和Celery Worker找到。
**然后尝试了在apps1下面写一个__init__.py(空白)和task.py,所有的task function都写到tasks.py中,如下**
from __future__ import absolute_import
from celery import task
from celery import shared_task
#from celery.task import tasks
#from celery.task import Task
@task()
#@shared_task
def add(x, y):
print "%d + %d = %d"%(x,y,x+y)
return x+y
#class AddClass(Task):
# def run(x,y):
# print "%d + %d = %d"%(x,y,x+y)
# return x+y
#tasks.register(AddClass)
@shared_task
def mul(x, y):
print "%d * %d = %d"%(x,y,x*y)
return x*y
@shared_task
def sub(x, y):
print "%d - %d = %d"%(x,y,x-y)
return x-y
8、同步数据库
python manage.py makemigrations
python manage.py migrate
9、创建超级用户
python manage.py createsuperuser
Username (leave blank to use 'work'): admin
Email address: yyc@taihe.com
Password:
Password (again):
Superuser created successfully.
10、启动Django-Web、启动Celery Beat、启动Celery Worker进程
python manage.py runserver 0.0.0.0:8001#启动django的应用,可以动态的使用django-admin来管理任务
python manage.py celery beat #应该是用来监控任务变化的
python manage.py celery worker -c 6 -l debug #任务执行进程,worker进程
任务管理与执行监控
11、通过Django-Admin添加已注册的任务,并查看输出是否正常。
http://192.168.217.77:8001/admin/ 输入密码登录
(1)
登录后添加任务:

点击红线标记的列表,通过add来添加;
(2)

点击进入以后,可以看到已经存在的任务,点击添加即可;
(3)

按照提示,输入name,通过task(registered) 选择已经注册的函数服务。
选择运行模式,阻塞模式,为多长时间间隔运行一次,或者crontab形式运行。
点击Arguments(show),添加需要传入注册函数的参数。
(4)

实例,具体名称以及运行时间以及传入参数等。
(5)

保存之后,可以查看到列表。
(6)在 python manage.py celery worker -c 6 -l debug 启动的窗口可以看到如下的运行过程,证明已经生效。

第一行红色标记,可以看到注册函数被调用,第二行红色标记,可以看到函数的返回值。
到此已经基本完成。在实际运用中,我们只需要修改或者添加到tasks.py文件里一些函数,让他注册到里边。我们从前台Django-Web写入任务,可以使其动态加载到任务。并且把正确的参数传过去,就可以正常执行。完成我们所想要的通过这个Django-Celery工具制作定期的备份、统一管理的Crontab平台等。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持本站。
本站声明
本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。













