异步分布式队列Celery
异步分布式队列Celery
Celery 是什么?
Celery 是一个由 Python 编写的简单、灵活、可靠的用来处理大量信息的分布式系统,它同时提供操作和维护分布式系统所需的工具，实现的通讯协议也可以使用ruby，php，javascript等调用。
Celery 专注于实时任务处理，支持任务调度。
它是一个分布式队列的管理工具，我们可以用 Celery 提供的接口快速实现并管理一个分布式的任务队列。
我们要理解 Celery 本身不是任务队列，它是管理分布式任务队列的工具，或者换一种说法，它封装好了操作常见任务队列的各种操作，我们用它可以快速进行任务队列的使用与管理。
它的架构组成如下图：
概念扫盲
1.Brokers
brokers 中文意思为中间人，在这里就是指任务队列本身，Celery 扮演生产者和消费者的角色，brokers 就是生产者和消费者存放/拿取产品的地方(队列)
常见的 brokers 有 rabbitmq、redis、Zookeeper 等
2 Result Stores / backend
顾名思义就是结果储存的地方，队列中的任务运行完后的结果或者状态需要被任务发送者知道，那么就需要一个地方储存这些结果，就是 Result Stores 了
常见的 backend 有 redis、Memcached 甚至常用的数据都可以。
3 Workers
就是 Celery 中的工作者，类似与生产/消费模型中的消费者，其从队列中取出任务并执行
4 Tasks
就是我们想在队列中进行的任务咯，一般由用户、触发器或其他操作将任务入队，然后交由 workers 进行处理。
broker是一个消息传输的中间件，可以理解为一个邮箱。每当应用程序调用celery的异步任务的时候，会向broker传递消息，而后celery的worker将会取到消息，进行对于的程序执行。好吧，这个邮箱可以看成是一个消息队列。那么什么又是backend，通常程序发送的消息，发完就完了，可能都不知道对方时候接受了。为此，celery实现了一个backend，用于存储这些消息以及celery执行的一些消息和结果。对于 brokers，官方推荐是rabbitmq和redis，至于backend，就是数据库啦。为了简单起见，我们都用redis。
如果你想使用其他brokers,请查看这篇文档
异步任务
使用 Celery 实现异步任务主要包含三个步骤：
一创建一个 Celery 实例
二启动 Celery Worker
三应用程序调用异步任务
一、创建一个 Celery 实例
# -*- coding: utf-8 -*- import time from celery import Celery broker = 'redis://127.0.0.1:6379' backend = 'redis://127.0.0.1:6379/0' app = Celery('my_task', broker=broker, backend=backend) @app.task def add(x, y): time.sleep(5) # 模拟耗时操作 return x + y
上面的代码做了几件事：
- 创建了一个 Celery 实例 app，名称为 my_task；
- 指定消息中间件用 redis，URL 为 redis://127.0.0.1:6379；
- 指定存储用 redis，URL 为 redis://127.0.0.1:6379/0；
- 创建了一个 Celery 任务 add，当函数被 @app.task 装饰后，就成为可被 Celery 调度的任务；
二、启动 Celery Worker
在当前目录，使用如下方式启动 Celery Worker：
$ celery worker -A tasks --loglevel=info
其中：
- 参数 -A 指定了 Celery 实例的位置，本例是在 tasks.py 中，Celery 会自动在该文件中寻找 Celery 对象实例，当然，我们也可以自己指定，在本例，使用 -A tasks.app；
- 参数 --loglevel 指定了日志级别，默认为 warning，也可以使用 -l info 来表示；
三、调度任务
我们可以在应用程序中使用 delay() 或 apply_async() 方法来调用任务。
在当前目录打开 Python 控制台，输入以下代码：
>>> from tasks import add >>> add.delay(2, 8) <AsyncResult: 2272ddce-8be5-493f-b5ff-35a0d9fe600f>
在上面，我们从 tasks.py 文件中导入了 add 任务对象，然后使用 delay() 方法将任务发送到消息中间件（Broker），Celery Worker 进程监控到该任务后，就会进行执行。我们将窗口切换到 Worker 的启动窗口，会看到多了两条日志：
[2016-12-10 12:00:50,376: INFO/MainProcess] Received task: tasks.add[2272ddce-8be5-493f-b5ff-35a0d9fe600f] [2016-12-10 12:00:55,385: INFO/PoolWorker-4] Task tasks.add[2272ddce-8be5-493f-b5ff-35a0d9fe600f] succeeded in 5.00642602402s: 10
这说明任务已经被调度并执行成功。
另外，我们如果想获取执行后的结果，可以这样做：
>>> result = add.delay(2, 6) >>> result.ready() # 使用 ready() 判断任务是否执行完毕 False >>> result.ready() False >>> result.ready() True >>> result.get() # 使用 get() 获取任务结果 8
在上面，我们是在 Python 的环境中调用任务。事实上，我们通常在应用程序中调用任务。比如，将下面的代码保存为 client.py:
# -*- coding: utf-8 -*- from tasks import add # 异步任务 add.delay(2, 8) print 'hello world'
运行命令 $ python client.py，可以看到，虽然任务函数 add 需要等待 5 秒才返回执行结果，但由于它是一个异步任务，不会阻塞当前的主程序，因此主程序会往下执行 print 语句，打印出结果。
使用配置
在上面的例子中，我们直接把 Broker 和 Backend 的配置写在了程序当中，更好的做法是将配置项统一写入到一个配置文件中，通常我们将该文件命名为 celeryconfig.py。Celery 的配置比较多，可以在官方文档查询每个配置项的含义。
下面，我们再看一个例子。项目结构如下：
celery_demo # 项目根目录 ├── celery_app # 存放 celery 相关文件 │ ├── __init__.py │ ├── celeryconfig.py # 配置文件 │ ├── task1.py # 任务文件 1 │ └── task2.py # 任务文件 2 └── client.py # 应用程序
__init__.py 代码如下：
# -*- coding: utf-8 -*- from celery import Celery app = Celery('demo') # 创建 Celery 实例 app.config_from_object('celery_app.celeryconfig') # 通过 Celery 实例加载配置模块 celeryconfig.py 代码如下： BROKER_URL = 'redis://127.0.0.1:6379' # 指定 Broker CELERY_RESULT_BACKEND = 'redis://127.0.0.1:6379/0' # 指定 Backend CELERY_TIMEZONE='Asia/Shanghai' # 指定时区，默认是 UTC # CELERY_TIMEZONE='UTC' CELERY_IMPORTS = ( # 指定导入的任务模块 'celery_app.task1', 'celery_app.task2' )
task1.py 代码如下：
import time from celery_app import app @app.task def add(x, y): time.sleep(2) return x + y
task2.py 代码如下：
import time from celery_app import app @app.task def multiply(x, y): time.sleep(2) return x * y
client.py 代码如下：
# -*- coding: utf-8 -*- from celery_app import task1 from celery_app import task2 task1.add.apply_async(args=[2, 8]) # 也可用 task1.add.delay(2, 8) task2.multiply.apply_async(args=[3, 7]) # 也可用 task2.multiply.delay(3, 7) print 'hello world'
现在，让我们启动 Celery Worker 进程，在项目的根目录下执行下面命令：
celery_demo $ celery -A celery_app worker --loglevel=info
接着，运行 $ python client.py，它会发送两个异步任务到 Broker，在 Worker 的窗口我们可以看到如下输出：
[2016-12-10 13:51:58,939: INFO/MainProcess] Received task: celery_app.task1.add[9ccffad0-aca4-4875-84ce-0ccfce5a83aa] [2016-12-10 13:51:58,941: INFO/MainProcess] Received task: celery_app.task2.multiply[64b1f889-c892-4333-bd1d-ac667e677a8a] [2016-12-10 13:52:00,948: INFO/PoolWorker-3] Task celery_app.task1.add[9ccffad0-aca4-4875-84ce-0ccfce5a83aa] succeeded in 2.00600231002s: 10 [2016-12-10 13:52:00,949: INFO/PoolWorker-4] Task celery_app.task2.multiply[64b1f889-c892-4333-bd1d-ac667e677a8a] succeeded in 2.00601326401s: 21
delay 和 apply_async
在前面的例子中，我们使用 delay() 或 apply_async() 方法来调用任务。事实上，delay方法封装了 apply_async，如下：
def delay(self, *partial_args, **partial_kwargs): """Shortcut to :meth:`apply_async` using star arguments.""" return self.apply_async(partial_args, partial_kwargs)
也就是说，delay 是使用 apply_async 的快捷方式。apply_async 支持更多的参数，它的一般形式如下：
apply_async(args=(), kwargs={}, route_name=None, **options)
apply_async 常用的参数如下：
- countdown：指定多少秒后执行任务
task1.apply_async(args=(2, 3), countdown=5) # 5 秒后执行任务
- eta (estimated time of arrival)：指定任务被调度的具体时间，参数类型是 datetime
from datetime import datetime, timedelta # 当前 UTC 时间再加 10 秒后执行任务 task1.multiply.apply_async(args=[3, 7], eta=datetime.utcnow() + timedelta(seconds=10))
xpires：任务过期时间，参数类型可以是 int，也可以是 datetime
task1.multiply.apply_async(args=[3, 7], expires=10) # 10 秒后过期
更多的参数列表可以在官方文档中查看。
task可以添加参数：
@app.task def add(x, y): time.sleep(2) return x + y
如：
@app.task(bind=True, name='name')
# task方法参数 name:可以显式指定任务的名字；默认是模块的命名空间中本函数的名字。 serializer：指定本任务的序列化的方法； bind:一个bool值，设置是否绑定一个task的实例，如果绑定，task实例会作为参数传递到任务方法中，可以访问task实例的所有的属性，即前面反序列化中那些属性 base:定义任务的基类，可以以此来定义回调函数，默认是Task类，我们也可以定义自己的Task类 default_retry_delay：设置该任务重试的延迟时间，当任务执行失败后，会自动重试，单位是秒，默认3分钟； autoretry_for：设置在特定异常时重试任务，默认False即不重试； retry_backoff：默认False，设置重试时的延迟时间间隔策略； retry_backoff_max：设置最大延迟重试时间，默认10分钟，如果失败则不再重试； retry_jitter：默认True，即引入抖动，避免重试任务集中执行；
# 当bind=True时，add函数第一个参数是self，指的是task实例 @task(bind=True) # 第一个参数是self，使用self.request访问相关的属性 def add(self, x, y): try: logger.info(self.request.id) except: self.retry() # 当任务失败则进行重试
import celery from celery_app import app class MyTask(celery.Task): # 任务失败时执行 def on_failure(self, exc, task_id, args, kwargs, einfo): print('{0!r} failed: {1!r}'.format(task_id, exc)) # 任务成功时执行 def on_success(self, retval, task_id, args, kwargs): pass # 任务重试时执行 def on_retry(self, exc, task_id, args, kwargs, einfo): pass @app.task(base=MyTask) def add(x, y): raise KeyError() #方法相关的参数 exc:失败时的错误的类型； task_id:任务的id； args:任务函数的参数； kwargs:键值对参数； einfo:失败或重试时的异常详细信息； retval:任务成功执行的返回值；
TASK的一般属性:
Task.name:任务名称；
Task.request：当前任务的信息；
Task.max_retries：设置重试的最大次数
Task.throws：预期错误类的可选元组，不应被视为实际错误，而是结果失败；
Task.rate_limit：设置此任务类型的速率限制
Task.time_limit：此任务的硬限时（以秒为单位）。
Task.ignore_result：不存储任务状态。默认False；
Task.store_errors_even_if_ignored：如果True，即使任务配置为忽略结果，也会存储错误。
Task.serializer：标识要使用的默认序列化方法的字符串。
Task.compression：标识要使用的默认压缩方案的字符串。默认为task_compression设置。
Task.backend：指定该任务的结果存储后端用于此任务。
Task.acks_late：如果设置True为此任务的消息将在任务执行后确认 ，而不是在执行任务之前（默认行为），即默认任务执行之前就会发送确认；
Task.track_started：如果True任务在工作人员执行任务时将其状态报告为“已启动”。默认是False；
自定义发布者,交换机,路由键, 队列, 优先级,序列方案和压缩方法:
task1.apply_async((2,2), compression='zlib', serialize='json', queue='priority.high', routing_key='web.add', priority=0, exchange='web_exchange'
定时任务
Celery 除了可以执行异步任务，也支持执行周期性任务（Periodic Tasks），或者说定时任务。Celery Beat 进程通过读取配置文件的内容，周期性地将定时任务发往任务队列。
让我们看看例子，项目结构如下：
celery_demo # 项目根目录 ├── celery_app # 存放 celery 相关文件 ├── __init__.py ├── celeryconfig.py # 配置文件 ├── task1.py # 任务文件 └── task2.py # 任务文件
__init__.py 代码如下：
# -*- coding: utf-8 -*- from celery import Celery app = Celery('demo') app.config_from_object('celery_app.celeryconfig')
celeryconfig.py 代码如下：
# -*- coding: utf-8 -*- from datetime import timedelta from celery.schedules import crontab # Broker and Backend BROKER_URL = 'redis://127.0.0.1:6379' CELERY_RESULT_BACKEND = 'redis://127.0.0.1:6379/0' # Timezone CELERY_TIMEZONE='Asia/Shanghai' # 指定时区，不指定默认为 'UTC' # CELERY_TIMEZONE='UTC' # import CELERY_IMPORTS = ( 'celery_app.task1', 'celery_app.task2' ) # schedules CELERYBEAT_SCHEDULE = { 'add-every-30-seconds': { 'task': 'celery_app.task1.add', 'schedule': timedelta(seconds=30), # 每 30 秒执行一次 'args': (5, 8) # 任务函数参数 }, 'multiply-at-some-time': { 'task': 'celery_app.task2.multiply', 'schedule': crontab(hour=9, minute=50), # 每天早上 9 点 50 分执行一次 'args': (3, 7) # 任务函数参数 } }
task1.py 代码如下：
import time from celery_app import app @app.task def add(x, y): time.sleep(2) return x + y
task2.py 代码如下：
import time from celery_app import app @app.task def multiply(x, y): time.sleep(2) return x * y
现在，让我们启动 Celery Worker 进程，在项目的根目录下执行下面命令：
celery_demo $ celery -A celery_app worker --loglevel=info
接着，启动 Celery Beat 进程，定时将任务发送到 Broker，在项目根目录下执行下面命令：
celery_demo $ celery beat -A celery_app celery beat v4.0.1 (latentcall) is starting. __ - ... __ - _ LocalTime -> 2016-12-11 09:48:16 Configuration -> . broker -> redis://127.0.0.1:6379// . loader -> celery.loaders.app.AppLoader . scheduler -> celery.beat.PersistentScheduler . db -> celerybeat-schedule . logfile -> [stderr]@%WARNING . maxinterval -> 5.00 minutes (300s)
之后，在 Worker 窗口我们可以看到，任务 task1 每 30 秒执行一次，而 task2 每天早上 9 点 50 分执行一次。
在上面，我们用两个命令启动了 Worker 进程和 Beat 进程，我们也可以将它们放在一个命令中：
$ celery -B -A celery_app worker --loglevel=info
Celery 周期性任务也有多个配置项，可参考官方文档。
更多参考：https://segmentfault.com/a/1190000006249269
