Django+Celery實(shí)現(xiàn)定時(shí)任務(wù)的示例

更新時(shí)間：2021年06月23日 11:00:59 作者：YanceHH

Celery是一個(gè)基于python開發(fā)的分布式任務(wù)隊(duì)列，而做python WEB開發(fā)最為流行的框架莫屬Django，本示例使用主要依賴包Django+Celery實(shí)現(xiàn)定時(shí)任務(wù)，感興趣的朋友一起看看吧

一、前言

　　Celery是一個(gè)基于python開發(fā)的分布式任務(wù)隊(duì)列，而做python WEB開發(fā)最為流行的框架莫屬Django，但是Django的請(qǐng)求處理過程都是同步的無法實(shí)現(xiàn)異步任務(wù)，若要實(shí)現(xiàn)異步任務(wù)處理需要通過其他方式（前端的一般解決方案是ajax操作），而后臺(tái)Celery就是不錯(cuò)的選擇。倘若一個(gè)用戶在執(zhí)行某些操作需要等待很久才返回，這大大降低了網(wǎng)站的吞吐量。

另一方面，當(dāng)我們需要處理一些定時(shí)任務(wù)時(shí)Celery強(qiáng)大的生態(tài)環(huán)境也是他的優(yōu)勢(shì)。

在剛剛學(xué)習(xí)如何使用Celery時(shí)可能會(huì)覺得難以入手，我利用工作之余研究這些文檔前前后后也花了快一個(gè)周的樣子，目前已經(jīng)可以滿足我的需求，所以靜下心多寫多測(cè)試，加油。

二、配置使用

　　celery很容易集成到Django框架中，當(dāng)然如果想要實(shí)現(xiàn)定時(shí)任務(wù)的話還需要安裝django-celery-beta插件，后面會(huì)說明。需要注意的是Celery4.0只支持Django版本>=1.8的，如果是小于1.8版本需要使用Celery3.1。

本示例使用主要依賴包如下：

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

配置

　　新建立項(xiàng)目celery_demo,目錄結(jié)構(gòu)（每個(gè)app下多了個(gè)tasks文件，用于定義任務(wù)）：

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

在項(xiàng)目目錄celery_demo/celery_demo/目錄下新建celery.py:

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

# 設(shè)置django環(huán)境
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'celery_demo.settings')  
app = Celery('celery_demo')
#  使用CELERY_ 作為前綴，在settings中寫配置
app.config_from_object('django.conf:settings', namespace='CELERY') 
# 發(fā)現(xiàn)任務(wù)文件每個(gè)app下的task.py
app.autodiscover_tasks()

在celery_demo/celery_demo/__init__.py寫入：

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

在celery_demo/celery_demo/settings.py寫入：

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' # 結(jié)果序列化方案

進(jìn)入項(xiàng)目的celery_demo目錄啟動(dòng)worker：

celery worker -A taskproj -l debug

定義與觸發(fā)任務(wù)

任務(wù)定義在每個(gè)tasks文件中，app01／tasks.py：

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

視圖中觸發(fā)任務(wù)

from django.http import JsonResponse
from app01 import tasks

# Create your views here.

def index(request,*args,**kwargs):
    res=tasks.add.delay(1,3)
    #任務(wù)邏輯
    return JsonResponse({'status':'successful','task_id':res.task_id})

訪問http://127.0.0.1:8000/index

若想獲取任務(wù)結(jié)果，可以通過task_id使用AsyncResult獲取結(jié)果,還可以直接通過backend獲取：

擴(kuò)展

　　除了redis、rabbitmq能做結(jié)果存儲(chǔ)外，還可以使用Django的orm作為結(jié)果存儲(chǔ)，當(dāng)然需要安裝依賴插件，這樣的好處在于我們可以直接通過django的數(shù)據(jù)查看到任務(wù)狀態(tài)，同時(shí)為可以制定更多的操作，下面介紹如何使用orm作為結(jié)果存儲(chǔ)。

安裝

pip install django-celery-results

配置settings.py，注冊(cè)app

INSTALLED_APPS = (
    ...,
    'django_celery_results',
)

修改backend配置，將Redis改為django-db

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

CELERY_RESULT_BACKEND = 'django-db'  #使用django orm 作為結(jié)果存儲(chǔ)

修改數(shù)據(jù)庫(kù)

python3 manage.py migrate django_celery_results

此時(shí)會(huì)看到數(shù)據(jù)庫(kù)會(huì)多創(chuàng)建：

當(dāng)然你有時(shí)候需要對(duì)task表進(jìn)行操作，以下源碼的表結(jié)構(gòu)定義：

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)

三、Django中使用定時(shí)任務(wù)

　　如果想要在django中使用定時(shí)任務(wù)功能同樣是靠beat完成任務(wù)發(fā)送功能，當(dāng)在Django中使用定時(shí)任務(wù)時(shí)，需要安裝django-celery-beat插件。以下將介紹使用過程。

安裝配置

1.beat插件安裝

pip3 install django-celery-beat

2.注冊(cè)APP

INSTALLED_APPS = [
    ....   
    'django_celery_beat',
]

3.數(shù)據(jù)庫(kù)變更

python3 manage.py migrate django_celery_beat

4.分別啟動(dòng)woker和beta

celery -A proj beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler  #啟動(dòng)beta 調(diào)度器使用數(shù)據(jù)庫(kù)

celery worker -A taskproj -l info #啟動(dòng)woker

5.配置admin

在urls.py寫入：

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

6.創(chuàng)建用戶

python3 manage.py createsuperuser

7.登錄admin進(jìn)行管理（地址http://127.0.0.1:8000/admin）并且還可以看到我們上次使用orm作為結(jié)果存儲(chǔ)的表。

http://127.0.0.1:8000/admin/login/?next=/admin/

使用示例：

查看結(jié)果：

二次開發(fā)

　　django-celery-beat插件本質(zhì)上是對(duì)數(shù)據(jù)庫(kù)表變化檢查，一旦有數(shù)據(jù)庫(kù)表改變，調(diào)度器重新讀取任務(wù)進(jìn)行調(diào)度，所以如果想自己定制的任務(wù)頁(yè)面，只需要操作beat插件的四張表就可以了。當(dāng)然你還可以自己定義調(diào)度器，django-celery-beat插件已經(jīng)內(nèi)置了model，只需要進(jìn)行導(dǎo)入便可進(jìn)行orm操作，以下我用django reset api進(jìn)行示例：

settings.py

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',
]

urls.py

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'})),
]

views.py

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):
    """自定義分頁(yè)"""
    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

訪問http://127.0.0.1:8000/tasks如下：