3分鐘看懂Python後端必須知道的Django的訊號機制!
阿新 • • 發佈:2020-07-24
## 概念
>django自帶一套訊號機制來幫助我們在框架的不同位置之間傳遞資訊。也就是說,當某一事件發生時,訊號系統可以允許一個或多個傳送者(senders)將通知或訊號(signals)傳送給一組接受者(receivers)。
(感覺就很像Qt的訊號與槽機制)
訊號系統包含以下三要素:
- 傳送者-訊號的發出方
- 訊號-訊號本身
- 接收者-訊號的接受者
Django內建了一整套訊號,下面是一些比較常用的:
#### 在ORM模型的save()方法呼叫之前或之後傳送訊號
```
django.db.models.signals.pre_save
django.db.models.signals.post_save
```
#### 在ORM模型或查詢集的delete()方法呼叫之前或之後傳送訊號。
```
django.db.models.signals.pre_delete
django.db.models.signals.post_delete
```
#### 當多對多欄位被修改時傳送訊號。
```
django.db.models.signals.m2m_changed
```
#### 當接收和關閉HTTP請求時傳送訊號。
```
django.core.signals.request_started
django.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 :訊號接收器的唯一識別符號,以防訊號多次傳送。
### 裝飾器法
```python
from django.core.signals import request_finished
from django.dispatch import receiver
@receiver(request_finished)
def my_callback(sender, **kwargs):
print("Request finished!")
```
可以給`receiver`新增`sender`引數來篩選接收哪個模型產生的訊號,比如:
```python
from django.db.models import signals
from 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引數來標識你的接收器,識別符號通常是一個字串,如下所示:
```python
from django.core.signals import request_finished
request_finished.connect(my_callback, dispatch_uid="my_unique_identifier")
```
## 斷開訊號
在滿足某些條件下,我們不再需要監聽訊號,可以選擇斷開訊號。
Signal.disconnect()用來斷開訊號的接收器。和Signal.connect()中的引數相同。如果接收器成功斷開,返回True,否則返回False。
```python
Signal.disconnect(receiver=None, sender=None, dispatch_uid=None)[source]
```
## 後記
最近剛入職專案很多特別的忙,也學到了很多新技術,但是感覺已經好久沒有時間來好好寫一篇部落格了,就算是本文也是短時間拼湊的,真是難呀,週末得好好整理一下最近的技術筆記。
關於Django訊號機制的更多內容(自定義訊號等),可以參考官方文件。https://docs.djangoproject.com/en/3.0/topics/signals/
>PS:接下來應該會寫寫Django Admin方案的相關調研,emm,還有關於微信小程式的登入、支付接入的,不是什麼很難的東西,但是第一次用的話處處充滿坑……
## 歡迎交流
我整理了一系列的技術文章和資料,在公眾號「程式設計實驗室」後臺回覆 linux、flutter、c#、netcore、android、java、python 等可獲取相關技術文章和資料,同時有任何問題都可以在公眾號後