Celery—分布式的异步任务处理系统

Celery

1.什么是Clelery

Celery是一个简单、灵活且可靠的，处理大量消息的分布式系统

专注于实时处理的异步任务队列

同时也支持任务调度

Celery架构

Celery的架构由三部分组成：

● 消息中间件（message broker）

● 任务执行单元（worker）

● 任务执行结果存储（task result store）

消息中间件

Celery本身不提供消息服务，但是可以方便的和第三方提供的消息中间件集成。包括，RabbitMQ, Redis等等

任务执行单元

Worker是Celery提供的任务执行的单元，worker并发的运行在分布式的系统节点中。

任务结果存储

Task result store用来存储Worker执行的任务的结果，Celery支持以不同方式存储任务的结果，包括AMQP, redis等

版本支持情况

Celery version 4.0 runs on
Python ❨2.7, 3.4, 3.5❩
PyPy ❨5.4, 5.5❩
This is the last version to support Python 2.7, and from the next version (Celery 5.x) Python 3.5 or newer is required.

If you’re running an older version of Python, you need to be running an older version of Celery:

Python 2.6: Celery series 3.1 or earlier.
Python 2.5: Celery series 3.0 or earlier.
Python 2.4 was Celery series 2.2 or earlier.

Celery is a project with minimal funding, so we don’t support Microsoft Windows. Please don’t open any issues related to that platform.

2.使用场景

异步任务：将耗时操作任务提交给Celery去异步执行，比如发送短信/邮件、消息推送、音视频处理等等

定时任务：定时执行某件事情，比如每天数据统计

3.Celery的安装配置

pip install celery

消息中间件：RabbitMQ/Redis

app=Celery('任务名'，backend='xxx',broker='xxx')

4.Celery执行异步任务

基本使用

新建celery_task.py文件

# celery_task.py

from celery import Celery
# 不加密码
broker='redis://127.0.0.1:6379/0'   # borker配置，任务队列
backend='redis://127.0.0.1:6379/1'  # backend配置 执行结果存储
#加密码
# backend='redis://:123456@127.0.0.1:6379/1'
# broker='redis://:123456@127.0.0.1:6379/2'
#一定要指定一个名字

app=Celery('test',broker=broker,backend=backend)  # 创建任务异步处理器

#任务其实就是个函数
#需要用一个装饰器 *.task装饰,表示该任务是被 * celery管理的，并且可以用celery执行的
@app.task
def add(x,y):
    import time
    time.sleep(2)  # 模拟阻塞任务
    return x+y

这样我们就完成了上图流程中的三大配置，下面我们需要去提交任务并启动worker执行任务

另建add_task.py文件

#用于提交任务的py文件

import celery_task

#提交任务到消息队列中
#只是把任务提交到消息队列中，并没有执行需要启动worker才可以生效
ret=celery_task.add.delay(3,4)  # add 即celery_task中add函数
print(ret)
# ret=a5ea035f-0cc3-44ba-b334-f5d7c7ce681d  :任务的id号，待任务执行完毕，需要通过这个id去backend去取执行结果

#提交定时任务：于2019-07-20 11:13:56执行的任务，此任务只是在这里提交了，需要启动worker才可以生效
from datetime import datetime
v1 = datetime(2019, 7, 20, 11, 13, 56)
print(v1)  # 时间对象
v2 = datetime.utcfromtimestamp(v1.timestamp())
print(v2)  

# #取出要执行任务的时间对象，调用apply_async方法，args是参数，eta是执行的时间
result = celery_task.add.apply_async(args=[1, 3], eta=v2)
print(result.id)   # 任务的id号，待任务执行完毕，需要通过这个id去backend去取执行结果

#第二种获取时间的方法
ctime = datetime.now()
# 默认用utc时间
utc_ctime = datetime.utcfromtimestamp(ctime.timestamp())
from datetime import timedelta
#取10s之后的时间对象
time_delay = timedelta(seconds=3)
task_time = utc_ctime + time_delay   # 时间对象的相加
result = celery_task.add.apply_async(args=[4, 3], eta=task_time)
print(result.id)

启动worker

启动worker的两种方法：

# 方法一：
from celery_task import app
if __name__ == '__main__':
    app.worker_main()
    # cel.worker_main(argv=['--loglevel=info')

# 方法二：
# 命令行启动—常用
# linux下： celery worker -A celery_task_s1 -l info
# windows下：celery worker -A celery_task_s1 -l info -P eventlet  #eventlet是个模块 需要pip装下

接下来就是查看任务执行结果了

另起result.py文件

# 创建py文件：result.py，查看任务执行结果

from celery.result import AsyncResult
from celery_task import app

async = AsyncResult(id="e919d97d-2938-4d0f-9265-fd8237dc2aa3", app=cel)

if async.successful():
    result = async.get()
    print(result)
    # result.forget() # 将结果删除
elif async.failed():
    print('执行失败')
elif async.status == 'PENDING':
    print('任务等待中被执行')
elif async.status == 'RETRY':
    print('任务异常后正在重试')
elif async.status == 'STARTED':
    print('任务已经开始被执行')

总结下Celery使用步骤：

创建celery_app_task.py，配置borker\backend\worker和任务函数

执行 add_task.py，添加任务，并获取任务ID

执行命令启动worker：celery worker -A celery_app_task -l info

执行 result.py,检查任务状态并获取结果

下面我们进入重点：

5.多任务结构

pro_cel
├── celery_task # celery相关文件夹
│ ├── celery.py # celery连接和配置相关文件,必须叫这个名字
│ └── tasks1.py # 所有任务函数
│    └── tasks2.py # 所有任务函数
├── check_result.py # 检查结果
└── send_task.py # 触发任务

celery.py

from celery import Celery

cel = Celery('celery_demo',
             broker='redis://127.0.0.1:6379/1',  # 1 表示用resdis db1库
             backend='redis://127.0.0.1:6379/2',
             # 包含以下两个任务文件，去相应的py文件中找任务，对多个任务做分类
             include=['celery_task.tasks1',
                      'celery_task.tasks2'
                      ])
# 时区
cel.conf.timezone = 'Asia/Shanghai'
# 是否使用UTC
cel.conf.enable_utc = False

tasks1.py   # 任务文件1

import time
from celery_task.celery import cel

@cel.task
def work1(res):    # 模拟阻塞、耗时任务
    time.sleep(5)
    return "test_celery任务结果:%s"%res

tasks2.py

import time
from celery_task.celery import cel
@cel.task
def work2(res):    # 模拟阻塞、耗时任务
    time.sleep(5)
    return "test_celery2任务结果:%s"%res

check_result.py

from celery.result import AsyncResult
from celery_task.celery import cel

# 可以将以下代码封装成函数，id作为参数传递，执行结果做返回值

async = AsyncResult(id="08eb2778-24e1-44e4-a54b-56990b3519ef", app=cel)

if async.successful():
    result = async.get()
    print(result)
    # result.forget() # 将结果删除,执行完成，结果不会自动删除
    # async.revoke(terminate=True)  # 无论现在是什么时候，都要终止
    # async.revoke(terminate=False) # 如果任务还没有开始执行呢，那么就可以终止。
elif async.failed():
    print('执行失败')
elif async.status == 'PENDING':
    print('任务等待中被执行')
elif async.status == 'RETRY':
    print('任务异常后正在重试')
elif async.status == 'STARTED':
    print('任务已经开始被执行')

send_task.py

from celery_task.tasks1 import work1  # 任务1
from celery_task.tasks2 import work2  # 任务2 

# 立即告知celery去执行test_celery任务，并传入一个参数
result = work1.delay('第一个的执行')
print(result.id)
result = work2.delay('第二个的执行')
print(result.id)   # 将id 传入check_result.py中的Asyncresult就可以去拿结果了

任务执行步骤：

● 添加任务（执行send_task.py）

● 开启worker：celery worker -A celery_task -l info -P eventlet

● 检查任务执行结果（拿到id去执行check_result.py）

windows下启动worker命令解析

6.Celery执行定时任务

#### 类似于contab的定时任务 

多任务结构中celery.py修改如下

from datetime import timedelta
from celery import Celery
from celery.schedules import crontab

cel = Celery('tasks', broker='redis://127.0.0.1:6379/1', backend='redis://127.0.0.1:6379/2', include=[
    'celery_task.tasks1',
    'celery_task.tasks2',
])
cel.conf.timezone = 'Asia/Shanghai'
cel.conf.enable_utc = False

cel.conf.beat_schedule = {
    # 名字随意命名
    'add-every-10-seconds': {
        # 执行tasks1下的test_celery函数
        'task': 'celery_task.tasks1.test_celery',
        # 每隔2秒执行一次
        # 'schedule': 1.0,
        # 'schedule': crontab(minute="*/1"),
        'schedule': timedelta(seconds=2),
        # 传递参数
        'args': ('test',)
    },
    # 'add-every-12-seconds': {
    #     'task': 'celery_task.tasks1.test_celery',
    #     每年4月11号，8点42分执行
    #     'schedule': crontab(minute=42, hour=8, day_of_month=11, month_of_year=4),
    #     'schedule': crontab(minute=42, hour=8, day_of_month=11, month_of_year=4),
    #     'args': (16, 16)
    # },
}

启动一个beat：

celery beat -A celery_task -l info

启动work执行：

celery worker -A celery_task -l info -P  eventlet

7.Django中使用Celery（对版本对应关系依赖较高，不常用）

使用环境安装包

celery==3.1.25
django-celery==3.1.20

在项目目录下创建celeryconfig.py

import djcelery
djcelery.setup_loader()
CELERY_IMPORTS=(
    'app01.tasks',
)
#有些情况可以防止死锁
CELERYD_FORCE_EXECV=True
# 设置并发worker数量
CELERYD_CONCURRENCY=4
#允许重试
CELERY_ACKS_LATE=True
# 每个worker最多执行100个任务被销毁，可以防止内存泄漏
CELERYD_MAX_TASKS_PER_CHILD=100
# 超时时间
CELERYD_TASK_TIME_LIMIT=12*30

在app目录下创建tasks.py

from celery import task
@task
def add(a,b):
    with open('a.text', 'a', encoding='utf-8') as f:
        f.write('a')
    print(a+b)

视图函数views.py

from django.shortcuts import render,HttpResponse
from app01.tasks import add
from datetime import datetime
def test(request):
    # result=add.delay(2,3)
    ctime = datetime.now()
    # 默认用utc时间
    utc_ctime = datetime.utcfromtimestamp(ctime.timestamp())
    from datetime import timedelta
    time_delay = timedelta(seconds=5)
    task_time = utc_ctime + time_delay
    result = add.apply_async(args=[4, 3], eta=task_time)
    print(result.id)
    return HttpResponse('ok')

settings配置文件

INSTALLED_APPS = [
    ...
    'djcelery',
    'app01'
]

...

from djagocele import celeryconfig
BROKER_BACKEND='redis'
BOOKER_URL='redis://127.0.0.1:6379/1'
CELERY_RESULT_BACKEND='redis://127.0.0.1:6379/2'   #redis无密码情况下，有密码参照文章开头配置