Django的訊號機制詳解

pythontab發表於2017-05-16

Django提供一種訊號機制。其實就是觀察者模式,又叫釋出-訂閱(Publish/Subscribe) 。當發生一些動作的時候,發出訊號,然後監聽了這個訊號的函式就會執行。

Django內建了一些訊號,比如:

django.db.models.signals.pre_save 在某個Model儲存之前呼叫

django.db.models.signals.post_save 在某個Model儲存之後呼叫

django.db.models.signals.pre_delete 在某個Model刪除之前呼叫

django.db.models.signals.post_delete 在某個Model刪除之後呼叫

django.core.signals.request_started 在建立Http請求時傳送

django.core.signals.request_finished 在關閉Http請求時傳送

我們要做的,就是註冊一個receiver函式。例如,如果要在每次請求完成之後,列印一行字。

可以使用回撥的方式註冊:

# receiver
def my_callback(sender, **kwargs):
  print("Request finished!")
 
# connect
from django.core.signalsimport request_finished
 
request_finished.connect(my_callback)

也可以使用裝飾器的方式註冊,下面這段程式碼和上面完全是等價的。

from django.core.signalsimport request_finished
from django.dispatchimport receiver
 
@receiver(request_finished)
def my_callback(sender, **kwargs):
  print("Request finished!")

receiver回撥函式除了可以使用sender之外,還可以使用其他一些引數,比如針對pre_save函式:

sender:傳送者(如果是pre_save的話,就是model class)

instance:例項

raw

using

update_fields

post_save()是一個比較實用函式,可以支援一些聯動的更新。而不必讓我們每次都寫在view裡面。比如:有使用者提交了退款申請,我們需要把訂單的狀態修改成“已退款”的狀態。就可以使用訊號機制,而不必在每處都修改。

@receiver(post_save, sender=RefundForm)
deforder_state_update(sender, instance, created, **kwargs):
  instance.order.state = REFUNDING
  instance.order.save() # 這裡,order是refundform的一個外來鍵

當然,這裡可以寫的更多更周全,例如退款單取消改回狀態等。

觀察者是非常實用的一個設計模式,Django也支援使用者 自定義 一些訊號。


相關文章