python之異步任務架構Celery

官網參考：

Celery 官網：​​http://www.celeryproject.org/​​

Celery 官方文檔英文版：​​http://docs.celeryproject.org/en/latest/index.html​​

Celery 官方文檔中文版：​​http://docs.jinkan.org/docs/celery/​​

介紹：

"""
1）可以不依賴任何伺服器，通過自身指令，啟動服務(内部支援socket)
2）celery服務為為其他項目服務提供異步解決任務需求的
注：會有兩個服務同時運作，一個是項目服務，一個是celery服務，項目服務将需要異步處理的任務交給celery服務，celery就會在需要時異步完成項目的需求

人是一個獨立運作的服務 | 醫院也是一個獨立運作的服務
    正常情況下，人可以完成所有健康情況的動作，不需要醫院的參與；但當人生病時，就會被醫院接收，解決人生病問題
    人生病的處理方案交給醫院來解決，所有人不生病時，醫院獨立運作，人生病時，醫院就來解決人生病的需求
"""      

Celery架構圖：

　　Celery的架構由三部分組成，消息中間件（message broker）、任務執行單元（worker）和 任務執行結果存儲（task result store）組成。

消息中間件

Celery本身不提供消息服務，但是可以友善的和第三方提供的消息中間件內建。包括，RabbitMQ, Redis等等

任務執行單元

Worker是Celery提供的任務執行的單元，worker并發的運作在分布式的系統節點中。

任務結果存儲

Task result store用來存儲Worker執行的任務的結果，Celery支援以不同方式存儲任務的結果，包括AMQP, redis等

三、使用場景

異步執行：解決耗時任務

延遲執行：解決延遲任務

定時執行：解決周期(周期)任務

四、Celery的安裝配置

pip install celery

消息中間件：RabbitMQ/Redis

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

五、兩種celery任務結構：提倡用包管理，結構更清晰

# 如果 Celery對象:Celery(...) 是放在一個子產品下的
# 1）終端切換到該子產品所在檔案夾位置：scripts
# 2）執行啟動worker的指令：celery worker -A 子產品名 -l info -P eventlet
# 注：windows系統需要eventlet支援，Linux與MacOS直接執行：celery worker -A 子產品名 -l info
# 注：子產品名随意


# 如果 Celery對象:Celery(...) 是放在一個包下的
# 1）必須在這個包下建一個celery.py的檔案，将Celery(...)産生對象的語句放在該檔案中
# 2）執行啟動worker的指令：celery worker -A 包名 -l info -P eventlet
# 注：windows系統需要eventlet支援，Linux與MacOS直接執行：celery worker -A 子產品名 -l info
# 注：包名随意      

七、Celery執行異步任務

包架構封裝

project
    ├── celery_task      # celery包
    │   ├── __init__.py # 封包件
    │   ├── celery.py   # celery連接配接和配置相關檔案，且名字必須交celery.py
    │   └── tasks.py    # 所有任務函數
    ├── add_task.py      # 添加任務
    └── get_result.py   # 擷取結果      

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'
# 有密碼：
broker = 'redis://:[email protected]:6379/1'
backend = 'redis://:[email protected]:6379/2'
app = Celery(broker=broker, backend=backend, include=['celery_task.tasks'])
'''
broker : 任務倉庫
backend ： 任務結果倉庫
include ：任務(函數)所在檔案
'''      

tasks.py 添加任務

from .celery import app

@app.task
def add(n1,n2):
    res = n1+n2
    print('n1+n2 = %s' % res)
    return res


@app.task
def low(n1,n2):
    res = n1-n2
    print('n1-n2 = %s' % res)
    return res      

add_task.py 添加立即、延遲任務

from celery_task import tasks

# delay  ：添加立即任務
# apply_async ： 添加延遲任務
# eta ： 執行的utc時間


# 添加立即執行任務
t1 = tasks.add.delay(10, 20)
t2 = tasks.low.delay(100, 50)
print(t1.id)


# 添加延遲任務
from celery_package.tasks import jump
from datetime import datetime,timedelta

# 秒
def eta_second(second):
    ctime = datetime.now()  # 目前時間
    utc_ctime = datetime.utcfromtimestamp(ctime.timestamp())  # 目前UTC時間
    time_delay = timedelta(seconds=second)  # 秒
    return utc_ctime + time_delay  # 目前時間+往後延遲的秒
# 天
def eta_days(days):
    ctime = datetime.now()  # 目前時間
    utc_ctime = datetime.utcfromtimestamp(ctime.timestamp())  # 目前UTC時間
    time_delay = timedelta(days=days)  # 天
    return utc_ctime + time_delay  # 目前時間+往後延遲的天

jump.apply_async(args=(20,5), eta=eta_second(10))  # 10秒後執行
jump.apply_async(args=(20,5), eta=eta_days(1))  # 1天後執行      

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.py 定時任務配置(循環的)

特點：

添加任務的終端關閉之後，停止添加

# 1）建立app + 任務

# 2）啟動celery(app)服務：
# 注）：-A  表示相對路徑，是以一定先進入celery_task所在包
       -l 表示列印到日志 info 級别
# 非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'
# 有密碼：
broker = 'redis://:[email protected]:6379/1'
backend = 'redis://:[email protected]: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 = {
    # 定時任務名字
    'fall_task': {
        'task': 'celery_task.tasks.fall',
        'args':(30,20),
        'schedule': timedelta(seconds=3),  # 3秒後執行
        # 'schedule': crontab(hour=8, day_of_week=1),  # 每周一早八點
    }
}

'''
fall_task：任務名自定義
task:任務來源
args:任務參數
schedule：定時時間
'''


'schedule': crontab(hour=8, day_of_week=1),  # 每周一早八點
'''
minute : 分鐘
hour ：小時
day_of_week ：禮拜
day_of_month:月
month_of_year:年
'''      

tasks.py

from .celery import app

@app.task
def fall(n1,n2):
    res = n1/n2
    print('n1 /n2 = %s' % res)
    return res      

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('任務已經開始被執行')