Flask Signals簡(jiǎn)介

Flask Signals和操作系統(tǒng)的signals系統(tǒng)很類似，都是通過信號(hào)（也可以說是事件event）來通知已經(jīng)注冊(cè)的回調(diào)函數(shù)，讓回調(diào)函數(shù)自動(dòng)開始執(zhí)行。Flask定義了自己的一套核心signals和對(duì)應(yīng)的functions(用于發(fā)起消息，注冊(cè)回調(diào)函數(shù))，我們需要定義自己的回調(diào)函數(shù)，然后注冊(cè)到對(duì)應(yīng)的signal，這樣就可以在收到該信號(hào)的時(shí)候自動(dòng)執(zhí)行我們定義的回調(diào)函數(shù)。

什么情況下需要使用Signals?

當(dāng)我們需要使用觀察者模式來解耦模塊之間的信息傳遞的時(shí)候，Signals系統(tǒng)就可以幫助我們輕松達(dá)到目的。觀察者模式如下圖(圖片來自voidcn)

觀察者模式

與Hook函數(shù)的區(qū)別

試想，當(dāng)我們需要監(jiān)聽某個(gè)事件，當(dāng)它發(fā)生的時(shí)候，需要執(zhí)行一系列functions，來實(shí)現(xiàn)諸如log記錄等功能時(shí)，我們就可以使用Signals系統(tǒng)來實(shí)現(xiàn)，但是這里有一個(gè)疑問就是這個(gè)功能通過hook函數(shù)似乎也可以實(shí)現(xiàn)，比如通過before_request decorator實(shí)現(xiàn)記錄日志的功能和使用request_started來記錄日志就非常相似， 如下代碼所示：

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from flask import Flask, request, request_started
app = Flask(__name__)

@app.before_request
def print_url_in_hook():
    print "in hook, url: %s" % request.url

@app.route("/")
def hello():
    return "Hello, World!"

def print_url_in_signal_subscriber(sender, **extra):
    print "in signal subscriber, url: %s" % request.url

if __name__ == "__main__":
    request_started.connect(print_url_in_signal_subscriber, app)
    app.run()

當(dāng)收到http請(qǐng)求后，打印如下：

in signal subscriber, url: http://localhost:5000/
in hook, url: http://localhost:5000/
127.0.0.1 - - [05/Oct/2017 16:57:20] "GET / HTTP/1.1" 200 -

那么到底什么情況下使用signal，什么情況下使用hook函數(shù)呢？我們來看下它們的主要區(qū)別：

1. signal的callback函數(shù)是無順序的，而hook函數(shù)的執(zhí)行是按照定義的順序執(zhí)行的。（這一點(diǎn)雖然是官網(wǎng)提出的區(qū)別，但是實(shí)際測(cè)試發(fā)現(xiàn)signal執(zhí)行實(shí)際是按照注冊(cè)的順序執(zhí)行的，即先通過connect進(jìn)行注冊(cè)的回調(diào)函數(shù)會(huì)先被執(zhí)行）
2. signal無法直接abort這個(gè)request請(qǐng)求，相比較在hook函數(shù)中可以直接abort request，即直接返回response給客戶端，而無需再執(zhí)行后續(xù)的操作。
3. signal可以通過參數(shù)攜帶數(shù)據(jù)，而hook函數(shù)通常不會(huì)攜帶額外的參數(shù)

與RabbitMQ等消息中間件的區(qū)別

Rabbitmq與signals都支持觀察者模式，但是它們的區(qū)別也是很明顯的：

1. Rabbitmq之類的消息中間件更加重量級(jí)，提供更多功能，如分布式部署，消息存儲(chǔ)備份等功能，而signal系統(tǒng)顯然更加輕量級(jí)，只提供簡(jiǎn)單的消息分發(fā)功能
2. Rabbitmq之類的消息中間件可以在不同的系統(tǒng)間傳遞消息，從而使得不同的功能模塊可以使用不同的語言進(jìn)行開發(fā)，而signal系統(tǒng)顯然僅限于Flask系統(tǒng)中使用

顯然，signal系統(tǒng)使用局限性更大，但也更加輕量級(jí)，在只是簡(jiǎn)單的進(jìn)行消息分發(fā)的系統(tǒng)中，使用signal更加簡(jiǎn)單方便

怎么使用Signals?

Flask提供的signal機(jī)制優(yōu)先使用blinker提供的庫，但當(dāng)blinker沒有安裝的時(shí)候，F(xiàn)lask也可以回退到使用自己的庫。但是鑒于官網(wǎng)推薦使用blinker，所以我們最好還是安裝blinker。

使用blinker

安裝blinker

pip install blinker

測(cè)試Flask signal是否使用blinker

In [1]: from flask import signals

In [2]: signals.signals_available
Out[2]: True

當(dāng)signals.signals_available返回True時(shí)，說明使用的是Blinker庫

使用Flask Built-in signals

Flask內(nèi)置有多個(gè)signals可以直接使用，這些signals會(huì)自動(dòng)emit(發(fā)射)，我們只需要定義自己的回調(diào)函數(shù)，然后通過connect方式來subscribe我們定義的函數(shù)到對(duì)應(yīng)的signal即可監(jiān)聽該signal

下表展示了Flask內(nèi)置的Signals，詳細(xì)請(qǐng)參考Flask built-in signals:

之前的例子我們已經(jīng)看到如何使用request_started signal了，這里需要說明兩點(diǎn)：

1. 在定義回調(diào)函數(shù)時(shí)，第一個(gè)參數(shù)必須是sender對(duì)象（即發(fā)送該signal的對(duì)象），第二個(gè)參數(shù)**extra用于接受額外的參數(shù)，也防止將來Flask在發(fā)送signal時(shí)添加新的參數(shù)。
2. 使用connect注冊(cè)回調(diào)函數(shù)時(shí)，第一個(gè)參數(shù)是回調(diào)函數(shù)，這個(gè)是必須的，第二參數(shù)是sender對(duì)象，是可選的，但最佳實(shí)踐是要明確發(fā)送該signal的對(duì)象

另外，我們也可以臨時(shí)性注冊(cè)一個(gè)回調(diào)函數(shù)，這個(gè)尤其在進(jìn)行單元測(cè)試時(shí)非常有用，因?yàn)槲覀儾幌朐趯?shí)際程序中添加測(cè)試相關(guān)的回調(diào)函數(shù)，因此需要一種機(jī)制在測(cè)試完成后，再取消注冊(cè)該回調(diào)函數(shù)，有兩種方式可以此種臨時(shí)注冊(cè)的機(jī)制：

• 一種是通過contextmanagerdecorator和disconnect函數(shù)一起來實(shí)現(xiàn)，如下：

from flask import template_rendered
from contextlib import contextmanager

@contextmanager
def captured_templates(app):
    recorded = []
    def record(sender, template, context, **extra):
        recorded.append((template, context))
    # 當(dāng)使用with關(guān)鍵字進(jìn)入with context時(shí)，自動(dòng)注冊(cè)record函數(shù)到template_rendered signal
    template_rendered.connect(record, app)
    try:
        yield recorded
    finally:
        # with context結(jié)束時(shí)會(huì)自動(dòng)調(diào)用disconnect函數(shù)來解除注冊(cè)
        template_rendered.disconnect(record, app)

使用時(shí)代碼如下：

with captured_templates(app) as templates:
    rv = app.test_client().get('/')
    assert rv.status_code == 200
    assert len(templates) == 1
    template, context = templates[0]
    assert template.name == 'index.html'
    assert len(context['items']) == 10

• 另外一種方式是使用connect_to函數(shù)

from flask import template_rendered

def captured_templates(app, recorded, **extra):
    def record(sender, template, context):
        recorded.append((template, context))
    return template_rendered.connected_to(record, app)

使用時(shí)代碼如下：

templates = []
with captured_templates(app, templates, **extra):
    ...
    template, context = templates[0]

自定義signals的使用

自定義signal

當(dāng)我們需要自定義signal時(shí)，我們可以直接使用blinker庫

1. 首先定義一個(gè)namespace

from blinker import Namespace
my_signals = Namespace()

2. 使用我們自定義的namespace定義自己的signal

upload_image_finished = my_signals.signal('upload_image_finished')

至此，我們就定義了一個(gè)signal，名為upload_image_finished

發(fā)射自定義signal

from flask import current_app

def upload_image(image_path, upload_url):
    # upload image code
    ...
    # after upload image
    upload_image_finished.send(current_app._get_current_object())

• 當(dāng)在類的method中使用send函數(shù)發(fā)射signal時(shí)，我們可以選擇該類的對(duì)象作為sender對(duì)象，因此直接使用self作為參數(shù)，但是當(dāng)我們不是在類的method當(dāng)中，或者我們想讓應(yīng)用對(duì)象作為sender，那么我們就需使用如上代碼所示的current_app._get_current_object()來獲取應(yīng)用對(duì)象
• 使用sender時(shí)，第一個(gè)參數(shù)是sender對(duì)象，是必選的。其余實(shí)際我們還可以傳遞更多參數(shù)(記得我們的callback函數(shù)使用了**extra), 這樣的話我們實(shí)際就擁有了傳遞更多數(shù)據(jù)的能力。

注冊(cè)回調(diào)函數(shù)的簡(jiǎn)化寫法

從文章的第一個(gè)示例可以看出我們需要通過調(diào)用connect函數(shù)來對(duì)回調(diào)函數(shù)進(jìn)行注冊(cè), 其實(shí)還有一個(gè)簡(jiǎn)化的寫法可以把回調(diào)函數(shù)的定義和注冊(cè)過程結(jié)合在一起，如下：

from flask import template_rendered

@template_rendered.connect_via(app)
def when_template_rendered(sender, template, context, **extra):
    print 'Template %s is rendered with %s' % (template.name, context)

通過connect_via裝飾器來簡(jiǎn)化回調(diào)函數(shù)定義和注冊(cè)的過程

Reference

• Flask Signals
• Blinker Doc