Celery+django如何显示任务的执行进度条

elery单词中文的意思是“芹菜”，也不知道为什么人家喜欢给起个菜名，实际从功能上跟芹菜一点也扯不上关系，非得往上靠难道国外吃芹菜是在后面吃？大家都知道，如果我们在后端执行一个时间比较长的任务，比如超过10分钟任务都没执行完，这个时候如果让用户在前端页面等待，那是非常恐怖的事情，比如用户点了个执行数据库备份的功能脚本，后台马上执行不完，前端用户就会一直等待，直到备份任务全部完成，天知道什么时候能完成，如果这个时候下班了，你走不走？所以对一些比较耗时的任务，让用户在前端等待这个不可取，那怎么解决这些问题呢，这个呢，就用到我们刚才说的芹菜的功能了，celery是Python开发的分布式任务调度模块，你在前端执行的操作秒级返回给你结果，你还可以接着操作别的功能，至于你要执行的任务会由celery放到后端继续执行，等觉得差不多了，再看看最后执行结果，一切就是这么easy, 那这里还有一个细节问题，就是有的任务就是执行比较长，长的可能都让你怀疑是不是又出毛病了，当然对于专业开发人员，看看代码，看看数据库，也能分析出来，但对于其他只是使用平台的人就比较懵逼了，搞不好一顿骂娘，所以如果能把任务的进度按进度条的形式实时返给前端页面去展示，是不是突然有些高大上的感觉，那今天我们就来解决这个问题。

说着简单，但要实现这个功能还是比较复杂的，不过呢，在python的世界一切都变得的容易起来了，我们今天就得介绍下这个celery-progress，有了它的基础，让你实现这个功能就变得容易的多了，首先，我们先来安装：

pip install celery-progress

接下来在settings.py文件INSTALLED_APPS中添加：

'celery_progress',

在settings.py文件中设置celery参数：

# CELERY settingCELERY_BROKER_URL = 'redis://127.0.0.1:6379'CELERY_ACCEPT_CONTENT = ['application/json']CELERY_TASK_SERIALIZER = 'json'

新建app:

python manage.py startapp celerybar

在celerybar 目录里新建urls.py,内容如下：

from django.urls import path, include
from .views import index
urlpatterns = [    path('', index, name='index'),
]

在项目的urls.py文件中增加：

 path('', include('celerybar.urls')), path('celery-progress/', include('celery_progress.urls')),

执行数据库迁移:

python manage.py makemigrationspytohn manage.py migrate

回到celerybar目录下，新建一个文件tasks.py,内容如下：

from celery import  shared_taskfrom time import sleepfrom celery_progress.backend import Progre***ecorder
@shared_task(bind=True)def go_to_sleep(self, duration):    progress_recorder = Progre***ecorder(self)    for i in range(100):        sleep(duration)        progress_recorder.set_progress(i + 1, 100, f'On iteration {i}')    sleep(duration)    return 'Done'

在这里，我们做演示功能，任务非常简单，就是sleep多少秒，这里说一下progress_recorder.set_progress参数，第一个是当时的进度，第二个是总进度，这里是100，对应range的100，第三个参数是个描述，写完，我们打开views.py文件，内容如下：

from django.shortcuts import renderfrom .tasks import go_to_sleep
# Create your views here.
def index(request):    task = go_to_sleep.delay(1)    return render(request, 'celerybar/index.html', {'task_id': task.task_id})

这里导入tassk.py中的任务名称，进行调用，delay就是放到后台进行执行。到这里后台的操作就算是完了，接下来我们看下index.html文件中的内容：

{% load static %}<!DOCTYPE html><html><head>    <meta charset="UTF-8">    <title>celery-progess</title></head><body><div>  <div id='progress-bar' style="background-color: #68a9ef; width: 0%;">&nbsp;</div></div><div id="progress-bar-message">Waiting for progress to start...</div>

<script src="{% static 'celery_progress/celery_progress.js' %}"></script><script>    // vanilla JS version    document.addEventListener("DOMContentLoaded", function () {        var progressUrl = "{% url 'celery_progress:task_status' task_id %}";        CeleryProgressBar.initProgressBar(progressUrl);    });</script></body></html>

启动运行结果如下：

这样看起来是不是非常的爽了，再慢我们也不怕了，用户交互立马上了个档次，文章到此结束，感觉不错的小伙伴帮忙点亮再看和转发。

更多相关文章

随机推荐