目錄

• celery
• 1 celery簡介
• 2 安裝
• 3 celery的架構
• 4 celery的使用場景
• 5 celery的使用
  • 5.1 基本結構+非同步任務
  • 5.2 包結構+延時任務
  • 5.3 非同步任務
  • 5.4 延時任務
  • 5.5 定時任務
• 6 django使用celery

celery

celery是一個非同步任務框架，用於執行非同步任務，執行延遲任務，執行定時任務

1 celery簡介

1）可以不依賴任何伺服器，通過自身命令，啟動服務(內部支援socket)
2）celery服務為為其他專案服務提供非同步解決任務需求的
注：會有兩個服務同時執行，一個是專案服務，一個是celery服務，專案服務將需要非同步處理的任務交給celery服務，celery就會在需要時非同步完成專案的需求

人是一個獨立執行的服務 | 醫院也是一個獨立執行的服務
	正常情況下，人可以完成所有健康情況的動作，不需要醫院的參與；但當人生病時，就會被醫院接收，解決人生病問題
	人生病的處理方案交給醫院來解決，所有人不生病時，醫院獨立執行，人生病時，醫院就來解決人生病的需求
	
	
	
	
# Celery is a project with minimal funding, so we don’t support Microsoft Windows. Please don’t open any issues related to that platform.
# celery是一個小組織的專案，所以沒支援windows。
 

2 安裝

pip install celery

3 celery的架構

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

訊息中介軟體
Celery本身不提供訊息服務，但是可以方便的和第三方提供的訊息中介軟體整合。包括，RabbitMQ, Redis等等


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


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

4 celery的使用場景

非同步執行：解決耗時任務,將耗時操作任務提交給Celery去非同步執行，比如傳送簡訊/郵件、訊息推送、音視訊處理等等

延遲執行：解決延遲任務

定時執行：解決週期(週期)任務,比如每天資料統計

5 celery的使用

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
# 注：包名隨意
 

5.1 基本結構+非同步任務

project
    ├── celery_task  	# celery包
    │   ├── __init__.py # 包檔案
    │   ├── celery.py   # celery連線和配置相關檔案，且名字必須叫celery.py
    │   └── tasks.py    # 所有任務函式
    ├── add_task.py  	# 新增任務
    └── get_result.py   # 獲取結果

# 基本結構提交非同步任務


# 1 建立app與任務
# 寫一個py檔案，內容如下celery_task.py：
from celery import Celery
broker='redis://127.0.0.1:6379/1'  #broker任務佇列
backend='redis://127.0.0.1:6379/2'   # 結構儲存，執行完的結果存在這
# backend='redis://:[email protected]:6379/1'		密碼：123456
# broker='redis://:[email protected]:6379/2'		密碼：123456
app=Celery(__name__,broker=broker,backend=backend)

#新增任務(使用這個裝飾器裝飾，@app.task)
@app.task
def add(x,y):
    print(x,y)
    return x+y



# 2啟動worker
    # 用命令來執行
    # 非windows
    # celery worker -A celery_task -l info
    
    # windows：需要安裝eventlet模組
    # pip3 install eventlet
    # celery worker -A celery_task -l info -P eventlet
        
        
        
# 3 新增任務
	from celery_task import add
    # 函式有delay方法是由於裝飾器
    ret=add.delay(5,4)  # 向broker中新增一個任務
    print(ret)		# 返回值ret為任務的uuid號
    
    
    
# 4 檢視任務的執行結果
	from celery_task import app
    from celery.result import AsyncResult
    id = '3e397fd7-e0c1-4c5c-999c-2655a96793bb'
    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('任務已經開始被執行')

5.2 包結構+延時任務

注意點：必須建立名為celery.py的檔案

# 包結構提交延時任務

#1 新建一個包，叫celery_task
    -celery_task
        -__init__.py
        -celery.py
        -task1.py
        -task2.py
        
        
        
# 2 celery.py
    from celery import Celery
    broker='redis://127.0.0.1:6379/1'  # broker任務佇列
    backend='redis://127.0.0.1:6379/2'	# 結構儲存，執行完的結果存在這
    app=Celery(__name__,broker=broker,backend=backend,include=['celery_task.task1','celery_task.task2'])
    
    
    
# 3 task1.py
    from .celery import app
    @app.task
    def add(x,y):
        print(x,y)
        return x+y
    
    
    
# 4 task2.py
	from .celery import app
    @app.task
    def mutile(x,y):
        print(x,y)
        return x*y
    
    
    
    
# 5 新增任務（非同步任務，延遲任務）
    from celery_task.task1 import add
    from celery_task.task2 import mutile
    #  提交非同步
    ret=add.delay(6,7)
    print(ret)  # 2d4ad592-9548-4c7c-8df4-7f8583e8a1b1
    
    # 提交延遲任務
    from datetime import datetime, timedelta
    # 需要utc時間
    eta=datetime.utcnow() + timedelta(seconds=10)
    ret=add.apply_async(args=(240, 50), eta=eta)
    print(ret)

    

# 6 檢視任務的執行結果
	from celery_task import app
    from celery.result import AsyncResult
    id = '3e397fd7-e0c1-4c5c-999c-2655a96793bb'
    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('任務已經開始被執行')

5.3 非同步任務

ret=add.delay(6,7)
print(ret)  # 2d4ad592-9548-4c7c-8df4-7f8583e8a1b1

5.4 延時任務

eta=datetime.utcnow() + timedelta(seconds=10)
ret=add.apply_async(args=(240, 50), eta=eta)
print(ret)

5.5 定時任務

#1 celery.py
from celery import Celery
broker='redis://127.0.0.1:6379/1'  # broker任務佇列
backend='redis://127.0.0.1:6379/2'   # 結構儲存，執行完的結果存在這
app=Celery(__name__,broker=broker,backend=backend,include=['celery_task.task1','celery_task.task2'])


# 執行定時任務
app.conf.timezone = 'Asia/Shanghai'		# 時區
app.conf.enable_utc = False		# 是否使用UTC


# 任務的定時配置
from datetime import timedelta
from celery.schedules import crontab
app.conf.beat_schedule = {
    'add-task': {
        'task': 'celery_task.task1.add',
        # 'schedule': timedelta(seconds=3),
        'schedule': crontab(hour=8, day_of_week=1),  # 每週一早八點
        'args': (300, 150),
    }
}
    
    
    
# 2 啟動worker，啟動beat
	-celery worker -A celery_task -l info -P eventlet
	-celery beat -A celery_task -l info

6 django使用celery

celery.py

"""
celery框架django專案工作流程
1）載入django配置環境
2）建立Celery框架物件app，配置broker和backend，得到的app就是worker
3）給worker對應的app新增可處理的任務函式，用include配置給worker的app
4）完成提供的任務的定時配置app.conf.beat_schedule
5）啟動celery服務，執行worker，執行任務
6）啟動beat服務，執行beat，新增任務

重點：由於採用了django的反射機制，使用celery.py所在的celery_task包必須放置專案的根目錄下
"""

# 一、載入django配置環境
import os
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "luffyapi.settings.dev")

# 二、載入celery配置環境
from celery import Celery
# broker
broker = 'redis://127.0.0.1:6379/0'
# backend
backend = 'redis://127.0.0.1:6379/1'
# worker
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 = {
    'update-banner-list': {
        'task': 'celery_task.tasks.update_banner_list',
        'schedule': timedelta(seconds=10),
        'args': (),
    }
}

tasks.py

from .celery import app
from django.core.cache import cache
from home import models, serializers
from django.conf import settings


@app.task
def update_banner_list():
    queryset = models.Banner.objects.filter(is_delete=False, is_show=True).order_by('-orders')[:settings.BANNER_COUNT]
    banner_list = serializers.BannerSerializer(queryset, many=True).data
    # 拿不到request物件，所以頭像的連線base_url要自己組裝
    for banner in banner_list:
        banner['image'] = 'http://127.0.0.1:8000%s' % banner['image']

    cache.set('banner_list', banner_list, 86400)
    return True