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/