celery异步框架

Celery异步框架

官方

Celery 官网：http://www.celeryproject.org/

Celery 官方文档英文版：http://docs.celeryproject.org/en/latest/index.html

Celery 官方文档中文版：http://docs.jinkan.org/docs/celery/

Celery架构

Celery的架构由三部分组成，消息中间件（message broker）、任务执行单元（worker）和 任务执行结果存储（task result store）组成。

消息中间件

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

任务执行单元

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

任务结果存储

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

使用场景

异步执行：解决耗时任务 --- 服务器同步客户端上传的视频

延迟执行：解决延迟任务 --- 延迟发送右键

定时执行：解决周期任务 --- 定时更新缓存

两种celery任务结构：提倡用包管理，结构更清晰

# 如果Celery对象：Celery(...)是放在一个模块下的，
# 1）终端切换到该模块所在文件夹位置，如scripts
# 2) 执行启动worker的命令: celery worker -A 模块名 -L info -P eventlet
# 注：windows系统需要eventlet支持，linux与MacOS直接执行：celery worker -A 模块名 -l info
# 注：模块名随意

# 如果Celery对象：Celery(...)是放在一个包下的，
# 1）必须在这个包下建一个规定名字为celery.py的文件，将Celery(...)产生对象的语句放在该文件中
# 2) 执行启动worker的命令: celery worker -A 包名 -L info -P eventlet
# 注：windows系统需要eventlet支持，linux与MacOS直接执行：celery worker -A 包名 -l info
# 注：包名随意

第一种：t_celery.py

from celery import Celery
app = Celery()  # 传入必要参数

第二种：tt_celery/celery.py

#  tt_celey是包
from celery import Celery
app = Celery()  # 传入必要参数

celery执行异步任务

包封装结构

project
    ├── celery_task      # celery包
    │   ├── __init__.py # 包文件
    │   ├── celery.py   # celery连接和配置相关文件，且名字必须交celery.py
    │   └── tasks.py    # 所有任务函数
    ├── add_task.py      # 添加任务
    └── get_result.py   # 获取结果

基本使用

scripts/celery_task_1/celery.py

from celery import Celery

# 连接redis: 'redis://:密码@服务器IP:端口/数据库编号'
broker = 'redis://:Admin123@127.0.0.1:6379/1'
backend = 'redis://:Admin123@127.0.0.1:6379/2'

# worker配置
app = Celery(broker=broker, backend=backend, include=['celery_task_1.tasks'])

# 时区
app.conf.timezone = 'Asia/Shanghai'
# 是否使用UTC
# app.conf.enable_utc = False

# 定时任务的配置
'''
app.conf.beat_schedule = {
    '自定义定时任务名': {
        'task': '指向任务函数',
        'schedule': '下一次再添加任务的时间间隔或固定的时间配置',
        'args': '无名参数',
        'kwargs': '有名参数'
    }
}
'''

# beat配置
from datetime import timedelta
from celery.schedules import crontab
app.conf.beat_schedule = {
    'test-task': {
        'task': 'celery_task_1.tasks.test_task',
        'schedule': timedelta(seconds=3),
        # 'schedule': crontab(hour=8, day_of_week=1),  # 每周一早八点
        'args': (666,),
    }
}

scripts/celery_task_1/tasks.py

from .celery import app

@app.task
def test_task(data):
    print('该方法就是任务，任务被执行了，传入的参数：%s' % data)
    return '该内容就是任务结果'


@app.task
def add(n1, n2):
    r = n1 + n2
    print('%s + %s = %s' % (n1, n2, r))
    return r

scripts/add_task.py

# 总结：该文件一定要独立开celery封装的包
# 原因：比如celery有一个更新轮播图缓存的任务，django项目是可以响应前台或后台用户主动更新轮播图数据库的数据，
# 当用户更新了数据库数据，就可以执行一下代码，通知celery可以去异步执行更新轮播图缓存的任务了


# 右键执行该文件，下面带导包是合理的
from celery_task_1.tasks import test_task

# 直接导入函数，调用函数，和celery没有任何关系
# test_task(666)

# 要将任务交给celery来执行
# 1）异步任务（立即去异步执行） => 视频同步
# t1 = test_task.delay(666)  # 返回值是任务对象，直接输出代表任务唯一标识：id
# print(t1.id)


# 2）延迟任务（达到设定的延迟时间后再去异步执行） => 定时发送邮件
from datetime import datetime, timedelta
eta = datetime.utcnow() + timedelta(seconds=10)

# t2 = test_task.apply_async(args=(888, ), eta=eta)
# print(t2.id)

from celery_task_1.tasks import add
t3 = add.apply_async(args=(33, 66), eta=eta)
# t3 = add.apply_async(kwargs={'n1': 44, 'n2': 66}, eta=eta)
print(t3.id)


# 3）定时任务（在worker服务以外，再启动一个beat服务，定时帮我们自动添加任务） => 定时更新轮播图
# i）在celery中配置好beat_schedule的配置后，执行命令启动定时添加任务服务
# >: celery beat -A 包名|模块名 -l info

scripts/get_task_result.py

# 获取任务结果也是项目正常逻辑来调用的

from celery.result import AsyncResult
from celery_task_1.celery import app

id = 'fad4b75c-c168-443a-be7c-7696b3233295'

if __name__ == '__main__':
    task_result = AsyncResult(id=id, app=app)
    if task_result.successful():
        result = task_result.get()
        print(result)
    elif task_result.failed():
        print('任务失败')
    elif task_result.status == 'PENDING':
        print('任务等待中被执行')
    elif task_result.status == 'RETRY':
        print('任务异常后正在重试')
    elif task_result.status == 'STARTED':
        print('任务已经开始被执行')