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