Celery的使用完成异步任务与定时任务

0917自我总结

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的安装配置

pip install celery

消息中间件：RabbitMQ/Redis

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

例如

broker = 'redis://127.0.0.1:6379/11'   #存任务的仓库 redis数据库://ip:地址/第几个库
backend = 'redis://127.0.0.1:6379/12'  #执行结果存储
include = ['任务的上级目录.任务文件',]    #任务名传参方式用数组
app = Celery(broker=broker, backend=backend, include=include)

四.使用

1.目录结构

project
    ├── celery_task # celery包 如果celery_task只是建了普通文件夹__init__可以没有,如果是包一定要有
    │   ├── __init__.py # 包文件 看情况要不要存在
    │   ├── celery.py   # celery连接和配置相关文件，且名字必须交celery.py
    │   └── tasks.py    # 所有任务函数
    ├── add_task.py  	# 添加任务
    └── get_result.py   # 获取结果

2.创建工作任务

tasks.py

import time
@app.task
def add(n, m):
    print(n)
    print(m)
    time.sleep(10)
    print('n+m的结果：%s' % (n + m))
    return n + m

@app.task
def low(n, m):
    print(n)
    print(m)
    print('n-m的结果：%s' % (n - m))
    return n - m

'''
t1 = add.delay(10, 20)
t2 = low.delay(100, 50)
print(t1.id)   #添加在这里导入方法的时候直接运行方法
'''

3.配置任务

celery.py

from celery import Celery

broker = 'redis://127.0.0.1:6379/11'   #存任务的仓库 redis数据库://ip:地址/第几个库
backend = 'redis://127.0.0.1:6379/12'  #执行结果存储
include = ['celery_task.tasks',]    #任务名传参方式用数组
app = Celery(broker=broker, backend=backend, include=include)

4.启动服务导入方法

#先要cd到根目录如上面的目录的结构移动至project
# 非windows
# 命令：celery worker -A celery_task -l info
# windows：
# pip3 install eventlet
# celery worker -A celery_task -l info -P eventlet

5.手动添加任务

add_task.py

from  celery_task.tasks import *
# 添加立即执行任务
#如果add(10, 20)及在普通环境下运行,celery下运行必须下面的操作
t1 = add.delay(10, 20)
t2 = low.delay(100, 50)
print(t1.id)  

# 添加延迟任务
from datetime import datetime, timedelta
def eta_second(second):
    ctime = datetime.now()
    utc_ctime = datetime.utcfromtimestamp(ctime.timestamp())
    time_delay = timedelta(seconds=second)
    return utc_ctime + time_delay

tasks.low.apply_async(args=(200, 50), eta=eta_second(10))

注意:这个手动添加的任务文件千万别和配置任务文件和创建文件放同一目录,不然会发生循环导入

6.查看任务进行状态

from celery_task.celery import app

from celery.result import AsyncResult

id = '21325a40-9d32-44b5-a701-9a31cc3c74b5' #这个id可以在上述手动执行方法的结果.id显示出来
if __name__ == '__main__':
    async = AsyncResult(id=id, app=app)
    if async.successful():
        result = async.get()
        print(result)
    elif async.failed():
        print('任务失败')
    elif async.status == 'PENDING':
        print('任务等待中被执行')
    elif async.status == 'RETRY':
        print('任务异常后正在重试')
    elif async.status == 'STARTED':
        print('任务已经开始被执行')

7.定时启动任务

# 1）创建app + 任务

# 2）启动celery(app)服务：
# 非windows
# 命令：celery worker -A celery_task -l info
# windows：
# pip3 install eventlet
# celery worker -A celery_task -l info -P eventlet

# 3）添加任务：自动添加任务，所以要启动一个添加任务的服务
# 命令：celery beat -A celery_task -l info

# 4）获取结果

from celery import Celery

broker = 'redis://127.0.0.1:6379/1'
backend = 'redis://127.0.0.1:6379/2'
app = Celery(broker=broker, backend=backend, include=['celery_task.tasks'])

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

# 任务的定时配置
from datetime import timedelta
from celery.schedules import crontab
app.conf.beat_schedule = {
    'low-task': {   #low-tast名字可以随意
        'task': 'celery_task.tasks.low',   #导入方法的路径
        'schedule': timedelta(seconds=3),
        # 'schedule': crontab(hour=8, day_of_week=1),  # 每周一早八点
        'args': (300, 150),
    }
}

#上述文件均在配置文件中

8.django中的使用

# 重点：要将 项目名.settings 所占的文件夹添加到环境变量
# import sys
# sys.path.append(r'项目绝对路径')

# 开启django支持
import os
os.environ.setdefault('DJANGO_SETTINGS_MODULE', '项目名.settings')
import django
django.setup()
#在配置文件中或者在导入的方法中,基本上都在配置文件中设置
#如果下面正常配置报错,一般都是由于项目的setting没有找到,这时候我们要在上面方法配置
# 将celery服务框架放在项目根目录下
# import sys
# sys.path.append(r'项目的路径')

# 1）创建app + 任务

# 2）启动celery(app)服务：
# 非windows
# 命令：celery worker -A celery_task -l info
# windows：
# pip3 install eventlet
# celery worker -A celery_task -l info -P eventlet

# 3）添加任务：自动添加任务，所以要启动一个添加任务的服务
# 命令：celery beat -A celery_task -l info

# 4）获取结果

}