Django-celery分布式任務

昨天一個很好的面試官問我你在python中怎么實現定時任務呢？我沒回答好，我問了下原來有個叫celery的東西，感覺挺好用的

Celery 是一個 基於python開發的分布式異步消息任務隊列，通過它可以輕松的實現任務的異步處理， 如果你的業務場景中需要用到異步任務，就可以考慮使用celery， 舉幾個實例場景中可用的例子:

1、你想對100台機器執行一條批量命令，可能會花很長時間 ，但你不想讓你的程序等着結果返回，而是給你返回 一個任務ID,你過一段時間只需要拿着這個任務id就可以拿到任務執行結果， 在任務執行ing進行時，你可以繼續做其它的事情。 
2、你想做一個定時任務，比如每天檢測一下你們所有客戶的資料，如果發現今天 是客戶的生日，就給他發個短信祝福

Celery 在執行任務時需要通過一個消息中間件來接收和發送任務消息，以及存儲任務結果， 一般使用rabbitMQ or Redis

celery的一些優點：

簡單：一單熟悉了celery的工作流程后，配置和使用還是比較簡單的
高可用：當任務執行失敗或執行過程中發生連接中斷，celery 會自動嘗試重新執行任務
快速：一個單進程的celery每分鍾可處理上百萬個任務
靈活： 幾乎celery的各個組件都可以被擴展及自定制

celery工作流程：

celery的安裝和使用

Celery的默認broker是RabbitMQ, 僅需配置一行就可以
broker_url = 'amqp://guest:guest@localhost:5672//'

配置

配置很簡單，只需配置Redis數據庫的位置：
app.conf.broker_url = 'redis://localhost:6379/0'
網址的url可以這樣寫
redis://:password@hostname:port/db_number
該方案之后的所有字段都是可選的，並將使用數據庫0默認為端口6379上的本地主機
如果想獲取每個任務的執行結果，還需要配置一下把任務結果存在哪
如果還想以redis存儲任務的狀態和返回值，則應配置以下設置： 
app.conf.result_backend = 'redis://localhost:6379/0'

現在可以使用celery了

創建一個celery application 用來定義你的任務列表

創建一個任務文件就叫tasks.py吧

from celery import Celery
 
app = Celery('tasks',
             broker='redis://localhost',
             backend='redis://localhost')
 
@app.task
def add(x,y):
    print("running...",x,y)
    return x+y

啟動Celery Worker來開始監聽並執行任務

celery -A tasks worker --loglevel=info

調用任務

再打開一個終端， 進行命令行模式，調用任務　

>>> from tasks import add
>>> add.delay(4, 4)

看你的worker終端會顯示收到 一個任務，此時你想看任務結果的話，需要在調用 任務時　賦值個變量

>>> result = add.delay(4, 4)

在項目中如何使用celery

可以把celery配置成一個應用

目錄格式如下

proj/__init__.py
    /celery.py
    /tasks.py

proj/celery.py內容

from __future__ import absolute_import, unicode_literals
from celery import Celery
 
app = Celery('proj',
             broker='amqp://',
             backend='amqp://',
             include=['proj.tasks'])
 
# Optional configuration, see the application user guide.
app.conf.update(
    result_expires=3600,
)
 
if __name__ == '__main__':
    app.start()

proj/tasks.py中的內容

from __future__ import absolute_import, unicode_literals
from .celery import app


@app.task
def add(x, y):
    return x + y


@app.task
def mul(x, y):
    return x * y


@app.task
def xsum(numbers):
    return sum(numbers)

啟動worker

celery -A proj worker -l info

celery定時任務

celery支持定時任務，設定好任務的執行時間，celery就會定時自動幫你執行， 這個定時任務模塊叫celery beat

寫一個腳本 叫periodic_task.py

from celery import Celery
from celery.schedules import crontab
 
app = Celery()
 
@app.on_after_configure.connect
def setup_periodic_tasks(sender, **kwargs):
    # Calls test('hello') every 10 seconds.
    sender.add_periodic_task(10.0, test.s('hello'), name='add every 10')
 
    # Calls test('world') every 30 seconds
    sender.add_periodic_task(30.0, test.s('world'), expires=10)
 
    # Executes every Monday morning at 7:30 a.m.
    sender.add_periodic_task(
        crontab(hour=7, minute=30, day_of_week=1),
        test.s('Happy Mondays!'),
    )
 
@app.task
def test(arg):
    print(arg)

add_periodic_task 會添加一條定時任務

上面是通過調用函數添加定時任務，也可以像寫配置文件 一樣的形式添加， 下面是每30s執行的任務

app.conf.beat_schedule = {
    'add-every-30-seconds': {
        'task': 'tasks.add',
        'schedule': 30.0,
        'args': (16, 16)
    },
}
app.conf.timezone = 'UTC'

任務添加好了，需要讓celery單獨啟動一個進程來定時發起這些任務， 注意， 這里是發起任務，不是執行，這個進程只會不斷的去檢查你的任務計划， 每發現有任務需要執行了，就發起一個任務調用消息，交給celery worker去執行

啟動任務調度器 celery beat

celery -A periodic_task beat

此時還差一步，就是還需要啟動一個worker,負責執行celery beat發起的任務

啟動celery worker來執行任務

 celery -A periodic_task worker

celery名詞：
任務task：就是一個Python函數。
隊列queue：將需要執行的任務加入到隊列中。
工人worker：在一個新進程中，負責執行隊列中的任務。
代理人broker：負責調度，在布置環境中使用redis。
celery解決的問題：
　　當瀏覽器訪問的頁面當中有耗時的操作時，訪問的客戶體驗不好使用celery可以將耗時的操作創建一個新的進程處理

執行流程：
　　產生任務task會放到queue隊列中，代理人broker會通知空閑的worker工人隊列中有任務，worker工人就會去隊列中把任務task取出來執行。

每一個worker就是一個工作的進程。

django配置流程：

安裝包：
celery==3.1.25
celery-with-redis==3.0
django-celery==3.1.17　

setting文件：
INSTALLED_APPS = (
    ...
    'djcelery',
}

setting配置代理和任務模塊
# 配置celery
import djcelery
djcelery.setup_loader()
# 傳遞消息時使用的redis 的ip 端口 數據庫名
BROKER_URL = 'redis://127.0.0.1:6379/2'
# 在booktest文件夾里面的task模塊的內容--所以需要創建模塊
CELERY_IMPORTS = ('booktest.task')

創建task文件：
import time
from django.core.mail import send_mail
from celery import task
from django.conf import settings
 
@task
def sayhello():
    print('hello ...')
    time.sleep(2)
    print('world ...')

view文件：
from booktest import task
def sayhello(request):
    """"""
    # print('hello')
    # time.sleep(5)
    # print('work')
    task.sayhello.delay() # 將任務教給celery執行
    return HttpResponse('ok')

數據庫遷移產生需要的表：
python manage.py migrate

啟動worker
python manage.py celery worker --loglevel=info

 =======================================示例（異步任務）=========================================================

1.setting.py

REDIS_SITE = ("redis://{}:{}/{}".format(
    os.getenv('REDIS_SERVER_HOST', '127.0.0.1'),
    os.getenv('REDIS_SERVER_PORT', '6379'),
    os.getenv('REDIS_CACHE_DB', '1'))
)

CACHES = {
    "default": {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": REDIS_SITE,
        "TIMEOUT": 60 * 60,
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
            "CONNECTION_POOL_KWARGS": {"max_connections": 100}             # 連接池
        }
    }
}

# Celery
CELERY_BROKER_URL = REDIS_SITE
CELERY_RESULT_BACKEND = REDIS_SITE

2.celery.py（setting.py同級）

from __future__ import absolute_import, unicode_literals
import os

from celery import Celery

# set the default Django settings module for the 'celery' program.
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'server.settings')

app = Celery('server')

# Using a string here means the worker doesn't have to serialize
# the configuration object to child processes.
# - namespace='CELERY' means all celery-related configuration keys
#   should have a `CELERY_` prefix.
app.config_from_object('django.conf:settings', namespace='CELERY')

# Load task modules from all registered Django app configs.
app.autodiscover_tasks()

 

3.tasks.py

from __future__ import absolute_import, unicode_literals
import logging
import base64
import time
import pickle
import lzma
from datetime import datetime

from utils.fastdfs import upload_image
from utils import short_uuid
from utils.job_queue import redis_queue


from celery import shared_task

from device.models import DevicePhotoModel, DeviceInfoModel

logger = logging.getLogger('server.celery')


@shared_task
def parse_image(device_pk, content):
    """解析圖片 """
    start_time = time.time()
    logger.info('Asynchronous push task start: {}'.format(start_time))
    try:
        obj = DeviceInfoModel.objects.get(pk=device_pk)
        upload_records = pickle.loads(lzma.decompress(base64.b64decode(content)))
        print(len(upload_records))
    except Exception as e:
        return
    image_list = []
    for item in upload_records:
        timestamp = datetime.fromtimestamp(item['timestamp'])
        image = base64.b64decode(item['image'])
        path = '{}/{}'.format(obj.hash, short_uuid.ShortUUID.uuid4())
        path = upload_image(image, path)
        logger.info('{} upload image in {}'.format(obj.name, path))
        if path:
            res = DevicePhotoModel.objects.create(device=obj, take_photo_time=timestamp, path=path)
            image_list.append([
                 res.hash,
                 res.get_url()
            ])
    redis_queue.image_enqueue(image_list)
    end_time = time.time()
    logger.info('Asynchronous push task end: {}, time consuming: {}'.format(end_time, end_time - start_time))

在需要執行異步任務的代碼里，執行

from device import tasks

tasks.parse_image.delay(device.pk, content)

 

 

 

 

 

參考博客：https://www.cnblogs.com/alex3714/p/6351797.html

中文文檔：http://docs.jinkan.org/docs/celery/