在Django中使用Celery的配置方法

這幾天想要在練習的Django項目中使用celery來完成一個定時的功能，但是因為前輩們的教程大都年代久遠我在配置celery的過程中遇到了很多麻煩。因此我在配置完成后寫下這篇文章，來記錄如何配置，也希望可以幫助到其他人。

參考資料：First steps with Django

• 環境

Ubuntu 16.04

Python 3.5

Django 2.1

Celery 4.2

使用Python2的的過程也差不多，有一些不同，可以參考First steps with Django。

• 安裝過程

安裝django-celery

pip install celery
pip install django-celery

然后我們需要有一個broker來接收和發送隊列消息

sudo apt-get install rabbitmq-server

• 項目布局

-MediaApp

　　-accounts

　　　　-tasks.py

　　　　...

　　-MediaApp

　　　　-__init__.py

　　　　-celery.py

　　　　-settings.py

　　　　...

(...是無關的部分所以略去

• 配置過程

file:MediaApp/MediaApp/celery.py

import os
from celery import Celery

from django.conf import settings

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'MediaApp.settings')

#Celery的參數是你當前項目的名稱
app = Celery('MediaApp')

#這一步讓你可以在django的settings.py中配置celery
app.config_from_object('django.conf:settings')

#celery會自動在你注冊的app中尋找tasks.py，所以你的tasks.py必須放在各個app的目錄下並且不能隨意命名
app.autodiscover_tasks(lambda: settings.INSTALLED_APPS)

#這步暫時還不懂在做什么
@app.task(bind=True)
def test(self):
    print('Request:{0!r}'.format(self.request))

fle:MediaApp/MediaApp/__init.py__.py

from .celery import app as celery_app

__all__=('celery_app',)
#這一步會確保當Django項目運行時這個app總是被import

fle:MediaApp/MediaApp/settings.py

INSTALLED_APPS = [
    'djcelery',
    'accounts',
 　　#略去無關的部分
]

djcelery.setup_loader()
BROKER_URL = 'pyamqp://'
CELERY_RESULT_BACKEND = 'rpc://'

如果要使用其他的broker或者backend可以參考官方文檔

Broker Overview

Result Bakends

接下來添加一個小小的task來測試一下

fle:MediaApp/accounts/tasks.py

from celery import shared_task

@shared_task
def tset():
    print('success')

 

• 測試一下

先運行服務器

python manage.py migrate

python manage.py runserver

然后啟動worker

 celery -A MediaApp worker -c 4 --loglevel=info

在項目的目錄下打開終端

python manage.py shell

>>> from accounts.tasks import test
>>> test.delay()

如果你看到

<AsyncResult: a3ffd81b-5a6d-4734-bd82-7b5936a379d2>

在啟動woker的終端看到

[2018-09-05 14:55:48,937: INFO/MainProcess] Received task: accounts.tasks.test[d3d737d9-4945-464d-a1a2-fe8c4f9c0b13]
[2018-09-05 14:55:48,938: WARNING/Worker-1] success
[2018-09-05 14:55:48,946: INFO/MainProcess] Task accounts.tasks.test[d3d737d9-4945-464d-a1a2-fe8c4f9c0b13] succeeded in 0.008688600999448681s: None

 那么就是完成了。