Flask Signals 入門

本文首發於Gevin的博客

原文連接：Flask Signals 入門

未經 Gevin 受權，禁止轉載

Flask Signals 入門

1. 如何理解Flask Signals

Flask Signal很是簡單易用，能大大下降代碼的耦合度，也可以讓基於Flask開發的系統更加健壯。然而，雖然Flask Signal上手很容易，但它卻不是Flask開發中一個入門級的功能，也不是每一個開發者都會想到去使用的功能，這主要是因爲不理解這個機制形成的。所以，使用Flask Signal前，首先要理解Flask Signal是什麼。

什麼是Signal？Flask官方文檔的描述的過於言簡意賅，資深開發者可以立刻明白，而初學者恐怕摸不到頭腦，所以Gevin對官方文檔的描述作簡單擴展：Signal用於解耦系統的行爲和業務邏輯，這種解耦是經過當某些行爲被觸發時，自動發送定義好的一種信號，與這個信號綁定的一些業務邏輯或行爲，接收到這個信號後，會自動執行各自相應的業務邏輯。與該信號綁定的業務邏輯，能夠是事先預約義好的，也能夠是在後續開發中隨需求變更新增上去的，基於signal的機制，系統會更加穩定和易於擴展，也使得系統的業務邏輯更加清晰 —— 當某個行爲觸發時，發送一個信號便可，全部與該行爲有關的業務邏輯或行爲都會自動觸發，從而實現瞭解耦。換句話說，Flask Signal是觀察者模式的一種實現，它使得咱們開發的系統，更加符合開閉原則。

『設計模式』既是編碼典型問題的經典解決方案，也算是一種『行話』，不是代碼初學者須要接觸的內容，因此才致使了Flask Signal對資深開發者和初學者而言，在理解上出現這麼大的差別。理解了Signal的本質，使用就不是問題了，若是Gevin的解釋還沒法讓你理解，恐怕你要從『觀察者模式』入手了，但Gevin建議，沒有足夠的代碼積累，不要過早接觸太多設計模式，不然無異於揠苗滋長。

2. Flask Signals的使用

Flask signal的使用很是簡單，Flask 官方文檔把signal介紹的過於複雜，不利於入門，在理解了signal後，只要學會如下幾點即可以輕鬆掌握signal的使用。

（1）Signal的建立

Signal的建立只需下面3行代碼便可完成：

from blinker import Namespace
my_signals = Namespace()
model_saved = my_signals.signal('model-saved')複製代碼

（2）Signal的發送

Signal的發送經過成員函數 send()便可完成，send()函數的第一個參數爲signal的sender，在class中發送signal和在function中傳遞的sender參數略有不一樣，class中sender=self，function中sender=current_app._get_current_object()，即：

# In case send signal in a class:
class Model(object):
    ...

    def save(self):
        model_saved.send(self)


# In case send signal in a function:
def save_model():
    ...

    model_saved.send(current_app._get_current_object())複製代碼

sender()函數除了sender參數外，還能夠添加多個可選參數，這些可選參數是爲signal的訂閱者使用的，具體例子見下一小節。

（3）編寫Signal的訂閱者

Signal的訂閱者是一些訂閱了指定signal（如上文中的model_saved）的函數，當signal被激活（即調用send()函數發送signal）時，會自動觸發這些訂閱者的調用，以完成某些功能。將一個普通函數變爲signal的訂閱函數很是簡單，只要加一個decorator便可，仍以上面signal爲例，定義一個訂閱者方法以下：

@model_saved.connect_via(app)
def on_model_saved():
    # do something ...複製代碼

對於大型項目，代碼組織比較複雜，也許app是在系統運行時建立的，上面代碼中的app能夠用current_app._get_current_object()取代。

除了connect_via，connect也能夠，即：

@model_saved.connect
def on_model_saved():
    # do something ...複製代碼

若是訂閱者函數有參數，須要在發送signal時，將相關參數做爲signal.send()函數的可選參數傳入，這樣訂閱者函數能夠接收到相應參數，舉個詳細的例子：

from blinker import Namespace
from . import models

# Define a signal
octblog_signals = Namespace()
post_visited = octblog_signals.signal('post-visited')


# Define a subscriber
@post_visited.connect
def on_post_visited(sender, post, **extra):
    tracker = models.Tracker()
    tracker.post = post

    ...

    tracker.save()

# Emit signal in a function 
def post_detail(slug, is_preview=False):
    post = models.Post.objects.get_or_404(slug=slug, post_type=post_type)
    data['post'] = post

    # do something
    ...

    # send signal
    if not is_preview:
        signals.post_visited.send(current_app._get_current_object(), post=post)

    ...複製代碼

總結

Flask Signal上手簡單，功能強大，最關鍵的是它可以解耦業務和行爲，使代碼的邏輯更簡潔，推薦使用。

稍後有時間我會在GitHub上放一個簡單但完整的Flask Signal使用的小案例，若是你們有好的應用場景，歡迎給我留言~