Django 信号

信号

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

内置信号

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

使用信号

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

指定 Receiver函数

Receiver可以是任何Python函数或者方法

被指定触发信号的时候进行的函数操作就可以被作为是 Receiver

比如下面例子中的 my_callback 方法

def my_callback(sender, **kwargs):
    print(sender)
    print(kwargs)
    print("要保存了啊！")
    print('-' * 120)

监听信号

一旦某个指定信号触发，就执行我指定的receiver函数。

我们现在的需求是，模型层一执行保存的动作就做什么事。

所以应该是一旦触发 pre_save 信号就执行 my_callback，对于内置的信号Django框架会自动帮我们触发，我们只需要告诉它信号触发之后做什么事就可以了：

pre_save.connect(my_callback)

接下来，只要涉及到ORM的save()操作，都会自动执行我定义的my_callback函数了。

例如：

a3 = Author.objects.create(name='测试信号-作者')
b3 = Book.objects.create(title='测试信号-书')

输出：

<class 'app02.models.Author'>
{'signal': <django.db.models.signals.ModelSignal object at 0x108e0d198>, 'instance': <Author: 测试信号-作者>, 'raw': False, 'using': 'default', 'update_fields': None}
要保存了啊！
------------------------------------------------------------------------------------------------------------------------
(0.001) SELECT @@SQL_AUTO_IS_NULL; args=None
(0.001) INSERT INTO `app02_author` (`name`) VALUES ('测试信号-作者'); args=['测试信号-作者']
<class 'app02.models.Book'>
{'signal': <django.db.models.signals.ModelSignal object at 0x108e0d198>, 'instance': <Book: 测试信号-书>, 'raw': False, 'using': 'default', 'update_fields': None}
要保存了啊！
------------------------------------------------------------------------------------------------------------------------
(0.001) INSERT INTO `app02_book` (`title`) VALUES ('测试信号-书'); args=['测试信号-书']

使用装饰器方式监听信号

# 使用装饰器方式
from django.db.models.signals import pre_save
from django.dispatch import receiver

@receiver(pre_save)
def my_callback(sender, **kwargs):
    print(sender)
    print(kwargs)
    print("要保存了啊！")
    print('-' * 120)

自定义信号

上面列出来的都是Django框架内置的信号，当然我们还可以自定义信号。

定义信号

所有信号都是 django.dispatch.Signal 的实例。

providing_args是一个列表，由信号将提供给监听者的参数名称组成。 理论上是这样，但是实际上并没有任何检查来保证向监听者提供了这些参数。

举个例子：

# 自定义信号
from django.dispatch import Signal

bath_done = Signal(providing_args=['amount', 'temperature'])

这里定义了一个洗澡水烧好了的信号，它接受两个参数：amount表示水量，temperature表示温度。

注册receiver

from django.dispatch import receiver

@receiver(bath_done)
def my_action(sender, **kwargs):
    print(sender)
    print(kwargs)
    print('脱衣服泡个澡吧！')

触发信号

斯嘉丽烧好了一浴缸40度的洗澡水，杜兰特要开喝了。

bath_done.send(sender='斯嘉丽', amount='一浴缸', temperature='40°')