信号（signal）

 一、Django内置信号类型

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

比如在数据库操作，插入一条数据之前和之后都写入日志。（审计工作）

这里装饰器就实现不了了，装饰器用在函数上，这里可能在一条代码前后，而且是每次都需要执行。如果你使用装饰器的话，你可能需要在Django源码里面修改save()函数，但是这样是不可取的。

Django早就帮你想到了，它在很多地方都放置了钩子。我们直接调用钩子就可以了。我们可以在信号里面注册很多个函数。触发信号时，会把信号里的函数执行一遍。

1、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类，对于每一个类，自动触发

　　

2、Management signals

    pre_migrate                 # 执行migrate命令前，自动触发
    post_migrate                # 执行migrate命令后，自动触发

　　

3、Request/response signals

    request_started             # 请求到来前，自动触发
    request_finished            # 请求结束后，自动触发
    got_request_exception       # 请求异常后，自动触发

　

4、Test signals

    setting_changed             # 使用test测试修改配置文件时，自动触发
    template_rendered           # 使用test测试渲染模板时，自动触发

　　

5、Database Wrappers

 connection_created          # 创建数据库连接时，自动触发

　　

二、内置signal实例

1、pre_init（model初始化之前执行）

由于signal必须在程序加载时就执行，所以我们需要将signal放在project的__init__.py文件下：

__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("connection_created linked!")
    print(sender,kwargs)

pre_init.connect(callback)

　　

启动app，signal函数立马执行：

 

2、post_save（保存数据时触发执行）

__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("connection_created linked!")
    print(sender,kwargs)

#使用Django内部定义的信号，在指定位置注入指定操作。比如这里我们在保存每一条记录之后做一个callback操作。
post_save.connect(callback)

　　

views.py文件

from django.core import serializers
def index(request):
    if request.method == 'GET':
        print 'init前'
        ut = models.UserType.objects.filter(id=1).first()
        obj1 = models.User(username='singl11', email='singl11@kingsoft.com', user_type=ut)
        #测试先不执行save，看看效果
        #obj1.save()
        obj = UserInfoForm()
        new_obj = models.User.objects.all()
        data = serializers.serialize('json',new_obj)
        print 'init 后'
        #print type(data)
        #print data
        return render(request,'index.html',{'obj':obj,'new_obj':new_obj})
    elif request.method == 'POST':
        obj = UserInfoForm(request.POST)
        if obj.is_valid():
            rt_dic = obj.cleaned_data
            username = rt_dic.get('username')
            email = rt_dic.get('email')
            user_type_id = rt_dic.get('user_type')
            ut = models.UserType.objects.filter(id=user_type_id).first()
            models.User.objects.create(username=username,email=email,user_type=ut)
        return render(request,'index.html',{'obj':obj})

　　注意：这里先不执行save（）。

结果如下：

从上可以看出，post_save()信号没有执行。

 views.py中打开save()函数，执行结果如下：

obj1 = models.User(username='singl11', email='singl11@kingsoft.com', user_type=ut)
obj1.save()

　　

结果如下：

 

其他signal钩子一样，可以在对应的场景触发。

 

三、自定义signal实例

a. 定义信号

#自定义signal
import django.dispatch
custom_signal = django.dispatch.Signal(providing_args=["args", "kwargs"])

　　

b. 注册信号

def callback1(sender, **kwargs):
    print("callback custom_signal!")
    print(sender, kwargs)

custom_signal.connect(callback1)

　　

c. 触发信号

def index(request):
    if request.method == 'GET':
       #########触发signal############
        from mform import custom_signal
        custom_signal.send(sender='xuequn',args1=123, args2=456)
        obj = UserInfoForm()
        new_obj = models.User.objects.all()
        data = serializers.serialize('json',new_obj)
        return render(request,'index.html',{'obj':obj,'new_obj':new_obj})

　　

d、执行结果

 

总结

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

比如对系统状态阀值设置，到达某个状态，触发信号；数据库进行记录变更，我们可以进行某项操作，比如记录日志，审计功能。

这样只注册信号就可以，类似插拔式，降低程序耦合。