django 内置“信号”机制和自定义方法

django的信号机制其实还是相当有用的,记得有次业务需求是要在数据库变动前后添加日志,很多人第一时间想到的是用装饰器,包括我也是,后来想想,其实设置信号就可以早早完事了。

什么是信号?

django中的信号也称signal,用于在框架执行操作时解耦。通俗点讲,就是框架发生一些动作之前或之后,可以自动根据我们提前设置好的signal去执行对应函数。熟悉数据库的小伙伴应该知道“触发器”吧?就是类似的功能。

django内置的信号

其实django已经帮我们内置好了相当“够用”的信号了。如下:

Model signals:(Model信号)
    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 (m2m指的是manytomany)                
    # 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          # 创建数据库连接时,自动触发

怎么用信号?

对于内置信号来说,只需要把想执行的函数注册到信号,那么当动作发生时对应的信号函数便会自动执行。这里给两个例子:
一、全导入:

    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 test(sender, **kwargs):
        print("it work")
        #'sender'包含了这个动作发生时传入的参数

     request_finished.connect(test) #需要什么类型的信号,就信号.connect(函数名)

在使用这种方式的时候,建议在项目根目录下创建个新的py文件把信号放进去,然后在项目的init里直接import py文件名,这样views.py就不必再做手脚了。

二、局部导入:

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

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

这种方法也是在init中修改

自定义信号

当内置信号无法满足你要求的时候,自定义就势在必行了。分三步走:
一、创建信号:
在项目中新建一个py文件如test.py:

import django.dispatch
signal_test = django.dispatch.Signal(providing_args=["YYY", "XXX"])
#'signal_test'是信号的名称,后面的providing_args是传参给接收者的,也就是这个信号的接
#收者可以调用到"YYY""XXX"参数,就算是'None'也可以

二、注册函数:
这一步和注册内置信号一样的

def test(sender, **kwargs):
    print("成功")

signal_test.connect(test)

三、自定义触发:
在views.py中,在自己想要触发信号的位置:

from 路径 import signal_test
signal_test.send(sender='seven',YYY=123, XXX=456)
展开阅读全文

没有更多推荐了,返回首页