Django+Celery實現定時任務的示例
Celery是一個基于python開發的分布式任務隊列,而做python WEB開發最為流行的框架莫屬Django,但是Django的請求處理過程都是同步的無法實現異步任務,若要實現異步任務處理需要通過其他方式(前端的一般解決方案是ajax操作),而后臺Celery就是不錯的選擇。倘若一個用戶在執行某些操作需要等待很久才返回,這大大降低了網站的吞吐量。
另一方面,當我們需要處理一些定時任務時Celery強大的生態環境也是他的優勢。
在剛剛學習如何使用Celery時可能會覺得難以入手,我利用工作之余研究這些文檔前前后后也花了快一個周的樣子,目前已經可以滿足我的需求,所以靜下心多寫多測試,加油。
celery很容易集成到Django框架中,當然如果想要實現定時任務的話還需要安裝django-celery-beta插件,后面會說明。需要注意的是Celery4.0只支持Django版本>=1.8的,如果是小于1.8版本需要使用Celery3.1。
本示例使用主要依賴包如下:
celery==4.2.1Django==1.11.7django-celery-beat==1.4.0django-celery-results==1.0.4PyMySQL==0.9.2redis==2.10.6
配置
新建立項目celery_demo,目錄結構(每個app下多了個tasks文件,用于定義任務):
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
在項目目錄celery_demo/celery_demo/目錄下新建celery.py:
#!/usr/bin/env python3# -*- coding:utf-8 -*-# Author:wdfrom __future__ import absolute_import, unicode_literalsimport osfrom 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.pyapp.autodiscover_tasks()
在celery_demo/celery_demo/__init__.py寫入:
from __future__ import absolute_import, unicode_literalsfrom .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配置,這里使用redisCELERY_RESULT_SERIALIZER = ’json’ # 結果序列化方案
進入項目的celery_demo目錄啟動worker:
celery worker -A taskproj -l debug定義與觸發任務
任務定義在每個tasks文件中,app01/tasks.py:
from __future__ import absolute_import, unicode_literalsfrom celery import shared_task@shared_taskdef add(x, y): return x + y@shared_taskdef mul(x, y): return x * y
視圖中觸發任務
from django.http import JsonResponsefrom 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})
訪問http://127.0.0.1:8000/index
若想獲取任務結果,可以通過task_id使用AsyncResult獲取結果,還可以直接通過backend獲取:
除了redis、rabbitmq能做結果存儲外,還可以使用Django的orm作為結果存儲,當然需要安裝依賴插件,這樣的好處在于我們可以直接通過django的數據查看到任務狀態,同時為可以制定更多的操作,下面介紹如何使用orm作為結果存儲。
安裝
pip install django-celery-results
配置settings.py,注冊app
INSTALLED_APPS = ( ..., ’django_celery_results’,)
修改backend配置,將Redis改為django-db
#CELERY_RESULT_BACKEND = ’redis://10.1.210.69:6379/0’ # BACKEND配置,這里使用redisCELERY_RESULT_BACKEND = ’django-db’ #使用django orm 作為結果存儲
修改數據庫
python3 manage.py migrate django_celery_results
此時會看到數據庫會多創建:
當然你有時候需要對task表進行操作,以下源碼的表結構定義:
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中使用定時任務
如果想要在django中使用定時任務功能同樣是靠beat完成任務發送功能,當在Django中使用定時任務時,需要安裝django-celery-beat插件。以下將介紹使用過程。
安裝配置
1.beat插件安裝
pip3 install django-celery-beat
2.注冊APP
INSTALLED_APPS = [ .... ’django_celery_beat’,]
3.數據庫變更
python3 manage.py migrate django_celery_beat
4.分別啟動woker和beta
celery -A proj beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler #啟動beta 調度器使用數據庫celery worker -A taskproj -l info #啟動woker
5.配置admin
在urls.py寫入:
# urls.pyfrom django.conf.urls import urlfrom django.contrib import admin urlpatterns = [ url(r’^admin/’, admin.site.urls),]
6.創建用戶
python3 manage.py createsuperuser
7.登錄admin進行管理(地址http://127.0.0.1:8000/admin)并且還可以看到我們上次使用orm作為結果存儲的表。
http://127.0.0.1:8000/admin/login/?next=/admin/
使用示例:
查看結果:
django-celery-beat插件本質上是對數據庫表變化檢查,一旦有數據庫表改變,調度器重新讀取任務進行調度,所以如果想自己定制的任務頁面,只需要操作beat插件的四張表就可以了。當然你還可以自己定義調度器,django-celery-beat插件已經內置了model,只需要進行導入便可進行orm操作,以下我用django reset api進行示例:
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 #倒入插件modelfrom rest_framework import serializersfrom rest_framework import paginationfrom rest_framework.viewsets import ModelViewSetclass Userserializer(serializers.ModelSerializer): class Meta:model = PeriodicTaskfields = ’__all__’class Mypagination(pagination.PageNumberPagination): '''自定義分頁''' page_size=2 page_query_param = ’p’ page_size_query_param=’size’ max_page_size=4class TaskView(ModelViewSet): queryset = PeriodicTask.objects.all() serializer_class = Userserializer permission_classes = [] pagination_class = Mypagination
訪問http://127.0.0.1:8000/tasks如下:
參考資料:
W-D:https://www.cnblogs.com/wdliu/p/9530219.html
還在琢磨:https://blog.csdn.net/mbl114/article/details/78047175
Celery文檔:http://docs.celeryproject.org/en/latest/
以上就是Django+Celery實現定時任務的示例的詳細內容,更多關于Django Celery定時任務的資料請關注好吧啦網其它相關文章!
相關文章: