信號(hào)機(jī)制 Signal

Django 提供一個(gè)“信號(hào)分發(fā)器”,允許解耦的應(yīng)用在框架的其它地方發(fā)生操作時(shí)會(huì)被通知到。簡(jiǎn)單來(lái)說(shuō),信號(hào)允許若干 sender(寄件人)通知一組 receiver(接收者)某些操作已經(jīng)發(fā)生。這在多處代碼和同一事件有關(guān)聯(lián)的情況下很有用。
Django 提供一組內(nèi)建信號(hào)面哥,允許用戶的代碼獲得 Django 特定操作的通知。這包含一些有用的通知:

  • django.db.models.signals.pre_save
    django.db.models.signals.post_save
    在模型 save() 方法調(diào)用之前或之后發(fā)送毅待。

  • django.db.models.signals.pre_delete
    django.db.models.signals.post_delete
    在模型 delete() 方法或查詢集的 delete() 方法調(diào)用之前或之后發(fā)送尚卫。

  • django.db.models.signals.m2m_changed
    模型上的 ManyToManyField 修改時(shí)發(fā)送。

  • django.core.signals.request_started
    django.core.signals.request_finished
    Django 建立或關(guān)閉 HTTP 請(qǐng)求時(shí)發(fā)送尸红。

自定義信號(hào)

class Signal([providing_args=list])?

所有信號(hào)都是 django.dispatch.Signal 的實(shí)例吱涉。providing_args 是一個(gè)參數(shù)名稱列表,實(shí)際上這些參數(shù)并沒(méi)有多大用處外里。
例如:

from django.dispatch import Signal

pizza_done = Signal(providing_args=["toppings", "size"])

這段代碼聲明了 pizza_done 信號(hào)怎爵,它向接受者提供 toppings 和 size 參數(shù)。

Receiver 函數(shù)

receiver 相當(dāng)于一個(gè)回調(diào)函數(shù)盅蝗,相關(guān)事件發(fā)生了就會(huì)觸發(fā)它被執(zhí)行鳖链。

def my_callback(sender, **kwargs):
    print "Request finished!"

注意:函數(shù)接受一個(gè) sender 參數(shù),以及通配符關(guān)鍵字參數(shù)(**kwargs)墩莫;所有信號(hào)處理器都必須接受這些參數(shù)芙委。

可是每次取值都得從 kwargs 中取,看起來(lái)可讀性也變差了狂秦。個(gè)人用法是函數(shù)中經(jīng)常會(huì)用到的參數(shù)直接列出來(lái)灌侣,比如:

def my_callback(sender, instance, created, **kwargs):
    pass

接下來(lái),要做的就是綁定 receiver 到 signal裂问,有兩種方法可以將一個(gè)接收器連接到信號(hào)侧啼。

  • 手動(dòng)連接:
from django.core.signals import request_finished

request_finished.connect(my_callback)
  • 使用 receiver 裝飾器來(lái)自動(dòng)連接:
receiver(signal)
    Parameters: signal – A signal or a list of signals to connect a function to.?
from django.core.signals import request_finished
from django.dispatch import receiver

@receiver(request_finished)
def my_callback(sender, **kwargs):
    print "Request finished!"

現(xiàn)在玖姑,我們的 my_callback 函數(shù)會(huì)在每次請(qǐng)求結(jié)束時(shí)調(diào)用。
當(dāng)你這么設(shè)置好了后慨菱,就會(huì)收到各種 signals 發(fā)來(lái)的通知〈魉Γ可是符喝,如果我的回調(diào)函數(shù)只對(duì)特定 sender 感興趣的話怎么辦呢?可以通過(guò)指定 connect 函數(shù)的 sender 參數(shù)來(lái)過(guò)濾:

Signal.connect(receiver[, sender=None, weak=True, dispatch_uid=None])
    Parameters: 
        receiver – 和這個(gè)信號(hào)連接的回調(diào)函數(shù)
        sender – 指定一個(gè)特定的 sender甜孤,來(lái)從它那里接受信號(hào)
        weak – Django 通常以弱引用儲(chǔ)存信號(hào)處理器协饲。這就是說(shuō),如果你的 receiver 是個(gè)局部變量缴川,可能會(huì)被垃圾回收茉稠。當(dāng)你調(diào)用信號(hào)的 connect()方法時(shí),傳遞 weak=False 來(lái)防止這樣做
        dispatch_uid – 一個(gè)信號(hào) receiver 的唯一標(biāo)識(shí)符把夸,以防信號(hào)多次發(fā)送而线,通常是一個(gè)字符串? 

使用裝飾器方式過(guò)濾:

from django.db.models.signals import pre_save
from django.dispatch import receiver
from myapp.models import MyModel


@receiver(pre_save, sender=MyModel)
def my_handler(sender, **kwargs):
    ... 

my_handler 函數(shù)只在 MyModel 實(shí)例保存時(shí)被調(diào)用。

發(fā)送信號(hào)

Django 中有兩種方法用于發(fā)送信號(hào):

Signal.send(sender, **kwargs)

Signal.send_robust(sender, **kwargs)

調(diào)用 Signal.send() 或者 Signal.send_robust() 來(lái)發(fā)送信號(hào)恋日。你必須提供 sender 參數(shù)(大多數(shù)情況下它是一個(gè)類)膀篮,并且可以提供盡可能多的關(guān)鍵字參數(shù)。

例如岂膳,這樣來(lái)發(fā)送我們的 pizza_done 信號(hào):

class PizzaStore(object):
    ...

    def send_pizza(self, toppings, size):
        pizza_done.send(sender=self.__class__, toppings=toppings, size=size)
        ...

send() 和 send_robust() 都會(huì)返回一個(gè)含有二元組的列表 [(receiver, response), ...
]誓竿,它代表了被調(diào)用的接收器函數(shù)和他們的響應(yīng)值。

send() 與 send_robust() 在處理 receiver 函數(shù)產(chǎn)生的異常時(shí)有所不同谈截。send() 不會(huì)捕獲任何由 receiver 產(chǎn)生的異常筷屡。它會(huì)簡(jiǎn)單地讓錯(cuò)誤往上傳遞。所以在錯(cuò)誤產(chǎn)生的情況簸喂,不是所有 receiver 都會(huì)獲得通知毙死。

send_robust() 捕獲所有繼承自 Python Exception 類的異常,并且確保所有 receiver 都能得到信號(hào)的通知娘赴。如果發(fā)生錯(cuò)誤规哲,錯(cuò)誤實(shí)例會(huì)在產(chǎn)生錯(cuò)誤的 receiver 的二元組中返回。

斷開(kāi)信號(hào)

Signal.disconnect([receiver=None, sender=None, weak=True, dispatch_uid=None])

調(diào)用 Signal.disconnect() 來(lái)斷開(kāi)信號(hào)的接收器诽表。 Signal.connect() 中描述了所有參數(shù)唉锌。如果接收器成功斷開(kāi),返回 True 竿奏,否則返回 False袄简。

receiver 參數(shù)表示要斷開(kāi)的已注冊(cè) receiver。如果使用 dispatch_uid 標(biāo)識(shí) receiver泛啸,它可以為 None绿语。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子吕粹,更是在濱河造成了極大的恐慌种柑,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,284評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件匹耕,死亡現(xiàn)場(chǎng)離奇詭異聚请,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)稳其,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén)驶赏,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人既鞠,你說(shuō)我怎么就攤上這事煤傍。” “怎么了嘱蛋?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,614評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵蚯姆,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我浑槽,道長(zhǎng)蒋失,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,671評(píng)論 1 293
  • 正文 為了忘掉前任桐玻,我火速辦了婚禮篙挽,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘镊靴。我一直安慰自己铣卡,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,699評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布偏竟。 她就那樣靜靜地躺著煮落,像睡著了一般。 火紅的嫁衣襯著肌膚如雪踊谋。 梳的紋絲不亂的頭發(fā)上蝉仇,一...
    開(kāi)封第一講書(shū)人閱讀 51,562評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音殖蚕,去河邊找鬼轿衔。 笑死,一個(gè)胖子當(dāng)著我的面吹牛睦疫,可吹牛的內(nèi)容都是我干的害驹。 我是一名探鬼主播,決...
    沈念sama閱讀 40,309評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼蛤育,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼宛官!你這毒婦竟也來(lái)了葫松?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,223評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤底洗,失蹤者是張志新(化名)和其女友劉穎腋么,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體亥揖,經(jīng)...
    沈念sama閱讀 45,668評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡党晋,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,859評(píng)論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了徐块。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,981評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡灾而,死狀恐怖胡控,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情旁趟,我是刑警寧澤昼激,帶...
    沈念sama閱讀 35,705評(píng)論 5 347
  • 正文 年R本政府宣布,位于F島的核電站锡搜,受9級(jí)特大地震影響橙困,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜耕餐,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,310評(píng)論 3 330
  • 文/蒙蒙 一凡傅、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧肠缔,春花似錦夏跷、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,904評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至趟妥,卻和暖如春猫态,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背披摄。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,023評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工亲雪, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人行疏。 一個(gè)月前我還...
    沈念sama閱讀 48,146評(píng)論 3 370
  • 正文 我出身青樓匆光,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親酿联。 傳聞我的和親對(duì)象是個(gè)殘疾皇子终息,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,933評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容