Celery Progress 项目教程

1. 项目介绍

Celery Progress 是一个用于 Django/Celery 应用程序的进度条库。它提供了一种简单的方式来为你的后台任务添加进度条，而无需依赖其他外部库。这个项目的主要目标是简化在 Django 项目中使用 Celery 任务时的进度跟踪和显示。

主要特点：

• 依赖免费：无需额外依赖即可使用。
• 简单设置：只需几行代码即可集成到你的项目中。
• 高度可定制：支持多种自定义选项，包括进度条样式、消息显示等。

2. 项目快速启动

安装

首先，确保你已经在项目中正确设置了 Celery。然后，通过 pip 安装 celery-progress：

pip install celery-progress

配置

1. 添加到 INSTALLED_APPS：

   在你的 settings.py 文件中，将 celery_progress 添加到 INSTALLED_APPS：

   INSTALLED_APPS = [
       ...
       'celery_progress',
       ...
   ]
   

2. 配置 URL：

   在你的主 urls.py 文件中，添加以下 URL 配置：

   from django.urls import path, include
   
   urlpatterns = [
       ...
       path('celery-progress/', include('celery_progress.urls')),  # 添加这一行
       ...
   ]
   

记录进度

在你的 Celery 任务中，使用 ProgressRecorder 来记录进度：

from celery import shared_task
from celery_progress.backend import ProgressRecorder
import time

@shared_task(bind=True)
def my_task(self, seconds):
    progress_recorder = ProgressRecorder(self)
    for i in range(seconds):
        time.sleep(1)
        progress_recorder.set_progress(i + 1, seconds)
    return 'done'

显示进度

在你的视图中，获取任务 ID 并传递给模板：

from django.shortcuts import render
from .tasks import my_task

def progress_view(request):
    result = my_task.delay(10)
    return render(request, 'display_progress.html', context={'task_id': result.task_id})

在模板中，添加进度条的 HTML 和 JavaScript：

<!-- display_progress.html -->
<div class='progress-wrapper'>
    <div id='progress-bar' class='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>
    document.addEventListener("DOMContentLoaded", function () {
        var progressUrl = "{% url 'celery_progress:task_status' task_id %}";
        CeleryProgressBar.initProgressBar(progressUrl);
    });
</script>

3. 应用案例和最佳实践

应用案例

• 文件上传和处理：在文件上传后，使用 Celery 任务处理文件，并在前端显示处理进度。
• 长时间运行的任务：对于需要长时间运行的任务（如数据分析、图像处理等），使用进度条来告知用户任务的进展情况。

最佳实践

• 自定义进度条样式：通过修改 CSS 来自定义进度条的外观，使其与你的网站风格一致。
• 错误处理：在任务中添加错误处理逻辑，并在前端显示错误信息。
• WebSocket 支持：如果需要实时更新进度，可以启用 WebSocket 支持，以减少轮询的频率。

4. 典型生态项目

• Django：作为 Django 项目的一部分，Celery Progress 可以与 Django 无缝集成。
• Celery：Celery 是一个强大的分布式任务队列，Celery Progress 为其提供了进度跟踪功能。
• Django Channels：如果你需要实时更新进度，可以结合 Django Channels 使用 WebSocket 支持。

通过以上步骤，你可以轻松地在 Django/Celery 项目中集成进度条功能，提升用户体验。