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）组成。

1 消息中间件

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

2 任务执行单元

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

3 任务结果存储

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

使用场景以及安装配置

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

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

Celery的安装配置

pip install celery

消息中间件：RabbitMQ/Redis

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

测试源码：

https://gitee.com/zhangmingyan/celery_test.git

包架构封装

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

二 基本使用+延迟使用

思路：

### 基本模式
1 celery服务去会监听redis库1里面的所有提交上来的任务们。

2 我们手动提交任务，会添加把任务提交到了redis里面的库1，celery会拿到任务处理 。

3 执行完的任务结果，celery会把结果添加到redis里面另一个库2。 

### 延迟使用模式
1 celery服务去会监听redis库1里面的所有提交上来的任务们 （如果发现是延迟的任务会延迟执行)

2 我们手动提交任务，会添加把任务提交到了redis里面的库1（指定到延迟参数），celery会拿到任务处理 。

3 执行完的任务结果，celery会把结果添加到redis里面另一个库2。 

celery.py

# 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）添加任务：手动添加，要自定义添加任务的脚本，右键执行脚本

# 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'])

tasks.py

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

# 添加立即执行任务
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

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 = '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服务。
自动添加任务就代替了手动添加任务。所以这个自动添加任务的过程也需要一个服务来完成。
也就是：
服务1 celery服务。
服务2 自动添加任务服务。

### 自动添加任务模式
1 celery服务去会监听redis库1里面的所有提交上来的任务们 （如果发现是延迟的任务会延迟执行)

2 开启自动添加任务服务，自动添加可以定制化的每隔多长时间提交一个任务到redis库1，celery会去处理这个任务。

3 执行完的任务结果，celery会把结果添加到redis里面另一个库2。 

放置位置：

celery.py

# 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': {
        'task': 'celery_task.tasks.low',
        'schedule': timedelta(seconds=3),
        # 'schedule': crontab(hour=8, day_of_week=1),  # 每周一早八点
        'args': (300, 150),
    }
}

tasks.py

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('任务已经开始被执行')

四 django中使用自动添加任务

思路：

1 唯一不同的就是要加入django的环境变量。
2 可以做推送，或者定时更新缓存的任务
### 本个案例是定时更新缓存：
1 celery就是每隔一段时间数据库里的部分内容更新到redis里面。
2 然后django的接口拿数据就去redis里面拿数据。
ps：这样的数据基本都更新不频繁的数据。

celery.py

# 启动django依赖

# 将celery服务框架放在项目根目录下
# import sys
# sys.path.append(r'C:\Users\oldboy\Desktop\luffy\luffyapi')

import os, django
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'Yanapi.settings.dev')
django.setup()

print('*********************')
from celery import Celery

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

# 启动celery服务的命令：
# 前提：一定要进入celery_task所属的文件夹
# celery worker -A celery_task -l info -P eventlet


# 自动添加任务
# 时区
app.conf.timezone = 'Asia/Shanghai'
# 是否使用UTC
app.conf.enable_utc = False

# 任务的定时配置
from datetime import timedelta
from celery.schedules import crontab
app.conf.beat_schedule = {
    'django-task': {
        'task': 'celery_task.tasks.django_task',
        'schedule': timedelta(seconds=10),
        # 'schedule': crontab(hour=8, day_of_week=1),  # 每周一早八点
        'args': (),
    },
}

# 启动 添加任务 服务的命令
# celery beat -A celery_task -l info

tasks.py

from django.core.cache import cache
import datetime

from .celery import app
from apps.home import models


@app.task
def django_task():
    banner_query = models.Banner.objects.filter(is_show=True, is_delete=False).order_by('-orders').all()
    banner_list_data = []
    for banner in banner_query:
        # banner #type:# django.db.models.fields.ImageFieldFile
        data = {
            'image': banner.image.url,
            'link': banner.link
        }
        banner_list_data.append(data)
    # 建立缓存
    cache.set('banner_list_data', banner_list_data)
    return f"{datetime.datetime.now().strftime('%Y-%m-%d:%H-%M-%S')} 缓存更新完成"

设置循环的周期图表

Example	Meaning
crontab()	每分钟执行
crontab(minute=0, hour=0)	每天凌晨执行
crontab(minute=0, hour=’*/3’)	每三个小时执行: midnight, 3am, 6am, 9am, noon, 3pm, 6pm, 9pm.
crontab(minute=0,hour=’0,3,6,9,12,15,18,21’)	同上
crontab(minute=’*/15’)	每十五分钟执行
crontab(day_of_week=’sunday’)	星期天每分钟执行
crontab(minute=’‘,hour=’‘, day_of_week=’sun’)	同上
crontab(minute=’*/10’,hour=’3,17,22’, day_of_week=’thu,fri’)	每十分钟执行, 但是只在星期四、五的 3-4 am, 5-6 pm, and 10-11 pm
crontab(minute=0, hour=’/2,/3’)	每两个小时及每三个小时执行，意思是: 除了下面时间的每个小时: 1am, 5am, 7am, 11am, 1pm, 5pm, 7pm, 11pm
crontab(minute=0, hour=’*/5’)	每五个小时执行。这意味着将在 3pm 而不是 5pm 执行 (因为 3pm 等于 24 小时制的 15, 能被 5 整除)
crontab(minute=0, hour=’*/3,8-17’)	每三个小时, 以及 (8am-5pm) 之间的小时执行
crontab(0, 0, day_of_month=’2’)	每个月的第二天执行
crontab(0, 0, day_of_month=’2-30/3’)	每个月的偶数天执行
crontab(0, 0,day_of_month=’1-7,15-21’)	每个月的第一个和第三个星期执行
crontab(0, 0, day_of_month=’11’,month_of_year=’5’)	每年五月份的第十一天执行
crontab(0, 0,month_of_year=’*/3’)	每个季度的第一个月执行