Django Signals

Posted zhufanyu

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Django Signals相关的知识,希望对你有一定的参考价值。

信号

Django中提供了“信号调度”,用于在框架执行操作时解耦。通俗来讲,就是一些动作发生的时候,信号允许特定的发送者去提醒一些接受者。

Django内置的信号

Model signals
    pre_init                    # django的model执行其构造方法前,自动触发
    post_init                   # django的model执行其构造方法后,自动触发
    pre_save                    # django的model对象保存前,自动触发,新增或者更新都是保存
    post_save                   # django的model对象保存后,自动触发
    pre_delete                  # django的model对象删除前,自动触发
    post_delete                 # django的model对象删除后,自动触发
    m2m_changed                 # django的model中使用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          # 创建数据库连接时,自动触发

它们各自对应的导入方式:

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_created

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

注册信号,写入与project同名的文件夹下的__init__.py文件(或者应用文件夹的__init__.py文件中或者views.py视图中)中,也是换数据库引擎的地方。

您可以通过两种方式将接收器连接到信号。

from django.core.signals import request_finished

request_finished.connect(my_callback)

# my_callback是一个定义的函数
# 参数必须是 sender,**kwargs 是必须的
def my_callback(sender, **kwargs):
    print("Request finished!")

另外,您可以使用receiver()装饰器:

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

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

连接到特定发送者发送的信号

当你只想对某个特定的model类操作时才会触发信号,这里就可以用receiver函数中的sender指向特定的model类;

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):
    print('Save finished')

my_handler函数仅在MyModel 保存的实例时被调用,对MyModel 其他操作不会触发这个函数

防止重复信号

在某些情况下,将接收器连接到信号的代码可能会运行多次。这可能会导致您的接收器功能被多次注册,因此对于单个信号事件将被多次调用。

如果此行为有问题(例如在保存模型时使用信号发送电子邮件),请传递一个唯一标识符作为dispatch_uid参数,以识别您的接收方功能。该标识符通常是一个字符串,尽管任何可哈希对象都足够。最终结果是,对于每个唯一dispatch_uid值,您的接收器功能将仅与信号绑定一次:

from django.core.signals import request_finished

request_finished.connect(my_callback, dispatch_uid="my_unique_identifier")

自定义信号

定义信号

import django.dispatch
pizza_done = django.dispatch.Signal(providing_args=["toppings", "size"])
#toppings和size这两个参数名称是随意取的,不是固定的,但是使用的时候关键字传参的时候,要和这两个参数的名称对应好,可以通过设置参数来进行一个判断处理等操作

发送信号

def callback(sender, **kwargs):
    print("callback")

pizza_done.connect(callback)

以上是关于Django Signals的主要内容,如果未能解决你的问题,请参考以下文章

Django Signals

Django 信号 Signals

Django使用Signals监测model字段变化发送通知

Django-ContentType-signals 实现牛逼玩法

Django——ContentType及ContentType-signals的使用

Django中的信号