一、什么是Celery
1.1、celery是什么
Celery是一个简单、灵活且可靠的,处理大量消息的分布式系统,专注于实时处理的异步任务队列,同时也支持任务调度。
Celery的架构由三部分组成,消息中间件(message broker),任务执行单元(worker)和任务执行结果存储(task result store)组成。
消息中间件
Celery本身不提供消息服务,但是可以方便的和第三方提供的消息中间件集成。包括,RabbitMQ, Redis等等
任务执行单元
Worker是Celery提供的任务执行的单元,worker并发的运行在分布式的系统节点中。
任务结果存储
Task result store用来存储Worker执行的任务的结果,Celery支持以不同方式存储任务的结果,包括AMQP, redis等
1.2、使用场景
celery是一个强大的 分布式任务队列的异步处理框架,它可以让任务的执行完全脱离主程序,甚至可以被分配到其他主机上运行。我们通常使用它来实现异步任务(async task)和定时任务(crontab)。
异步任务:将耗时操作任务提交给Celery去异步执行,比如发送短信/邮件、消息推送、音视频处理等等
定时任务:定时执行某件事情,比如每天数据统计
1.3、Celery具有以下优点
Simple(简单) Celery 使用和维护都非常简单,并且不需要配置文件。 Highly Available(高可用) woker和client会在网络连接丢失或者失败时,自动进行重试。并且有的brokers 也支持“双主”或者“主/从”的方式实现高可用。 Fast(快速) 单个的Celery进程每分钟可以处理百万级的任务,并且只需要毫秒级的往返延迟(使用 RabbitMQ, librabbitmq, 和优化设置时) Flexible(灵活) Celery几乎每个部分都可以扩展使用,自定义池实现、序列化、压缩方案、日志记录、调度器、消费者、生产者、broker传输等等。
1.4、Celery安装
使用pip安装:
pip install celery
二、Celery执行异步任务
2.1、基本使用
创建异步任务执行文件celery_task:
import celery import time backend = "redis://127.0.0.1:6379/1" broker = "redis://127.0.0.1:6379/2" cel = celery.Celery("test", backend=backend, broker=broker) @cel.task def send_email(name): print("向{}发送邮件...".format(name)) time.sleep(5) print("向{}发送邮件成功".format(name)) return "OK" @cel.task def send_sms(name): print("向{}发送短信...".format(name)) time.sleep(5) print("向{}发送短信成功".format(name)) return "OK"
备注:如果使用redis,则需要安装redis,并导入redis模块
pip install redis
创建执行任务文件 produce_task.py:
from celery_task import send_email result = send_email.delay("victor") print(result.id) result2 = send_email.delay("victor") print(result2.id)
# fa3cf3d1-6c13-40e4-b229-3e8748980776 7ec4a535-ec88-4640-9fbb-0bfa0362b3c1
注意,异步任务文件命令执行:
Linux: celery -A celery_task worker -l info
windowds: celery -A celery_task worker -l info -P threads
创建py文件:result.py,查看任务执行结果
from celery.result import AsyncResult
from celery_task import cel
async_result=AsyncResult(id="e6b4b14f-ee5b-4b09-a5e2-8c0bc2e1e299", app=cel)
if async_result.successful():
result = async_result.get()
print(result)
# result.forget() # 将结果删除
elif async_result.failed():
print('执行失败')
elif async_result.status == 'PENDING':
print('任务等待中被执行')
elif async_result.status == 'RETRY':
print('任务异常后正在重试')
elif async_result.status == 'STARTED':
print('任务已经开始被执行')
注意:如果异步任务做了修改,需要重启监听服务的
2.2、多任务结构
celery.py
from celery import Celery cel = Celery('celery_demo', broker='redis://127.0.0.1:6379/1', backend='redis://127.0.0.1:6379/2', # 包含以下两个任务文件,去相应的py文件中找任务,对多个任务做分类 include=['celery_task.task1', 'celery_task.task2' ]) # 时区 cel.conf.timezone = 'Asia/Shanghai' # 是否使用UTC cel.conf.enable_utc = False
task1.py
#task01 import time from celery_task.celery import cel @cel.task def send_email(res): time.sleep(5) return "完成向%s发送邮件任务"%res
task2.py
#task02 import time from celery_task.celery import cel @cel.task def send_msg(name): time.sleep(5) return "完成向%s发送短信任务"%name
produce.py
from celery_task.task1 import send_email from celery_task.task2 import send_msg result1 = send_email.delay("victor") result2 = send_msg.delay("victor") print(result1.id, result2.id)
result.py
from celery.result import AsyncResult from celery_task.celery import cel async_result=AsyncResult(id="7a091ac5-6bf6-4714-8c58-32542a5f4110", app=cel) if async_result.successful(): result = async_result.get() print(result) # result.forget() # 将结果删除 elif async_result.failed(): print('执行失败') elif async_result.status == 'PENDING': print('任务等待中被执行') elif async_result.status == 'RETRY': print('任务异常后正在重试') elif async_result.status == 'STARTED': print('任务已经开始被执行')
三、Celery执行定时任务
简单结构下的定时任务
celery.task和result.py同上
设定时间让celery执行一个定时任务,produce_task.py:
from celery_task import send_email from datetime import datetime # 方式一 v1 = datetime(2020, 3, 11, 16, 19, 00) print(v1) v2 = datetime.utcfromtimestamp(v1.timestamp()) print(v2) result = send_email.apply_async(args=["egon",], eta=v2) print(result.id) # 方式二 ctime = datetime.now() # 默认用utc时间 utc_ctime = datetime.utcfromtimestamp(ctime.timestamp()) from datetime import timedelta time_delay = timedelta(seconds=10) task_time = utc_ctime + time_delay # 使用apply_async并设定时间 result = send_email.apply_async(args=["egon"], eta=task_time) print(result.id)
注意:apply_async如果不传递eta参数,等同于delay函数
多级目录下的定时任务
task01.py和task02.py文件同上
多任务结构中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_tasks.task01', 'celery_tasks.task02', ]) cel.conf.timezone = 'Asia/Shanghai' cel.conf.enable_utc = False cel.conf.beat_schedule = { # 名字随意命名 'add-every-10-seconds': { # 执行tasks1下的test_celery函数 'task': 'celery_tasks.task01.send_email', # 每隔60秒执行一次 # 'schedule': 60.0, # 'schedule': crontab(minute="*/1"), 'schedule': timedelta(seconds=60), # 传递参数 'args': ('张三',) }, # 'add-every-12-seconds': { # 'task': 'celery_tasks.task01.send_email', # 每年4月11号,8点42分执行 # 'schedule': crontab(minute=42, hour=8, day_of_month=11, month_of_year=4), # 'args': ('张三',) # }, }
启动celery:
celery -A celery_tasks worker -l info
启动beats程序,Beat进程会读取配置文件的内容,周期性的将配置中到期需要执行的任务发送给任务队列
celery -A celery_task beat
celery定时任务就是beats程序替代了生产者User,会定期的向消息中间件中放入任务,celery worker发现消息中间件中有任务就会执行任务
四、Django中使用celery完成异步任务
项目根目录创建celery包,目录结构如下
配置文件config.py:
broker_url = 'redis://127.0.0.1:6379/15' result_backend = 'redis://127.0.0.1:6379/14'
sms任务文件tasks.py:
# celery的任务必须写在tasks.py的文件中,别的文件名称不识别!!! from mycelery.main import app import time import logging log = logging.getLogger("django") @app.task # name表示设置任务的名称,如果不填写,则默认使用函数名做为任务名 def send_sms(mobile): """发送短信""" print("向手机号%s发送短信成功!"%mobile) time.sleep(5) return "send_sms OK"
email任务文件tasks.py:
# celery的任务必须写在tasks.py的文件中,别的文件名称不识别!!! from mycelery.main import app import time import logging log = logging.getLogger("django") @app.task # name表示设置任务的名称,如果不填写,则默认使用函数名做为任务名 def send_email(email): """发送邮件""" print("向邮箱%s发送邮件成功!"%email) time.sleep(5) return "send_email OK"
main.py主程序中对django的配置文件进行加载
import os from celery import Celery # 创建celery实例对象 app = Celery("demon") # 把celery和django进行组合,识别和加载django的配置文件 # os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'celeryPros.settings.dev') # 通过app对象加载配置 app.config_from_object("mycelery.config") # 加载任务 # 参数必须必须是一个列表,里面的每一个任务都是任务的路径名称 # app.autodiscover_tasks(["任务1","任务2"]) app.autodiscover_tasks(["mycelery.sms","mycelery.email"]) # 启动Celery的命令 # celery -A mycelery.main worker --loglevel=info -P threads
Django视图调用:
from django.shortcuts import render # Create your views here. from django.shortcuts import render,HttpResponse from mycelery.sms.tasks import send_sms from mycelery.email.tasks import send_email from datetime import timedelta from datetime import datetime def test(request): ################################# 异步任务 # 1. 声明一个和celery一模一样的任务函数,但是我们可以导包来解决 send_sms.delay("17370314299") send_email.delay("1102669474") # 如果调用的任务函数没有参数,则不需要填写任何内容 ################################# 定时任务 ctime = datetime.now() # 默认用utc时间 utc_ctime = datetime.utcfromtimestamp(ctime.timestamp()) time_delay = timedelta(seconds=10) task_time = utc_ctime + time_delay result = send_sms.apply_async(["911", ], eta=task_time) print(result.id) return HttpResponse('ok')