Django 信號

信號

Django 提供一個「信號分發器」,容許解耦的應用在框架的其它地方發生操做時會被通知到。 簡單來講,信號容許特定的sender通知一組receiver某些操做已經發生。 這在多處代碼和同一事件有關聯的狀況下頗有用。數據庫

內置信號

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          # 建立數據庫鏈接時,自動觸發

使用信號

對於Django內置的信號,僅需註冊指定信號,當程序執行相應操做時,系統會自動觸發註冊函數django

指定 Receiver函數

Receiver能夠是任何Python函數或者方法app

被指定觸發信號的時候進行的函數操做就能夠被做爲是 Receiver 框架

好比下面例子中的 my_callback 方法函數

def my_callback(sender, **kwargs):
    print(sender)
    print(kwargs)
    print("要保存了啊!")
    print('-' * 120)

監聽信號

一旦某個指定信號觸發,就執行我指定的receiver函數。post

咱們如今的需求是,模型層一執行保存的動做就作什麼事。測試

因此應該是一旦觸發 pre_save 信號就執行 my_callback,對於內置的信號Django框架會自動幫咱們觸發,咱們只須要告訴它信號觸發以後作什麼事就能夠了:spa

pre_save.connect(my_callback)

接下來,只要涉及到ORM的save()操做,都會自動執行我定義的my_callback函數了。code

例如:對象

a3 = Author.objects.create(name='測試信號-做者')
b3 = Book.objects.create(title='測試信號-書')

輸出:

複製代碼
<class 'app02.models.Author'>
{'signal': <django.db.models.signals.ModelSignal object at 0x108e0d198>, 'instance': <Author: 測試信號-做者>, 'raw': False, 'using': 'default', 'update_fields': None}
要保存了啊!
------------------------------------------------------------------------------------------------------------------------
(0.001) SELECT @@SQL_AUTO_IS_NULL; args=None
(0.001) INSERT INTO `app02_author` (`name`) VALUES ('測試信號-做者'); args=['測試信號-做者']
<class 'app02.models.Book'>
{'signal': <django.db.models.signals.ModelSignal object at 0x108e0d198>, 'instance': <Book: 測試信號-書>, 'raw': False, 'using': 'default', 'update_fields': None}
要保存了啊!
------------------------------------------------------------------------------------------------------------------------
(0.001) INSERT INTO `app02_book` (`title`) VALUES ('測試信號-書'); args=['測試信號-書']
複製代碼

使用裝飾器方式監聽信號

複製代碼
# 使用裝飾器方式
from django.db.models.signals import pre_save
from django.dispatch import receiver


@receiver(pre_save)
def my_callback(sender, **kwargs):
    print(sender)
    print(kwargs)
    print("要保存了啊!")
    print('-' * 120)
複製代碼

自定義信號

上面列出來的都是Django框架內置的信號,固然咱們還能夠自定義信號。

定義信號

全部信號都是 django.dispatch.Signal 的實例。

providing_args是一個列表,由信號將提供給監聽者的參數名稱組成。 理論上是這樣,可是實際上並無任何檢查來保證向監聽者提供了這些參數。

舉個例子:

# 自定義信號
from django.dispatch import Signal

bath_done = Signal(providing_args=['amount', 'temperature'])

這裏定義了一個洗澡水燒好了的信號,它接受兩個參數:amount表示水量,temperature表示溫度。

註冊receiver

複製代碼
from django.dispatch import receiver

@receiver(bath_done)
def my_action(sender, **kwargs):
    print(sender)
    print(kwargs)
    print('脫衣服泡個澡吧!')
複製代碼

觸發信號

斯嘉麗燒好了一浴缸40度的洗澡水,杜蘭特要開喝了。

bath_done.send(sender='斯嘉麗', amount='一浴缸', temperature='40°')
相關文章
相關標籤/搜索