快捷導(dǎo)航

深入理解Django自定義信號(hào)（signals)

更新時(shí)間：2018年10月15日 11:31:15 作者：二二向箔

這篇文章主要介紹了深入理解Django自定義信號(hào)（signals)，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

django中自定義了一些singals，用于監(jiān)聽(tīng)一些操作，并發(fā)出通知

官方解釋：

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中已經(jīng)內(nèi)置了一些singals，在django/db/models/signal.py中，如

Model signals
  pre_init          # django的modal執(zhí)行其構(gòu)造方法前，自動(dòng)觸發(fā)
  post_init          # django的modal執(zhí)行其構(gòu)造方法后，自動(dòng)觸發(fā)
  pre_save          # django的modal對(duì)象保存前，自動(dòng)觸發(fā)
  post_save          # django的modal對(duì)象保存后，自動(dòng)觸發(fā)
  pre_delete         # django的modal對(duì)象刪除前，自動(dòng)觸發(fā)
  post_delete         # django的modal對(duì)象刪除后，自動(dòng)觸發(fā)
  m2m_changed         # django的modal中使用m2m字段操作第三張（add,remove,clear）前后，自動(dòng)觸發(fā)
  class_prepared       # 程序啟動(dòng)時(shí)，檢測(cè)已注冊(cè)的app中modal類，對(duì)于每一個(gè)類，自動(dòng)觸發(fā)
  
Management signals
  pre_migrate         # 執(zhí)行migrate命令前，自動(dòng)觸發(fā)
  post_migrate        # 執(zhí)行migrate命令后，自動(dòng)觸發(fā)
  
Request/response signals
  request_started       # 請(qǐng)求到來(lái)前，自動(dòng)觸發(fā)
  request_finished      # 請(qǐng)求結(jié)束后，自動(dòng)觸發(fā)
  got_request_exception    # 請(qǐng)求異常后，自動(dòng)觸發(fā)
  
Test signals
  setting_changed       # 使用test測(cè)試修改配置文件時(shí)，自動(dòng)觸發(fā)
  template_rendered      # 使用test測(cè)試渲染模板時(shí)，自動(dòng)觸發(fā)
  
Database Wrappers
  connection_created     # 創(chuàng)建數(shù)據(jù)庫(kù)連接時(shí)，自動(dòng)觸發(fā)

用法：

利用這幾個(gè)singals可以實(shí)現(xiàn)model中的一些聯(lián)動(dòng)操作，比如，要想更改通過(guò)model更新記錄時(shí)，記下操作者的日志，可以直接在操作的地方使用post_save裝飾器，

或者改寫post_save，使其記錄相關(guān)信息，一勞永逸。或者在request請(qǐng)求時(shí)，記錄請(qǐng)求信息。

from django.core.signals import request_finished
from django.dispatch import receiver

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

如何自定義singals？

a. 定義singal文件

import django.dispatch
pizza_done = django.dispatch.Signal(providing_args=["toppings", "size"])

b. 注冊(cè)singal

def callback(sender, **kwargs):
  print("callback")
  print(sender,kwargs)
  pizza_done.connect(callback)

c. 觸發(fā)信號(hào)

from 路徑 import pizza_done
pizza_done.send(sender='seven',toppings=123, size=456)

需求場(chǎng)景：

項(xiàng)目中有一個(gè)需求，當(dāng)model(即庫(kù)的數(shù)據(jù))被修改或者刪除時(shí)，自動(dòng)觸發(fā)一個(gè)redis的同步任務(wù)(后來(lái)發(fā)現(xiàn)這個(gè)需求沒(méi)有意義....)，model的保存有post_save，刪除有post_delete，唯獨(dú)沒(méi)有update，而代碼中使用update的場(chǎng)景蠻多的，就搜了下為什么就是沒(méi)有update的singals。

看到：https://code.djangoproject.com/ticket/12184

其實(shí)很早就有人給django官方提過(guò)這種方式，為什么不在官方版本中添加，具體這個(gè)pr為什么沒(méi)有被接受，可以看下里面的討論，反正當(dāng)時(shí)的django1.9仍然不支持，只能自己先寫一個(gè)用用，有問(wèn)題了再撤掉好了。

解決方式：

singals.py文件

# coding:utf-8
from django.dispatch import Signal
post_update = Signal(providing_args=["user"])

models.py文件

-----------針對(duì)某個(gè)model，重寫其queryset中的update方法-----------

//引入自定義的signal文件
from tools import signals 

class MyCustomQuerySet(models.query.QuerySet):
  def update(self, **kwargs):
    super(MyCustomQuerySet, self).update(**kwargs)
    //update被調(diào)用時(shí)， 發(fā)送該singalsignals
    signals.post_update.send(sender=self.model, user="xxx")
    print("finished!")

class MyCustomManager(models.Manager):
  def get_queryset(self):
    return MyCustomQuerySet(self.model, using=self._db)

class crontab_ping(models.Model):
  name = models.CharField(max_length=64, blank=True, null=True)
  objects = MyCustomManager()

callback.py文件：

-------接收signal，觸發(fā)操作----------

from tools.signals import post_update

@receiver(post_update)
def post_update_callback(sender, **kwargs):
  print(kwargs['user'])
  print("post_update_success")

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: