Celery 異步分佈式 171219

celery是Python開發的分佈式異步任務調度系統,Celery支持的消息服務有rmq、redis等 

Celery 是一個強大的分佈式任務隊列,它可以讓任務的執行完全脫離主程序,甚至可以被分配到其他主機上運行。我們通常使用它來實現異步任務(async task)和定時任務(crontab)。它的架構組成如下圖:


celery由5個主要組件組成: 
producer: 任務發佈者, 通過調用API向celery發佈任務的程序 
celery beat: 任務調度, 根據配置文件發佈定時任務 
worker: 實際執行任務的程序 
broker: 接受任務消息,存入隊列再按順序分發給worker執行 
backend: 存儲結果的服務器

Celery 主要包含以下幾個模塊:

  • 任務模塊
    包含異步任務和定時任務。其中,異步任務通常在業務邏輯中被觸發併發往任務隊列,而定時任務由 Celery Beat 進程週期性地將任務發往任務隊列

  • 消息中間件 Broker
    Broker,即爲任務調度隊列,接收任務生產者發來的消息(即任務),將任務存入隊列。Celery 本身不提供隊列服務,官方推薦使用 RabbitMQ 和 Redis 等。

  • 任務執行單元 Worker
    Worker 是執行任務的處理單元,它實時監控消息隊列,獲取隊列中調度的任務,並執行它

  • 任務結果存儲 Backend
    Backend 用於存儲任務的執行結果,以供查詢。同消息中間件一樣,存儲也可使用 RabbitMQ, Redis 和 MongoDB 等。

異步任務:

使用 Celery 實現異步任務主要包含三個步驟:

  1. 創建一個 Celery 實例

  2. 啓動 Celery Worker

  3. 應用程序調用異步任務

在運行下面的例子之前,請確保 redis 已正確安裝,並開啓 redis 服務,當然,celery 也是要安裝的。可以使用下面的命令來安裝 celery 及相關依賴:

pip install 'celery[redis]'
# -*- 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

將上面的代碼保存爲文件 tasks.py,做了幾件事:

  • 創建了一個 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 來表示;

在生產環境中,我們通常會使用 Supervisor 來控制 Celery Worker 進程。

調用任務

現在,我們可以在應用程序中使用 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 的啓動窗口,會看到多了兩條日誌

INFO/MainProcess] Received task: tasks.add[2272ddce-8be5-493f-b5ff-35a0d9fe600f]
 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:

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 的窗口我們可以看到如下輸出:

INFO/MainProcess] Received task: celery_app.task1.add[9ccffad0-aca4-4875-84ce-0ccfce5a83aa]
[INFO/MainProcess] Received task: celery_app.task2.multiply[64b1f889-c892-4333-bd1d-ac667e677a8a]
[INFO/PoolWorker-3] Task celery_app.task1.add[9ccffad0-aca4-4875-84ce-0ccfce5a83aa] succeeded in 2.00600231002s: 10
[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=(23), 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))
  • expires:任務過期時間,參數類型可以是 int,也可以是 datetime

task1.multiply.apply_async(args=[37], expires=10# 10 秒後過期

更多的參數列表可以在官方文檔中查看。

定時任務

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 週期性任務也有多個配置項,可參考官方文檔

本文由 funhacks 發表於個人博客,採用 Creative Commons BY-NC-ND 4.0(自由轉載-保持署名-非商用-禁止演繹)協議發佈。
非商業轉載請註明作者及出處。商業轉載請聯繫作者本人。
本文標題爲: 異步任務神器 Celery 簡明筆記
本文鏈接爲: https://funhacks.net/2016/12/...

參考資料





發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章