Django+Celery实现定时任务的示例

目录

• 一、前言
• 二、配置使用
• 定义与触发任务
• 扩展
• 三、Django中使用定时任务
• 二次开发

celery==4.2.1
Django==1.11.7
django-celery-beat==1.4.0
django-celery-results==1.0.4
PyMySQL==0.9.2
redis==2.10.6

celery_demo
├── app01
│   ├── __init__.py
│   ├── apps.py
│   ├── migrations
│   │   └── __init__.py
│   ├── models.py
│   ├── tasks.py
│   └── views.py
├── manage.py
├── celery_demo
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
└── templates

#!/usr/bin/env python3
# -*- coding:utf-8 -*-
# Author:wd
from __future__ import absolute_import, unicode_literals
import os
from celery import Celery

# 设置django环境
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "celery_demo.settings")  
app = Celery("celery_demo")
#  使用CELERY_ 作为前缀，在settings中写配置
app.config_from_object("django.conf:settings", namespace="CELERY") 
# 发现任务文件每个app下的task.py
app.autodiscover_tasks() 

from __future__ import absolute_import, unicode_literals
from .celery import app as celery_app
__all__ = ["celery_app"]

CELERY_BROKER_URL = "redis://10.1.210.69:6379/0" # Broker配置，使用Redis作为消息中间件

CELERY_RESULT_BACKEND = "redis://10.1.210.69:6379/0" # BACKEND配置，这里使用redis

CELERY_RESULT_SERIALIZER = "json" # 结果序列化方案

celery worker -A taskproj -l debug

from __future__ import absolute_import, unicode_literals
from celery import shared_task
@shared_task
def add(x, y):
    return x + y
@shared_task
def mul(x, y):
    return x * y

from django.http import JsonResponse
from app01 import tasks

# Create your views here.

def index(request,*args,**kwargs):
    res=tasks.add.delay(1,3)
    #任务逻辑
    return JsonResponse({"status":"successful","task_id":res.task_id})

pip install django-celery-results

INSTALLED_APPS = (
    ...,
    "django_celery_results",
)

#CELERY_RESULT_BACKEND = "redis://10.1.210.69:6379/0" # BACKEND配置，这里使用redis

CELERY_RESULT_BACKEND = "django-db"  #使用django orm 作为结果存储

python3 manage.py migrate django_celery_results

class TaskResult(models.Model):
    """Task result/status."""

    task_id = models.CharField(_("task id"), max_length=255, unique=True)
    task_name = models.CharField(_("task name"), null=True, max_length=255)
    task_args = models.TextField(_("task arguments"), null=True)
    task_kwargs = models.TextField(_("task kwargs"), null=True)
    status = models.CharField(_("state"), max_length=50,
                              default=states.PENDING,
                              choices=TASK_STATE_CHOICES
                              )
    content_type = models.CharField(_("content type"), max_length=128)
    content_encoding = models.CharField(_("content encoding"), max_length=64)
    result = models.TextField(null=True, default=None, editable=False)
    date_done = models.DateTimeField(_("done at"), auto_now=True)
    traceback = models.TextField(_("traceback"), blank=True, null=True)
    hidden = models.BooleanField(editable=False, default=False, db_index=True)
    meta = models.TextField(null=True, default=None, editable=False)

    objects = managers.TaskResultManager()

    class Meta:
        """Table information."""

        ordering = ["-date_done"]

        verbose_name = _("task result")
        verbose_name_plural = _("task results")

    def as_dict(self):
        return {
            "task_id": self.task_id,
            "task_name": self.task_name,
            "task_args": self.task_args,
            "task_kwargs": self.task_kwargs,
            "status": self.status,
            "result": self.result,
            "date_done": self.date_done,
            "traceback": self.traceback,
            "meta": self.meta,
        }

    def __str__(self):
        return "<Task: {0.task_id} ({0.status})>".format(self)

pip3 install django-celery-beat

INSTALLED_APPS = [
    ....   
    "django_celery_beat",
]

python3 manage.py migrate django_celery_beat

celery -A proj beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler  #启动beta 调度器使用数据库

celery worker -A taskproj -l info #启动woker

# urls.py
from django.conf.urls import url
from django.contrib import admin
 
urlpatterns = [
    url(r"^admin/", admin.site.urls),
]

python3 manage.py createsuperuser 

INSTALLED_APPS = [
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "app01.apps.App01Config",
    "django_celery_results",
    "django_celery_beat",
    "rest_framework",
]

urlpatterns = [
    url(r"^admin/", admin.site.urls),
    url(r"^index$", views.index),
    url(r"^res$", views.get_res),
    url(r"^tasks$", views.TaskView.as_view({"get":"list"})),
]

from django_celery_beat.models import PeriodicTask  #倒入插件model
from rest_framework import serializers
from rest_framework import pagination
from rest_framework.viewsets import ModelViewSet
class Userserializer(serializers.ModelSerializer):
    class Meta:
        model = PeriodicTask
        fields = "__all__"

class Mypagination(pagination.PageNumberPagination):
    """自定义分页"""
    page_size=2
    page_query_param = "p"
    page_size_query_param="size"
    max_page_size=4

class TaskView(ModelViewSet):
    queryset = PeriodicTask.objects.all()
    serializer_class = Userserializer
    permission_classes = []
    pagination_class = Mypagination