3分鐘看懂Python后端必須知道的Django的信號機制
概念
django自帶一套信號機制來幫助我們在框架的不同位置之間傳遞信息。也就是說,當某一事件發生時,信號系統可以允許一個或多個發送者(senders)將通知或信號(signals)發送給一組接受者(receivers)。
(感覺就很像Qt的信號與槽機制)
信號系統包含以下三要素:
發送者-信號的發出方 信號-信號本身 接收者-信號的接受者Django內置了一整套信號,下面是一些比較常用的:
Django內置信號
Model signals pre_init # django的modal執行其構造方法前,自動觸發 post_init # django的modal執行其構造方法后,自動觸發 pre_save # django的modal對象保存前,自動觸發 post_save # django的modal對象保存后,自動觸發 pre_delete # django的modal對象刪除前,自動觸發 post_delete # django的modal對象刪除后,自動觸發 m2m_changed # django的modal中使用m2m字段操作第三張表(add,remove,clear)前后,自動觸發 class_prepared # 程序啟動時,檢測已注冊的app中modal類,對于每一個類,自動觸發Management signals pre_migrate # 執行migrate命令前,自動觸發 post_migrate# 執行migrate命令后,自動觸發Request/response signals request_started # 請求到來前,自動觸發 request_finished # 請求結束后,自動觸發 got_request_exception # 請求異常后,自動觸發Test signals setting_changed # 使用test測試修改配置文件時,自動觸發 template_rendered # 使用test測試渲染模板時,自動觸發Database Wrappers connection_created # 創建數據庫連接時,自動觸發
在ORM模型的save()方法調用之前或之后發送信號
django.db.models.signals.pre_savedjango.db.models.signals.post_save
在ORM模型或查詢集的delete()方法調用之前或之后發送信號。
django.db.models.signals.pre_deletedjango.db.models.signals.post_delete
當多對多字段被修改時發送信號。
django.db.models.signals.m2m_changed
當接收和關閉HTTP請求時發送信號。
django.core.signals.request_starteddjango.core.signals.request_finished
這就很方便了,想象一下這樣一個情景,我們引入了一個第三方的Django庫,他會創建模型,我們想要在不修改他的代碼的情況下,在他創建模型的時候同時修改其他表的數據,那么這時候信號機制就能派上用場了。
簡單使用例子信號監聽有兩種方式,一種是 Signal.connect() 方法,一種是裝飾器。
Signal.connect()方法
方法原型:
Signal.connect(receiver, sender=None, weak=True, dispatch_uid=None)[source]
參數:
receiver :當前信號連接的回調函數,也就是處理信號的函數。 sender :指定從哪個發送方接收信號。 weak : 是否弱引用 dispatch_uid :信號接收器的唯一標識符,以防信號多次發送。裝飾器法
from django.core.signals import request_finishedfrom django.dispatch import receiver@receiver(request_finished)def my_callback(sender, **kwargs): print('Request finished!')
可以給 receiver 添加 sender 參數來篩選接收哪個模型產生的信號,比如:
from django.db.models import signalsfrom django.dispatch import receiver@receiver(signals.post_save, sender=MyModel)def demo_callback(sender: MyModel, instance: MyModel, **kwargs): pass
注意要讀取傳入的模型對象一定是要用 instance 參數,不是 sender ! sender 是一個類型!
設置dispatch_uid參數防止重復信號為了防止重復信號,可以設置dispatch_uid參數來標識你的接收器,標識符通常是一個字符串,如下所示:
from django.core.signals import request_finishedrequest_finished.connect(my_callback, dispatch_uid='my_unique_identifier')
斷開信號
在滿足某些條件下,我們不再需要監聽信號,可以選擇斷開信號。
Signal.disconnect()用來斷開信號的接收器。和Signal.connect()中的參數相同。如果接收器成功斷開,返回True,否則返回False。
Signal.disconnect(receiver=None, sender=None, dispatch_uid=None)[source]
后記
最近剛入職項目很多特別的忙,也學到了很多新技術,但是感覺已經好久沒有時間來好好寫一篇博客了,就算是本文也是短時間拼湊的,真是難呀,周末得好好整理一下最近的技術筆記。
關于Django信號機制的更多內容(自定義信號等),可以參考官方文檔。 https://docs.djangoproject.com/en/3.0/topics/signals/
到此這篇關于3分鐘看懂Python后端必須知道的Django的信號機制的文章就介紹到這了,更多相關Django 信號機制內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網!
相關文章:
