Django中的信号 signals及自定义signals

一.基本介绍

django中自定义了一些singals，用于监听一些操作，并发出通知

  Django 提供一个“信号分发器”，允许解耦的应用在框架的其它地方发生操作时会被通知到。
  简单来说，信号允许特定的sender通知一组receiver某些操作已经发生。这在多处代码和同一事件有关联的情况下很有用。

django中已经内置了一些singals，在django/db/models/signal.py中，如

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          # 创建数据库连接时，自动触发

二.如何使用

利用这几个singals可以实现应用中的一些联动操作

• 要想更改通过model更新记录时，记下操作者的日志，可以直接在操作的地方使用post_save装饰器，或者改写post_save，使其记录相关信息，一劳永逸
• 在request请求时，记录请求信息

使用方式

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. 定义信号

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

b. 注册信号
def callback(sender, **kwargs):
    print("callback")
    print(sender,kwargs)
    pizza_done.connect(callback)

c. 触发信号
from 路径 import pizza_done
pizza_done.send(sender='seven',toppings=123, size=456)

三.使用场景

项目中有一个需求，当model(即库的数据)被修改或者删除时，自动触发一个redis的同步任务(后来发现这个需求没有意义….)，model的保存有post_save,删除有post_delete，唯独没有update，而代码中使用update的场景蛮多的，就搜了下为什么就是没有update的singals。

相关资料：https://code.djangoproject.com/ticket/12184

其实很早就有人给django官方提过这种方式，为什么不在官方版本中添加，但最新django版本1.9仍然不支持，只能自己先写一个用用，有问题了再撤掉好了。

具体写法：

singals.py文件

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

models.py文件
-----------针对某个model，重写其queryset中的update方法-----------

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

class MyCustomQuerySet(models.query.QuerySet):
    def update(self, **kwargs):
        super(MyCustomQuerySet, self).update(**kwargs)
//update被调用时， 发送该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，触发操作----------

from tools.signals import post_update

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