Flask 提供了信號(hào)(Signals)功能，是一種消息分發(fā)機(jī)制。類似于鉤子(Hooks)。使用信號(hào)功能可以降低程序的耦合，分解復(fù)雜的業(yè)務(wù)模型。例如在更新了產(chǎn)品數(shù)據(jù)后，可以發(fā)送一個(gè)信號(hào)。當(dāng)有需要對(duì)產(chǎn)品數(shù)據(jù)進(jìn)行處理的功能時(shí)，就可以捕獲信號(hào)進(jìn)行處理。比如要建立產(chǎn)品緩存，或是更新搜索索引等。
定義信號(hào)
Flask 信號(hào)功能使用了 Blinker 模塊，所以需要先安裝 Blinker 模塊
|
1
|
pip install blinker |
定義一個(gè)信號(hào):
|
1
2
|
from blinker import Namespaceproduct_saved = Namespace() |
也可以使用 Flask 包裝的 singles 對(duì)象:
|
1
|
from flask.singles import Namespace |
發(fā)送信號(hào)
發(fā)送信號(hào)需要帶上 app 實(shí)例方法，示例如下：
|
1
|
product_saved.send(app, product=product) |
app 后面可以添加要傳遞的參數(shù)，但必須以 name=value 的格式，不支持使用單個(gè)變量名的方式。
收接信號(hào)
接收信號(hào)可以使用 connect_via 裝飾器函數(shù):
|
1
2
3
|
@product_saved.connect_via(app)def updateCache(app, product): print(product) |
Flask 中有以下核心信號(hào):
1.flask.template_rendered
這個(gè)信號(hào)發(fā)送于一個(gè)模板被渲染成功后。信號(hào)傳遞的template是模板的實(shí)例，context是環(huán)境對(duì)象是一個(gè)字典。
訂閱示例:
|
1
2
3
4
5
6
|
def log_template_renders(sender, template, context, **extra): sender.logger.debug('Rendering template "%s" with context %s', template.name or 'string template', context)from flask import template_renderedtemplate_rendered.connect(log_template_renders, app) |
2.flask.request_started
這個(gè)信號(hào)發(fā)送于請(qǐng)求開(kāi)始之前，且請(qǐng)求環(huán)境設(shè)置完成之后。因?yàn)檎?qǐng)求環(huán)境已經(jīng)綁定， 所以訂閱者可以用標(biāo)準(zhǔn)的全局代理，如 request 來(lái)操作請(qǐng)求。
訂閱示例:
|
1
2
3
4
5
|
def log_request(sender, **extra): sender.logger.debug('Request context is set up')from flask import request_startedrequest_started.connect(log_request, app)flask.request_finished |
這個(gè)信號(hào)發(fā)送于向客戶端發(fā)送響應(yīng)之前。信號(hào)傳遞的response為將要發(fā)送的響應(yīng)。
訂閱示例:
|
1
2
3
4
5
6
|
def log_response(sender, response, **extra): sender.logger.debug('Request context is about to close down. ' 'Response: %s', response)from flask import request_finishedrequest_finished.connect(log_response, app)flask.got_request_exception |
這個(gè)信號(hào)發(fā)送于請(qǐng)求進(jìn)行中發(fā)生異常的時(shí)候。它的發(fā)送 早于 標(biāo)準(zhǔn)異常處理介于。 在調(diào)試模式下，雖然沒(méi)有異常處理，但發(fā)生異常時(shí)也發(fā)送這個(gè)信號(hào)。信號(hào)傳遞的exception是異常對(duì)象。
訂閱示例:
|
1
2
3
4
5
|
def log_exception(sender, exception, **extra): sender.logger.debug('Got exception during processing: %s', exception)from flask import got_request_exceptiongot_request_exception.connect(log_exception, app)flask.request_tearing_down |
這個(gè)信號(hào)發(fā)送于請(qǐng)求崩潰的時(shí)候，不管是否引發(fā)異常。目前，偵聽(tīng)此信號(hào)的函數(shù)在一般 崩潰處理器后調(diào)用，但是沒(méi)有什么東西可用。
訂閱示例:
|
1
2
3
|
def close_db_connection(sender, **extra): session.close()from flask import appcontext_tearing_downrequest_tearing_down.connect(close_db_connection, app) |
在 Flask 版本 0.9 中，這還會(huì)傳遞一個(gè)exc關(guān)鍵字參數(shù)，如果這個(gè)參數(shù)存在的話。 這個(gè)參數(shù)是引發(fā)崩潰的異常的引用。
3.flask.appcontext_tearing_down
當(dāng)應(yīng)用環(huán)境崩潰時(shí)發(fā)送這個(gè)信號(hào)。這個(gè)信號(hào)總是會(huì)發(fā)送，甚至是因?yàn)橐粋€(gè)異常引發(fā)的 崩潰。偵聽(tīng)這個(gè)信號(hào)的函數(shù)會(huì)在常規(guī)崩潰處理器后被調(diào)用，但是你無(wú)法回饋這個(gè)信號(hào)。
訂閱示例:
|
1
2
3
|
def close_db_connection(sender, **extra): session.close()from flask import request_tearing_downappcontext_tearing_down.connect(close_db_connection, app) |
這還會(huì)傳遞一個(gè)exc關(guān)鍵字參數(shù)，如果這個(gè)參數(shù)存在的話。這個(gè)參數(shù)是引發(fā)崩潰的 異常的引用。
4.flask.appcontext_pushed
當(dāng)一個(gè)應(yīng)用的環(huán)境被壓入時(shí)，應(yīng)用會(huì)發(fā)送這個(gè)信號(hào)。這個(gè)信號(hào)通常用于在單元測(cè)試中 臨時(shí)鉤接信息。例如可以用于改變g對(duì)象中現(xiàn)存的資源。
用法示例:
|
1
2
3
4
5
6
7
|
from contextlib import contextmanagerfromflask import appcontext_pushed@contextmanagerdef user_set(app, user): def handler(sender, **kwargs): g.user = user with appcontext_pushed.connected_to(handler, app): yield |
在測(cè)試代碼中這樣寫(xiě):
|
1
2
3
4
5
6
|
def test_user_me(self): with user_set(app, 'john'): c = app.test_client() resp = c.get('/users/me') assert resp.data == 'username=john'New in version 0.10. |
5.appcontext_popped
當(dāng)一個(gè)應(yīng)用的環(huán)境被彈出時(shí)，應(yīng)用會(huì)發(fā)送這個(gè)信號(hào)。這個(gè)信號(hào)通常寫(xiě)成appcontext_tearing_down 信號(hào)。
6.flask.message_flashed
當(dāng)應(yīng)用閃現(xiàn)一個(gè)消息時(shí)會(huì)發(fā)出這個(gè)信號(hào)。message`參數(shù)是消息內(nèi)容， `category參數(shù)是消息類別。
訂閱示例:
|
1
2
3
4
|
recorded = []def record(sender, message, category, **extra): recorded.append((message, category))from flask import message_flashedmessage_flashed.connect(record, app) |
小結(jié)
信號(hào)可以讓你在一瞬間安全地訂閱它們。例如，這些臨時(shí)的訂閱對(duì)測(cè)試很有幫助。使用信號(hào)時(shí)，不要讓信號(hào)訂閱者（接收者）發(fā)生異常，因?yàn)楫惓?huì)造成程序中斷。
