Celery

一、什么是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等

另外， Celery還支持不同的並發和序列化的手段

• 並發：Prefork, Eventlet, gevent, threads/single threaded
• 序列化：pickle, json, yaml, msgpack. zlib, bzip2 compression， Cryptographic message signing 等等

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安裝

你可以安裝Celery通過Python包管理平台（PyPI）或者源碼安裝
使用pip安裝:

1	$ pip install  - U Celery

或着：

1	$ sudo easy_install Celery

二、Celery執行異步任務

2.1、基本使用

創建項目celerypro

創建異步任務執行文件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("向%s發送郵件..."%name)
    time.sleep(5)
    print("向%s發送郵件完成"%name)
    return "ok"　　

創建執行任務文件,produce_task.py:

from celery_task import send_email
result = send_email.delay("yuan")
print(result.id)
result2 = send_email.delay("alex")
print(result2.id)　　

注意，異步任務文件命令執行：

1	celery worker  - A celery_app_task  - l info

創建py文件：result.py，查看任務執行結果，

from celery.result import AsyncResult
from celery_task import cel

async_result=AsyncResult(id="c6ddd5b7-a662-4f0e-93d4-ab69ec2aea5d", 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.1、多任務結構

 

 

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_tasks.task01',
                      'celery_tasks.task02'
                      ])

# 時區
cel.conf.timezone = 'Asia/Shanghai'
# 是否使用UTC
cel.conf.enable_utc = False

task01.py,task02.py:

#task01
import time
from celery_tasks.celery import cel

@cel.task
def send_email(res):
    time.sleep(5)
    return "完成向%s發送郵件任務"%res



#task02
import time
from celery_tasks.celery import cel
@cel.task
def send_msg(name):
    time.sleep(5)
    return "完成向%s發送短信任務"%name

produce_task.py:

from celery_tasks.task01 import send_email
from celery_tasks.task02 import send_msg

# 立即告知celery去執行test_celery任務，並傳入一個參數
result = send_email.delay('yuan')
print(result.id)
result = send_msg.delay('yuan')
print(result.id)

check_result.py:

from celery.result import AsyncResult
from celery_tasks.celery import cel

async_result = AsyncResult(id="562834c6-e4be-46d2-908a-b102adbbf390", app=cel)

if async_result.successful():
    result = async_result.get()
    print(result)
    # result.forget() # 將結果刪除,執行完成，結果不會自動刪除
    # async.revoke(terminate=True)  # 無論現在是什么時候，都要終止
    # async.revoke(terminate=False) # 如果任務還沒有開始執行呢，那么就可以終止。
elif async_result.failed():
    print('執行失敗')
elif async_result.status == 'PENDING':
    print('任務等待中被執行')
elif async_result.status == 'RETRY':
    print('任務異常后正在重試')
elif async_result.status == 'STARTED':
    print('任務已經開始被執行')

開啟work：celery worker -A celery_task -l info -P eventlet，添加任務（執行produce_task.py)，檢查任務執行結果（執行check_result.py）

三、Celery執行定時任務

 設定時間讓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)

多任務結構中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',
        # 每隔2秒執行一次
        # 'schedule': 1.0,
        # 'schedule': crontab(minute="*/1"),
        'schedule': timedelta(seconds=6),
        # 傳遞參數
        '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': ('張三',)
    # },
} 

1 2 3

# 啟動 Beat 程序$ celery beat -A proj<br># Celery Beat進程會讀取配置文件的內容，周期性的將配置中到期需要執行的任務發送給任務隊列   # 之后啟動 worker 進程.$ celery -A proj worker -l info 或者$ celery -B -A proj worker -l info

四、Django中使用celery

 項目根目錄創建celery包，目錄結構如下：

mycelery/
├── config.py
├── __init__.py
├── main.py
└── sms/
    ├── __init__.py
    ├── tasks.py

配置文件config.py:

broker_url = 'redis://127.0.0.1:6379/15'
result_backend = 'redis://127.0.0.1:6379/14'

任務文件tasks.py：

# celery的任務必須寫在tasks.py的文件中，別的文件名稱不識別!!!
from mycelerys.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"

@app.task  # name表示設置任務的名稱，如果不填寫，則默認使用函數名做為任務名
def send_sms2(mobile):
    print("向手機號%s發送短信成功!" % mobile)
    time.sleep(5)

    return "send_sms2 OK"

最后在main.py主程序中對django的配置文件進行加載

# 主程序
import os
from celery import Celery
# 創建celery實例對象
app = Celery("sms")

# 把celery和django進行組合，識別和加載django的配置文件
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'celeryPros.settings.dev')

# 通過app對象加載配置
app.config_from_object("mycelerys.config")

# 加載任務
# 參數必須必須是一個列表，里面的每一個任務都是任務的路徑名稱
# app.autodiscover_tasks(["任務1","任務2"])
app.autodiscover_tasks(["mycelerys.sms",])

# 啟動Celery的命令
# 強烈建議切換目錄到mycelery根目錄下啟動
# celery -A mycelery.main worker --loglevel=info

Django視圖調用：

from django.shortcuts import render

# Create your views here.


from django.shortcuts import render,HttpResponse
from mycelerys.sms.tasks import send_sms,send_sms2
from datetime import timedelta

from datetime import datetime
def test(request):

    ################################# 異步任務

    # 1. 聲明一個和celery一模一樣的任務函數，但是我們可以導包來解決

    # send_sms.delay("110")
    # send_sms2.delay("119")
    # send_sms.delay() 如果調用的任務函數沒有參數，則不需要填寫任何內容


    ################################# 定時任務

    # 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')