django教程
python下有许多款不同的 web 框架。django是重量级选手中最有代表性的一位。许多成功的网站和app都基于django。
django是一个开放源代码的web应用框架,由python写成。
django遵守bsd版权,初次发布于2005年7月, 并于2008年9月发布了第一个正式版本1.0 。
django采用了mvc的软件设计模式,即模型m,视图v和控制器c。
一、前言
celery是一个基于python开发的分布式任务队列,如果不了解请阅读笔者上一篇博文celery入门与进阶,而做python web开发最为流行的框架莫属django,但是django的请求处理过程都是同步的无法实现异步任务,若要实现异步任务处理需要通过其他方式(前端的一般解决方案是ajax操作),而后台celery就是不错的选择。倘若一个用户在执行某些操作需要等待很久才返回,这大大降低了网站的吞吐量。下面将描述django的请求处理大致流程(图片来源于网络):
请求过程简单说明:浏览器发起请求-->请求处理-->请求经过中间件-->路由映射-->视图处理业务逻辑-->响应请求(template或response)
二、配置使用
celery很容易集成到django框架中,当然如果想要实现定时任务的话还需要安装django-celery-beta插件,后面会说明。需要注意的是celery4.0只支持django版本>=1.8的,如果是小于1.8版本需要使用celery3.1。
配置
新建立项目taskproj,目录结构(每个app下多了个tasks文件,用于定义任务):
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
taskproj ├── app01 │ ├── __init__.py │ ├── apps.py │ ├── migrations │ │ └── __init__.py │ ├── models.py │ ├── tasks.py │ └── views.py ├── manage.py ├── taskproj │ ├── __init__.py │ ├── settings.py │ ├── urls.py │ └── wsgi.py └── templates |
在项目目录taskproj/taskproj/目录下新建celery.py:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
#!/usr/bin/env python3 # -*- coding:utf-8 -*- # author:wd from __future__ import absolute_import, unicode_literals import os from celery import celery os.environ.setdefault( 'django_settings_module' , 'taskproj.settings' ) # 设置django环境 app = celery( 'taskproj' ) app.config_from_object( 'django.conf:settings' , namespace = 'celery' ) # 使用celery_ 作为前缀,在settings中写配置 app.autodiscover_tasks() # 发现任务文件每个app下的task.py taskproj / taskproj / __init__.py: from __future__ import absolute_import, unicode_literals from .celery import app as celery_app __all__ = [ 'celery_app' ] taskproj / taskproj / 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' # 结果序列化方案 |
进入项目的taskproj目录启动worker:
celery worker -a taskproj -l debug
定义与触发任务
任务定义在每个tasks文件中,app01/tasks.py:
1
2
3
4
5
6
7
8
|
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 |
视图中触发任务
1
2
3
4
5
6
7
|
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}) |
访问
若想获取任务结果,可以通过task_id使用asyncresult获取结果,还可以直接通过backend获取:
扩展
除了redis、rabbitmq能做结果存储外,还可以使用django的orm作为结果存储,当然需要安装依赖插件,这样的好处在于我们可以直接通过django的数据查看到任务状态,同时为可以制定更多的操作,下面介绍如何使用orm作为结果存储。
1.安装
pip install django-celery-results
2.配置settings.py,注册app
1
2
3
4
|
installed_apps = ( ..., 'django_celery_results' , ) |
4.修改backend配置,将redis改为django-db
1
2
|
#celery_result_backend = 'redis://10.1.210.69:6379/0' # backend配置,这里使用redis celery_result_backend = 'django-db' #使用django orm 作为结果存储 |
5.修改数据库
1
|
python3 manage.py migrate django_celery_results |
此时会看到数据库会多创建:
当然你有时候需要对task表进行操作,以下源码的表结构定义:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
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
1
2
3
4
|
installed_apps = [ .... 'django_celery_beat' , ] |
3.数据库变更
1
|
python3 manage.py migrate django_celery_beat |
4.分别启动woker和beta
1
2
|
celery - a proj beat - l info - - scheduler django_celery_beat.schedulers:databasescheduler #启动beta 调度器使用数据库 celery worker - a taskproj - l info #启动woker |
5.配置admin
urls.py
1
2
3
4
5
6
|
# urls.py from django.conf.urls import url from django.contrib import admin urlpatterns = [ url(r '^admin/' , admin.site.urls), ] |
6.创建用户
1
|
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
1
2
3
4
5
6
7
8
9
10
11
12
|
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
1
2
3
4
5
6
|
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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
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 |
访问http://127.0.0.1:8000/tasks如下:
总结
以上所述是小编给大家介绍的django中使用celery的教程详解,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对服务器之家网站的支持!
原文链接:https://www.cnblogs.com/wdliu/archive/2018/08/24/9530219.html