Django 使用 Ajax 和 celery task

在本文中，我们将介绍如何在Django中使用Ajax与celery任务进行交互。

1. 为什么使用Ajax与celery task

Django是一个强大的Web开发框架，而Ajax是一种前端开发技术，可以使用户与后台进行异步通信。而celery则是一个常用的分布式任务队列，用于处理耗时的后台任务。结合使用Ajax与celery task，可以实现在后台处理任务并返回结果，而不需要用户等待页面加载。

使用Ajax与celery task的优点包括：
– 用户可以在任务执行期间继续浏览其他页面，提升用户体验；
– 后台任务可以在异步进行，不会阻塞用户操作；
– 可以处理耗时的任务，如发送电子邮件、生成报表等；
– 可以以一种直观的方式向用户显示任务执行进度。

2. 配置celery

首先，我们需要配置Django与celery的结合。在Django项目的settings.py文件中，添加以下代码：

CELERY_BROKER_URL = 'redis://localhost:6379/0'
CELERY_RESULT_BACKEND = 'redis://localhost:6379/0'

CELERY_ACCEPT_CONTENT = ['json']
CELERY_TASK_SERIALIZER = 'json'
CELERY_RESULT_SERIALIZER = 'json'

INSTALLED_APPS += [
    'django_celery_results',
]

在这里，我们使用Redis作为消息代理和结果后端。确保已经安装了Redis并且运行在默认端口上。还需要在项目的urls.py文件中添加以下代码：

from django_celery_results.views import (
    TaskResultView, TaskDetailView, TaskListView
)

urlpatterns += [
    path('celery-results/', include([
        path('<task_id>/', include([
            path('', TaskDetailView.as_view(), name='task_result'),
            path('result/', TaskResultView.as_view(), name='task_result'),
        ])),
        path('', TaskListView.as_view(), name='task_list'),
    ])),
]

这些配置将帮助我们处理和显示celery任务的结果。

3. 使用Ajax与celery task进行交互

接下来，我们将使用Ajax来调用celery任务并获取结果。首先，我们需要定义一个执行耗时任务的函数。假设我们要编写一个发送电子邮件的任务。在Django的某个app的tasks.py文件中，添加以下代码：

from celery import shared_task

@shared_task
def send_email_task(email):
    # 发送邮件的代码
    # ...
    return '邮件已发送至：' + email

在我们的视图函数中，我们可以使用Ajax来调用这个celery任务并获取结果。在Django的某个app的views.py文件中，添加以下代码：

from django.http import JsonResponse
from .tasks import send_email_task

def send_email(request):
    if request.method == 'POST':
        email = request.POST.get('email')
        task = send_email_task.delay(email)
        return JsonResponse({'task_id': task.id})

这个视图函数接收用户通过POST请求传递的电子邮件地址，然后调用send_email_task.delay(email)来异步执行任务，并返回任务的ID。

在前端的JavaScript中，我们可以使用Ajax来获取任务的执行结果。假设我们的页面中有一个表单，在用户填写完电子邮件地址后，通过Ajax发送POST请求。在返回的JSON数据中，我们可以获取到任务的ID。然后，我们可以使用另一个Ajax请求来获取任务的执行结果。以下是一个简单的示例：

$(document).ready(function() {
    $('#email-form').submit(function(event) {
        event.preventDefault();
        var email = $('#email-input').val();
        $.ajax({
            url: '/send-email/',
            type: 'POST',
            data: {'email': email},
            success: function(response) {
                var task_id = response.task_id;
                var checkResultInterval = setInterval(function() {
                    $.ajax({
                        url: '/celery-results/' + task_id + '/result/',
                        type: 'GET',
                        success: function(response) {
                            if (response.state === 'SUCCESS') {
                                clearInterval(checkResultInterval);
                                $('#result').text(response.result);
                            }
                        },
                        error: function(xhr, status, error) {
                            console.log(error);
                        }
                    });
                }, 1000);  // 每秒钟轮询一次任务结果
            },
            error: function(xhr, status, error) {
                console.log(error);
            }
        });
    });
});

在上述示例中，我们首先通过Ajax请求将电子邮件地址发送给服务器，服务器会返回任务的ID。然后，我们每秒钟通过Ajax请求来获取任务的执行结果，直到任务的执行状态为成功（SUCCESS）。最后，我们将任务的执行结果显示在页面上。