异步任务神器 Celery 简明笔记
benny_45
8年前
<h2>Celery</h2> <p>在程序的运行过程中，我们经常会碰到一些耗时耗资源的操作，为了避免它们阻塞主程序的运行，我们经常会采用多线程或异步任务。比如，在 Web 开发中，对新用户的注册，我们通常会给他发一封激活邮件，而发邮件是个 IO 阻塞式任务，如果直接把它放到应用当中，就需要等邮件发出去之后才能进行下一步操作，此时用户只能等待再等待。更好的方式是在业务逻辑中触发一个发邮件的异步任务，而主程序可以继续往下运行。</p> <p>Celery 是一个强大的分布式任务队列，它可以让任务的执行完全脱离主程序，甚至可以被分配到其他主机上运行。我们通常使用它来实现异步任务（async task）和定时任务（crontab）。它的架构组成如下图：</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/3cc47a82b844cca11c599250b4b491ae.png"></p> <p>可以看到，Celery 主要包含以下几个模块：</p> <ul> <li> <p>任务模块</p> <pre> <code class="language-python">包含异步任务和定时任务。其中，**异步任务通常在业务逻辑中被触发并发往任务队列，而定时任务由 Celery Beat 进程周期性地将任务发往任务队列**。</code></pre> </li> <li> <p>消息中间件 Broker</p> <pre> <code class="language-python">Broker，即为任务调度队列，**接收任务生产者发来的消息（即任务），将任务存入队列**。Celery 本身不提供队列服务，官方推荐使用 RabbitMQ 和 Redis 等。</code></pre> </li> <li> <p>任务执行单元 Worker</p> <pre> <code class="language-python">Worker 是执行任务的处理单元，**它实时监控消息队列，获取队列中调度的任务，并执行它**。</code></pre> </li> <li> <p>任务结果存储 Backend</p> <pre> <code class="language-python">Backend 用于**存储任务的执行结果**，以供查询。同消息中间件一样，存储也可使用 RabbitMQ, Redis 和 MongoDB 等。</code></pre> </li> </ul> <h2>异步任务</h2> <p>使用 Celery 实现异步任务主要包含三个步骤：</p> <ol> <li> <p>创建一个 Celery 实例</p> </li> <li> <p>启动 Celery Worker</p> </li> <li> <p>应用程序调用异步任务</p> </li> </ol> <h2>快速入门</h2> <p>为了简单起见，对于 Broker 和 Backend，这里都使用 redis。在运行下面的例子之前，请确保 redis 已正确安装，并开启 redis 服务，当然，celery 也是要安装的。可以使用下面的命令来安装 celery 及相关依赖：</p> <pre> <code class="language-python">$ pip install 'celery[redis]'</code></pre> <h3>创建 Celery 实例</h3> <p>将下面的代码保存为文件 tasks.py ：</p> <pre> <code class="language-python"># -*- 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</code></pre> <p>上面的代码做了几件事：</p> <ul> <li> <p>创建了一个 Celery 实例 app，名称为 my_task ；</p> </li> <li> <p>指定消息中间件用 redis，URL 为 redis://127.0.0.1:6379 ；</p> </li> <li> <p>指定存储用 redis，URL 为 redis://127.0.0.1:6379/0 ；</p> </li> <li> <p>创建了一个 Celery 任务 add ，当函数被 @app.task 装饰后，就成为可被 Celery 调度的任务；</p> </li> </ul> <h3>启动 Celery Worker</h3> <p>在当前目录，使用如下方式启动 Celery Worker：</p> <pre> <code class="language-python">$ celery worker -A tasks --loglevel=info</code></pre> <p>其中：</p> <ul> <li> <p>参数 -A 指定了 Celery 实例的位置，本例是在 tasks.py 中，Celery 会自动在该文件中寻找 Celery 对象实例，当然，我们也可以自己指定，在本例，使用 -A tasks.app ；</p> </li> <li> <p>参数 --loglevel 指定了日志级别，默认为 warning，也可以使用 -l info 来表示；</p> </li> </ul> <p>在生产环境中，我们通常会使用 Supervisor 来控制 Celery Worker 进程。</p> <p>启动成功后，控制台会显示如下输出：</p> <p><img src="https://simg.open-open.com/show/72f1dc818fd14d1aac0adde6c7a403c0.png"></p> <h3>调用任务</h3> <p>现在，我们可以在应用程序中使用 delay() 或 apply_async() 方法来调用任务。</p> <p>在当前目录打开 Python 控制台，输入以下代码：</p> <pre> <code class="language-python">>>> from tasks import add >>> add.delay(2, 8) <AsyncResult: 2272ddce-8be5-493f-b5ff-35a0d9fe600f></code></pre> <p>在上面，我们从 tasks.py 文件中导入了 add 任务对象，然后使用 delay() 方法将任务发送到消息中间件（Broker），Celery Worker 进程监控到该任务后，就会进行执行。我们将窗口切换到 Worker 的启动窗口，会看到多了两条日志：</p> <pre> <code class="language-python">[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</code></pre> <p>这说明任务已经被调度并执行成功。</p> <p>另外，我们如果想获取执行后的结果，可以这样做：</p> <pre> <code class="language-python">>>> result = add.delay(2, 6) >>> result.ready() # 使用 ready() 判断任务是否执行完毕 False >>> result.ready() False >>> result.ready() True >>> result.get() # 使用 get() 获取任务结果 8</code></pre> <p>在上面，我们是在 Python 的环境中调用任务。事实上，我们通常在应用程序中调用任务。比如，将下面的代码保存为 client.py :</p> <pre> <code class="language-python"># -*- coding: utf-8 -*- from tasks import add # 异步任务 add.delay(2, 8) print 'hello world'</code></pre> <p>运行命令 $ python client.py ，可以看到，虽然任务函数 add 需要等待 5 秒才返回执行结果，但由于它是一个异步任务，不会阻塞当前的主程序，因此主程序会往下执行 print 语句，打印出结果。</p> <h2>使用配置</h2> <p>在上面的例子中，我们直接把 Broker 和 Backend 的配置写在了程序当中，更好的做法是将配置项统一写入到一个配置文件中，通常我们将该文件命名为 celeryconfig.py 。</p> <p>下面，我们再看一个例子。项目结构如下：</p> <pre> <code class="language-python">celery_demo # 项目根目录 ├── celery_app # 存放 celery 相关文件 │ ├── __init__.py │ ├── celeryconfig.py # 配置文件 │ ├── task1.py # 任务文件 1 │ └── task2.py # 任务文件 2 └── client.py # 应用程序</code></pre> <p>__init__.py 代码如下：</p> <pre> <code class="language-python"># -*- coding: utf-8 -*- from celery import Celery app = Celery('demo') # 创建 Celery 实例 app.config_from_object('celery_app.celeryconfig') # 通过 Celery 实例加载配置模块</code></pre> <p>celeryconfig.py 代码如下：</p> <pre> <code class="language-python">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' )</code></pre> <p>task1.py 代码如下：</p> <pre> <code class="language-python">import time from celery_app import app @app.task def add(x, y): time.sleep(2) return x + y</code></pre> <p>task2.py 代码如下：</p> <pre> <code class="language-python">import time from celery_app import app @app.task def multiply(x, y): time.sleep(2) return x * y</code></pre> <p>client.py 代码如下：</p> <pre> <code class="language-python"># -*- 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'</code></pre> <p>现在，让我们启动 Celery Worker 进程，在项目的根目录下执行下面命令：</p> <pre> <code class="language-python">celery_demo $ celery -A celery_app worker --loglevel=info</code></pre> <p>接着，运行 $ python client.py ，它会发送两个异步任务到 Broker，在 Worker 的窗口我们可以看到如下输出：</p> <pre> <code class="language-python">[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</code></pre> <h2>delay 和 apply_async</h2> <p>在前面的例子中，我们使用 delay() 或 apply_async() 方法来调用任务。事实上， delay 方法封装了 apply_async ，如下：</p> <pre> <code class="language-python">def delay(self, *partial_args, **partial_kwargs): """Shortcut to :meth:`apply_async` using star arguments.""" return self.apply_async(partial_args, partial_kwargs)</code></pre> <p>也就是说， delay 是使用 apply_async 的快捷方式。 apply_async 支持更多的参数，它的一般形式如下：</p> <pre> <code class="language-python">apply_async(args=(), kwargs={}, route_name=None, **options)</code></pre> <p>apply_async 常用的参数如下：</p> <ul> <li> <p>countdown：指定多少秒后执行任务</p> </li> </ul> <pre> <code class="language-python">task1.apply_async(args=(2, 3), countdown=5) # 5 秒后执行任务</code></pre> <ul> <li> <p>eta (estimated time of arrival)：指定任务被调度的具体时间，参数类型是 datetime</p> </li> </ul> <pre> <code class="language-python">from datetime import datetime, timedelta # 当前 UTC 时间再加 10 秒后执行任务 task1.multiply.apply_async(args=[3, 7], eta=datetime.utcnow() + timedelta(seconds=10))</code></pre> <ul> <li> <p>expires：任务过期时间，参数类型可以是 int，也可以是 datetime</p> </li> </ul> <pre> <code class="language-python">task1.multiply.apply_async(args=[3, 7], expires=10) # 10 秒后过期</code></pre> <h2>定时任务</h2> <p>Celery 除了可以执行 <strong>异步任务</strong> ，也支持执行 <strong>周期性任务（Periodic Tasks）</strong> ，或者说定时任务。Celery Beat 进程通过读取配置文件的内容，周期性地将定时任务发往任务队列。</p> <p>让我们看看例子，项目结构如下：</p> <pre> <code class="language-python">celery_demo # 项目根目录 ├── celery_app # 存放 celery 相关文件 ├── __init__.py ├── celeryconfig.py # 配置文件 ├── task1.py # 任务文件 └── task2.py # 任务文件</code></pre> <p>__init__.py 代码如下：</p> <pre> <code class="language-python"># -*- coding: utf-8 -*- from celery import Celery app = Celery('demo') app.config_from_object('celery_app.celeryconfig')</code></pre> <p>celeryconfig.py 代码如下：</p> <pre> <code class="language-python"># -*- 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) # 任务函数参数 } }</code></pre> <p>task1.py 代码如下：</p> <pre> <code class="language-python">import time from celery_app import app @app.task def add(x, y): time.sleep(2) return x + y</code></pre> <p>task2.py 代码如下：</p> <pre> <code class="language-python">import time from celery_app import app @app.task def multiply(x, y): time.sleep(2) return x * y</code></pre> <p>现在，让我们启动 Celery Worker 进程，在项目的根目录下执行下面命令：</p> <pre> <code class="language-python">celery_demo $ celery -A celery_app worker --loglevel=info</code></pre> <p>接着，启动 Celery Beat 进程，定时将任务发送到 Broker，在项目根目录下执行下面命令：</p> <pre> <code class="language-python">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)</code></pre> <p>之后，在 Worker 窗口我们可以看到，任务 task1 每 30 秒执行一次，而 task2 每天早上 9 点 50 分执行一次。</p> <p>在上面，我们用两个命令启动了 Worker 进程和 Beat 进程，我们也可以将它们放在一个命令中：</p> <pre> <code class="language-python">$ celery -B -A celery_app worker --loglevel=info</code></pre> <p> </p> <h2>参考资料</h2> <ul> <li> <p><a href="/misc/goto?guid=4959729350443723444" rel="nofollow,noindex">Celery - Distributed Task Queue — Celery 4.0.1 documentation</a></p> </li> <li> <p><a href="/misc/goto?guid=4959729350530546302" rel="nofollow,noindex">使用Celery - Python之美</a></p> </li> <li> <p><a href="/misc/goto?guid=4959729350613538117" rel="nofollow,noindex">分布式任务队列Celery的介绍 – 思诚之道</a></p> </li> <li> <p><a href="/misc/goto?guid=4959654930443257082" rel="nofollow,noindex">异步任务神器 Celery 简明笔记</a></p> </li> </ul> <p> </p> <p>来自：https://segmentfault.com/a/1190000007780963</p> <p> </p>