Flask Signals 入門

Flask Signals 入門

本文首發于Gevin的博客

原文鏈接:Flask Signals 入門

未經 Gevin 授權,禁止轉載

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=selffunctionsender=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_viaconnect也可以,即:


@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使用的小案例,如果大家有好的應用場景,歡迎給我留言~

點擊獲取轉載授權

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,224評論 6 529
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 97,916評論 3 413
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,014評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,466評論 1 308
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,245評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,795評論 1 320
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,869評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,010評論 0 285
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,524評論 1 331
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,487評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,634評論 1 366
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,173評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,884評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,282評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,541評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,236評論 3 388
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,623評論 2 370

推薦閱讀更多精彩內容