Celery异步任务框架

Posted 2021-03-24 xuchengnotes

目录

• Celery架构
  • 消息中间件
  • 任务执行单元
  • 任务结果存储
• Celery的安装配置
• Celery执行异步任务
  • 使用步骤
  • 立即任务和延时任务
  • 定时任务
• 使用场景
• django项目中使用
  • celery.py（celery服务）
  • tasks.py（任务）
• 坑点：

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

安装依赖：pip install celery

消息中间件：RabbitMQ/Redis

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

Celery执行异步任务

包架构封装

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

使用步骤

'''
1）创建app + 任务

2）启动celery(app)服务：
    非windows
    cd 到celery_task所在文件夹下
    命令：celery worker -A celery_task -l info

    windows：
    安装依赖：pip3 install eventlet
    cd 到celery_task所在文件夹下
    命令：celery worker -A celery_task -l info -P eventlet

3）手动添加任务：手动添加，要自定义添加任务的脚本，右键执行脚本
   自动任务：自动添加任务，所以要启动一个添加任务的服务
    # 命令：celery beat -A celery_task -l info

4）获取结果：手动获取，要自定义获取任务的脚本，右键执行脚本
'''

立即任务和延时任务

celery_task文件夹-> celery.py (celery服务 文件名不可改)

from celery import Celery

# broker：任务仓库
broker = 'redis://127.0.0.1:6379/1'
# backend：任务结果仓库
backend = 'redis://127.0.0.1:6379/2'
# include：任务(函数)所在文件
app = Celery(broker=broker, backend=backend, include=['celery_task.tasks'])

celery_task文件夹-> tasks.py（celery任务 文件名可以改）

from .celery import app
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

add_task.py（添加任务）

from celery_task import tasks

# 往celery的Broker中添加立即任务
t1 = tasks.add.delay(10, 20)
t2 = tasks.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

# apply_async就是添加延迟任务
# args是jump任务需要的参数，没有就设置为空()
# eta是该任务执行的UTC格式的时间
tasks.low.apply_async(args=(200, 50), eta=eta_second(10))

get_result.py （获取任务执行结果）

from celery_task.celery import app

from celery.result import AsyncResult

# 任务id
id = '21325a40-9d32-44b5-a701-9a31cc3c74b5'
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('任务已经开始被执行')

定时任务

celery_task文件夹-> celery.py (celery服务 文件名不可改)

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': {
        'task': 'celery_task.tasks.low',    # 任务源
        'args': (300, 150), # 任务参数
        'schedule': timedelta(seconds=3),   # 定时添加任务的时间
        # 'schedule': crontab(hour=8, day_of_week=1),  # 每周一早八点
    }
}

celery_task文件夹-> tasks.py（celery任务 文件名可以改）

from .celery import app

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

get_result.py

from celery_task.celery import app

from celery.result import AsyncResult

id = '21325a40-9d32-44b5-a701-9a31cc3c74b5'
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('任务已经开始被执行')

启动定时任务：

'''
进入celery_tash的父级目录

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

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

使用场景

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

延时任务：需要延时处理的任务丢到延时任务里取处理

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

django项目中使用

# 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）获取结果

celery.py（celery服务）

# 重点：要将 项目的配置文件 所在的文件夹添加到环境变量
# import sys
# sys.path.append(r'项目的配置文件所在的文件夹')

# 开启django支持
import os
os.environ.setdefault('DJANGO_SETTINGS_MODULE', '项目名.settings.dev')
import django
django.setup()


from celery import Celery

# broker：任务仓库
broker = 'redis://127.0.0.1:6379/1'
# backend：任务结果仓库
backend = 'redis://127.0.0.1:6379/2'
# include：任务(函数)所在文件
app = Celery(broker=broker, backend=backend, include=['celery_task.tasks'])


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

# 自动任务的定时配置
from celery.schedules import crontab
from datetime import timedelta
app.conf.beat_schedule = {
    # 定时任务：任务名自定义
    'update_banner_cache': {
        'task': 'celery_task.tasks.update_banner_cache',  # 任务源
        'args': (),  # 任务参数
        'schedule': timedelta(seconds=10), # 定时添加任务的时间
        # 'schedule': crontab(hour=8, day_of_week=1),  # 每周一早八点
    }
}

tasks.py（任务）

from .celery import app
# 获取项目中的模型类
from home.models import Banner
from django.conf import settings
from django.core.cache import cache
from home.serializers import BannerModelSerializer
@app.task
def update_banner_cache():
    # 查询数据库
    banner_query = Banner.objects.filter(is_delete=False, is_show=True).order_by("-order")[:settings.BANNER_COUNT]
    # 序列化数据对象得到序列化后的json列表
    banner_list = BannerModelSerializer(banner_query, many=True).data
    # 设置缓存,走的是默认项目配置的缓存数据库
    cache.set('banner_list', banner_list)

坑点：

windows下celery处理post请求会报错。

错误：wrap_socket() got an unexpected keyword argument ‘_context‘

原因:

启动服务器错误
requests包的requests.post发送后，传不回数据

改变服务器启动方法不要用eventlet，加个参数
celery worker -A celery_name --loglevel=info --pool=solo