Blog 項目源碼：https://github.com/JmilkFan/JmilkFan-s-Blog

前文列表

擴展閱讀

Celery-分佈式任務隊列
 基於後臺作業的 Celery
Flask-Celery-Helper 1.1.0

Celery

Celery 是使用 Python 多任務庫來編寫的任務隊列工具, 可以並行的執行任務. 我們會將執行時間較長但又不那麼追求實時的功能以異步任務的形式完成, EG. 上傳文件, 發送郵件…, Python 和 Celery 之間需要一箇中間人(消息隊列)來進行任務隊列的管理, Celery 官方推薦使用 RabbirMQ 或 Redis 來充當這個角色. 當然也可以同時使用兩者, 其中 MQ 作爲中間人, Redis 傳遞 Celery 執行的結果給應用端. 這樣做的優勢在於, 返回給應用的結果是持久化保存在數據庫中的.

消息隊列: 是一種專門設計的系統, 用於在生產者(往隊列發送消息的程序)和消費者(從隊列中取出消息的隊列)之間傳遞消息.

安裝 Celery

pip install Celery

安裝 Flask-Celery-Helper
Flask-Celery-Helper 是一個 Flask 擴展, 用於輔助使用 app 來初始化 Celery 對象, 使其得以註冊到 app 對象中.

pip install Flask-Celery-Helper
pip freeze > requirments.txt

安裝 RabbitMQ: 官方安裝文檔
啓動 RabbitMQ

/etc/init.d/rabbitmq-server start

將 Celery 加入到應用中

配置 Celery 連接 RabbitMQ 的 URL
vim jmilkfansblog/config.py

class DevConfig(Config):
    """Development config class."""
...
    # Celery <--> RabbitMQ connection
    CELERY_RESULT_BACKEND = "amqp://guest:guest@localhost:5672//"
    CELERY_BROKER_URL = "amqp://guest:guest@localhost:5672//"

NOTE: RabbitMQ 使用默認的 guest 用戶, 端口爲 5672

創建 celery 對象
vim jmilkfansblog/extensions.py

from flask.ext.celery import Celery

...

# Create the Flask-Celery-Helper's instance
flask_celery = Celery()

將 celery 對象註冊到 app 對象
vim jmilkfansblog/__init__.py

from jmilkfansblog.extensions import flask_celery

def create_app(object_name):
    """Create the app instance via `Factory Method`"""
...
    # Init the Flask-Celery-Helper via app object
    # Register the celery object into app object
    flask_celery.init_app(app)

NOTE 1: Celery 的進程必須在 Flask app 的上下文中運行, 這樣 Celery 才能夠跟其他的 Flask 擴展協同工作。所以必須將 flask_celery 對象註冊到 app 對象中, 並且每創建一個 Celery 進程都需要創建一個新的 Flask app 對象, 這裏我們使用工廠模式來創建 celery 對象。這一點是非常重要的，實際上 Flask application 和 Celery application 是兩個不同的進程，在 Celery 沒有加入 Flask 上下文的情況下，Celery 的程序邏輯就不能輕易的訪問 Flask 相關資源，比如不能加載 Flask 的環境配置信息，無法通過 Flask 來訪問數據庫，不能使用 Flask 的擴展功能等。如果想做到這些，Celery 都需要自己再實現一套相同的邏輯，這樣做顯然是沒有必要的。所以 Flask application 原生支持將自己的 Context 嵌入到別的 application 中，當然有些情況也需要相應擴展的輔助，例如 Flask-Celery-Helper 在這裏就充當着這個角色。

NOTE 2: flask_celery 對象是 Flask-Celery-Helper 擴展的對象, 用於輔助處理 Celery 的初始化, 所以實際上我們是可以不使用這個擴展, 而直接使用 Celery 的. celery 對象纔是真正的 Celery 的對象.

使用工廠模式來創建 celery 對象
./celery_runner.py

mport os

from celery import Celery

from jmilkfansblog import create_app


def make_celery(app):
    """Create the celery process."""

    # Init the celery object via app's configuration.
    celery = Celery(
        app.import_name,
        backend=app.config['CELERY_RESULT_BACKEND'],
        broker=app.config['CELERY_BROKER_URL'])

    # Flask-Celery-Helpwe to auto-setup the config.
    celery.conf.update(app.config)
    TaskBase = celery.Task

    class ContextTask(TaskBase):

        abstract = True

        def __call__(self, *args, **kwargs):
            """Will be execute when create the instance object of ContextTesk."""

            # Will context(Flask's Extends) of app object(Producer Sit) 
            # be included in celery object(Consumer Site).
            with app.app_context():
                return TaskBase.__call__(self, *args, **kwargs)

    # Include the app_context into celery.Task.
    # Let other Flask extensions can be normal calls.
    celery.Task = ContextTask
    return celery

env = os.environ.get('BLOG_ENV', 'dev')
flask_app = create_app('jmilkfansblog.config.%sConfig' % env.capitalize())
# 1. Each celery process needs to create an instance of the Flask application.
# 2. Register the celery object into the app object.
celery = make_celery(flask_app)

NOTE 1: 我們以後會以 CLI 的形式來管理和控制 Celery 的 worker, 所以我們將 celery 對象的實現模塊放置在 ./celery_runner.py 中, 而不是 jmilkfansblog/celery_runner.py. Flask app 內部的 tasks 任何的定義和實現就交由 Flask-Celery-Helper 來支持就好了, 這也是 Flask-Celery-Helper 存在的意義.

NOTE 2: make_celery()最重要的作用就是讓每個 Celery 的進程中(celery對象)都包含有 app 對象的上下文, 至於爲什麼這麼做呢? 上述已經給出了答案.

NOTE 3: 這裏通過 create_app() 創建的對象不能夠命名爲 app, 而是命名爲 flask_app, 這是因爲 Celery 會默認將命名爲 app 或 celery 的對象都作爲一個 Celery 對象來處理.

NOTE 4: celery.conf.update(app.config) 會將 app 對象的 config 更新到 celery 對象中, 當然也包括了剛剛定義的 RabbitMQ 連接 URL 配置.

啓動 Celery 服務

(env) jmilkfan@JmilkFan-Devstack:/opt/JmilkFan-s-Blog$ celery worker -A celery_runner --loglevel=info
...

 -------------- celery@JmilkFan-Devstack v4.0.1 (latentcall)
---- **** ----- 
--- * ***  * -- Linux-4.4.0-53-generic-x86_64-with-Ubuntu-16.04-xenial 2016-12-15 19:12:33
-- * - **** --- 
- ** ---------- [config]
- ** ---------- .> app:         jmilkfansblog:0x7f5b24345990
- ** ---------- .> transport:   amqp://guest:**@localhost:5672//
- ** ---------- .> results:     amqp://
- *** --- * --- .> concurrency: 4 (prefork)
-- ******* ---- .> task events: OFF (enable -E to monitor tasks in this worker)
--- ***** ----- 
 -------------- [queues]
                .> celery           exchange=celery(direct) key=celery


[tasks]
  . jmilkfansblog.tasks.digest
  . jmilkfansblog.tasks.log
  . jmilkfansblog.tasks.multiply
  . jmilkfansblog.tasks.remind

NOTE: 在啓動 Celery 服務的時候, 能夠用 Output 看見其自身的配置信息和現在所處理的 tasks.

實現向新用戶發送歡迎郵件

下面使用 Celery 實現在用戶創建賬戶之後, 在指定的時間內異步的向新用戶發送歡迎郵件.

添加 Reminder Model 用戶存放用戶的 email 地址和歡迎內容.
vim jmilkfansblog/models.py

class Reminder(db.Model):
    """Represents Proected reminders."""

    __tablename__ = 'reminders'
    id = db.Column(db.String(45), primary_key=True)
    date = db.Column(db.DateTime())
    email = db.Column(db.String(255))
    text = db.Column(db.Text())

    def __init__(self, id, text):
        self.id = id
        self.email = text

    def __repr__(self):
        return '<Model Reminder `{}`>'.format(self.text[:20])

創建一個 task
vim jmilkfansblog/tasks.py

import smtplib
import datetime
from email.mime.text import MIMEText

from flask_mail import Message

from jmilkfansblog.extensions import flask_celery, mail

@flask_celery.task(
    bind=True,
    igonre_result=True,
    default_retry_delay=300,
    max_retries=5)
def remind(self, primary_key):
    """Send the remind email to user when registered.
       Using Flask-Mail.
    """

    reminder = Reminder.query.get(primary_key)

    msg = MIMEText(reminder.text)
    msg['Subject'] = 'Welcome!'
    msg['FROM'] = <your_email>
    msg['To'] = reminder.email

    try:
        smtp_server = smtplib.SMTP('localhost')
        smtp_server.starttls()
        smtp_server.login(<user>, <password>)
        smtp_server.sendmail(<your_email>,
                             [reminder.email],
                             msg.as_string())
        smtp_server.close()
        return

    except Exception as err:
        self.retry(exc=err)

def on_reminder_save(mapper, connect, self):
    """Callbask for task remind."""
    remind.apply_async(args=(self.id), eta=self.date)

NOTE 1: Celery Task 本質上就是一個被 celery.task()裝飾過的函數,

NOTE 2: 使用主鍵 primary_key 來獲取 reminder 對象是爲了避免數據競態的發生, 因爲從生成 reminder 對象到 task 被執行的過程並不能保證數據是最新的, 這也是處理異步調用時, 需要時刻注意的地方.

NOTE 3: on_reminder_save() 是一個回調函數, 當我們在一個特定的情景下調用這個函數的時候就觸發了一個 Celery task.

應用 SQLAlchemy 的 event 特性來觸發 Celery task
vim jmilkfansblog/__init__.py

from sqlalchemy import event


def create_app(object_name):
    """Create the app instance via `Factory Method`"""
...
    # Will be callback on_reminder_save when insert recond into table `reminder`.
    event.listen(Reminder, 'after_insert', on_reminder_save)

NOTE 1: SQLAlchemy 允許在 Model 上註冊回調函數, 當 Model 對象發生特定的情景時, 就會執行這個回調函數, 這就是所謂的 event, 這裏我們使用 after_insert 來指定當創建一個新的 Reminder 對象(插入一條記錄)時就觸發這個回調函數. 而是回調函數中的形參, 會由 event 來負責傳入.

使用 Flask-Celery-Helper 實現異步任務

目錄

前文列表

擴展閱讀

Celery

將 Celery 加入到應用中

實現向新用戶發送歡迎郵件

Nginx R31 doc 官方文檔-01-nginx 如何安裝

挑戰程序設計競賽 2.2章習題 POJ - 3617 Best Cow Line 貪心

字節面試：MySQL什麼時候鎖表？如何防止鎖表？

.NET8連接SQL SERVER 2008 R2 報：證書鏈是由不受信任的頒發機構頒發的

golang開發環境搭建(win10)

python計算機視覺學習筆記——PIL庫的用法

使用Js/Jquery獲取iframe中的元素

git checkout ： You have local changes cannot switch branches&Entry would be overwritten by mege

windows7 下使用 docker的教程

pip list 和 pip freeze的區別

flask api請求跨域問題解決方法

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結