Django的信号Signals介绍及使用

Django提供一种信号机制。其实就是观察者模式，又叫发布-订阅(Publish/Subscribe) 。当发生一些动作的时候，发出信号，然后监听了这个信号的函数就会执行。通俗来讲，就是一些动作发生的时候，信号允许特定的发送者去提醒一些接受者。用于在框架执行操作时解耦。

1、Django内置信号

Model signalspre_init                    # model初始化前触发，自动触发post_init                   # model初始化后触发，自动触发pre_save                    # save()方法前触发，自动触发post_save                   # save()方法后触发，自动触发pre_delete                  # delete()方法前触发，自动触发post_delete                 # delete()方法后触发，自动触发m2m_changed                 # ManyToManyField字段改变时触发，django的model中使用m2m字段操作第三张表（add,remove,clear）前后，自动触发class_prepared              # 程序启动时，检测已注册的app中model类，对于每一个类，自动触发
Management signalspre_migrate                 # 执行migrate命令前，自动触发post_migrate                # 执行migrate命令后，自动触发
Request/response signalsrequest_started             # 请求开始时触发，自动触发request_finished            # 请求完成后触发，自动触发got_request_exception       # 请求异常时，自动触发
Test signalssetting_changed             # 使用test测试修改配置文件时，自动触发template_rendered           # 使用test测试渲染模板时，自动触发
Database Wrappersconnection_created          # 创建数据库连接时，自动触发

Django 提供了一系列的内建信号，允许用户的代码获得DJango的特定操作的通知。这包含一些有用的通知：
django.db.models.signals.pre_save & django.db.models.signals.post_save在模型 save()方法调用之前或之后发送。
django.db.models.signals.pre_delete & django.db.models.signals.post_delete在模型delete()方法或查询集的delete() 方法调用之前或之后发送。
django.db.models.signals.m2m_changed模型上的 ManyToManyField 修改时发送。
django.core.signals.request_started & django.core.signals.request_finishedDjango建立或关闭HTTP 请求时发送。

对于Django内置的信号，仅需注册指定信号，当程序执行相应操作时，自动触发注册函数：

方式1:

from django.core.signals import request_finished
from django.core.signals import request_started
from django.core.signals import got_request_exception
from django.db.models.signals import class_prepared
from django.db.models.signals import pre_init, post_init
from django.db.models.signals import pre_save, post_save
from django.db.models.signals import pre_delete, post_delete
from django.db.models.signals import m2m_changed
from django.db.models.signals import pre_migrate, post_migrate
from django.test.signals import setting_changed
from django.test.signals import template_rendered
from django.db.backends.signals import connection_createddef callback(sender, **kwargs):print("pre_save_callback")print(sender,kwargs)pre_save.connect(callback)      ＃ 该脚本代码需要写到app或者项目的初始化文件中，当项目启动时执行注册代码

方式2:

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

2、自定义信号

a. 定义信号

1 2	`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)

由于内置信号的触发者已经集成到Django中，所以其会自动调用，而对于自定义信号则需要开发者在任意位置触发。

练习：数据库添加一条记录时生成一个日志记录

Django 提供一个“信号分发器”，允许解耦的应用在框架的其它地方发生操作时会被通知到。简单来说，信号允许若干 sender（寄件人）通知一组 receiver（接收者）某些操作已经发生。这在多处代码和同一事件有关联的情况下很有用。
Django 提供一组内建信号，允许用户的代码获得 Django 特定操作的通知。这包含一些有用的通知：

django.db.models.signals.pre_save
django.db.models.signals.post_save
在模型 save() 方法调用之前或之后发送。
django.db.models.signals.pre_delete
django.db.models.signals.post_delete
在模型 delete() 方法或查询集的 delete() 方法调用之前或之后发送。
django.db.models.signals.m2m_changed
模型上的 ManyToManyField 修改时发送。
django.core.signals.request_started
django.core.signals.request_finished
Django 建立或关闭 HTTP 请求时发送。

自定义信号

class Signal([providing_args=list])

所有信号都是 django.dispatch.Signal 的实例。providing_args 是一个参数名称列表，实际上这些参数并没有多大用处。
例如：

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

这段代码声明了 pizza_done 信号，它向接受者提供 toppings 和 size 参数。

Receiver 函数

receiver 相当于一个回调函数，相关事件发生了就会触发它被执行。

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

注意：函数接受一个 sender 参数，以及通配符关键字参数(**kwargs)；所有信号处理器都必须接受这些参数。

可是每次取值都得从 kwargs 中取，看起来可读性也变差了。个人用法是函数中经常会用到的参数直接列出来，比如：

def my_callback(sender, instance, created, **kwargs):pass

接下来，要做的就是绑定 receiver 到 signal，有两种方法可以将一个接收器连接到信号。

手动连接：

from django.core.signals import request_finishedrequest_finished.connect(my_callback)

使用 receiver 装饰器来自动连接：

receiver(signal)Parameters: signal – A signal or a list of signals to connect a function to.

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

现在，我们的 my_callback 函数会在每次请求结束时调用。
当你这么设置好了后，就会收到各种 signals 发来的通知。可是，如果我的回调函数只对特定 sender 感兴趣的话怎么办呢？可以通过指定 connect 函数的 sender 参数来过滤：

Signal.connect(receiver[, sender=None, weak=True, dispatch_uid=None])Parameters: receiver – 和这个信号连接的回调函数sender – 指定一个特定的 sender，来从它那里接受信号weak – Django 通常以弱引用储存信号处理器。这就是说，如果你的 receiver 是个局部变量，可能会被垃圾回收。当你调用信号的 connect()方法时，传递 weak=False 来防止这样做dispatch_uid – 一个信号 receiver 的唯一标识符，以防信号多次发送，通常是一个字符串

使用装饰器方式过滤：

from django.db.models.signals import pre_save
from django.dispatch import receiver
from myapp.models import MyModel@receiver(pre_save, sender=MyModel)
def my_handler(sender, **kwargs):...

my_handler 函数只在 MyModel 实例保存时被调用。

发送信号

Django 中有两种方法用于发送信号：

Signal.send(sender, **kwargs)Signal.send_robust(sender, **kwargs)

调用 Signal.send() 或者 Signal.send_robust() 来发送信号。你必须提供 sender 参数（大多数情况下它是一个类），并且可以提供尽可能多的关键字参数。

例如，这样来发送我们的 pizza_done 信号：

class PizzaStore(object):...def send_pizza(self, toppings, size):pizza_done.send(sender=self.__class__, toppings=toppings, size=size)...

send() 和 send_robust() 都会返回一个含有二元组的列表 [(receiver, response), ...
]，它代表了被调用的接收器函数和他们的响应值。

send() 与 send_robust() 在处理 receiver 函数产生的异常时有所不同。send() 不会捕获任何由 receiver 产生的异常。它会简单地让错误往上传递。所以在错误产生的情况，不是所有 receiver 都会获得通知。

send_robust() 捕获所有继承自 Python Exception 类的异常，并且确保所有 receiver 都能得到信号的通知。如果发生错误，错误实例会在产生错误的 receiver 的二元组中返回。

断开信号

Signal.disconnect([receiver=None, sender=None, weak=True, dispatch_uid=None])

调用 Signal.disconnect() 来断开信号的接收器。 Signal.connect() 中描述了所有参数。如果接收器成功断开，返回 True ，否则返回 False。

receiver 参数表示要断开的已注册 receiver。如果使用 dispatch_uid 标识 receiver，它可以为 None。