欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

django的信号

程序员文章站 2022-06-22 10:40:41
django的信号 Django中提供了“信号调度”,用于在框架执行操作时解耦。通俗来讲,就是一些动作发生的时候,信号允许特定的发送者去提醒一些接受者。 Django提供一种信号机制。其实就是观察者模式,又叫发布 订阅(Publish/Subscribe) 。当发生一些动作的时候,发出信号,然后监听 ......

django的信号

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

django提供一种信号机制。其实就是观察者模式,又叫发布-订阅(publish/subscribe) 。当发生一些动作的时候,发出信号,然后监听了这个信号的函数就会执行。

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

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

注册信号,写入与project同名的文件夹下的_init_.py文件中,也是换数据库引擎的地方。

# 导入需要的信号
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

################################################ 方法一 ############################################
# 写一个回调函数触发信号后要执行的函数
def callback(sender, **kwargs):
    print("xxoo_callback")
    print(sender,kwargs)

# 信号连接的哪个回调函数
post_save.connect(callback)
# 模板signal.connect(receiver, sender=none, weak=true, dispatch_uid=none)
receiver :当前信号连接的回调函数,也就是处理信号的回调函数。 
sender :指定从哪个发送方接收信号。 
weak : 是否弱引用
dispatch_uid :信号接收器的唯一标识符,以防信号多次发送。

################################################ 方法二 ############################################
from django.dispatch import receiver

@receiver(post_save)  # 通过加装饰器的方式,指定信号触发完后执行哪个回调函数
def callback(sender, **kwargs):
    print("xxoo_callback")
    print(sender,kwargs)

指定发送者

from django.db.models.signals import pre_save, post_save
from django.dispatch import receiver
from myapp.models import mymodel

@receiver(post_save,sender=mymodel)  # 指定某个model触发信号后执行该回调函数。
def callback(sender, **kwargs):
    print("xxoo_callback")
    print(sender,kwargs)

2. 自定义信号

  • 定义信号

    # 在某个py文件中写入下面代码
    import django.dispatch
    pizza_done = django.dispatch.signal(providing_args=["toppings", "size"])
    
  • 注册信号

    # 在_init_.py 中注册信号
    from 路径 import pizza_done
    
    def callback(sender, **kwargs):
        print("callback")
        print(sender,kwargs)
    
    pizza_done.connect(callback)
    
  • 触发信号

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

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

例子:

from django.shortcuts import httpresponse
import time
import django.dispatch
from django.dispatch import receiver
 
# 定义一个信号
work_done = django.dispatch.signal(providing_args=['path', 'time'])
 
def create_signal(request):
    url_path = request.path
    print("我已经做完了工作。现在我发送一个信号出去,给那些指定的接收器。")
 
    # 发送信号,将请求的ip地址和时间一并传递过去
    work_done.send(create_signal, path=url_path, time=time.strftime("%y-%m-%d %h:%m:%s"))
    return httpresponse("200,ok")
 
@receiver(work_done, sender=create_signal)
def my_callback(sender, **kwargs):
    print("我在%s时间收到来自%s的信号,请求url为%s" % (kwargs['time'], sender, kwargs["path"]))

3. 防止重复信号

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

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

from django.core.signals import request_finished

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