Django中信号的使用

信号种类及用法

Django中提供了"信号调度",用于在框架执行操作时解耦.

一些动作发生的时候,系统会根据信号定义的函数执行相应的操作

Django中内置的signal

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,update),自动触发
class_prepared                  # 程序启动时,检测到已注册的model类,对于每一个类,自动触发

Managemeng_signals

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

Request/response_signals

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

Test_signals

setting_changed                 # 配置文件改变时,自动触发
template_rendered               # 模板执行渲染操作时,自动触发

Datebase_Wrapperd

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

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

例子,创建数据库记录,触发pre_save和post_save信号

创建一个Django项目,配置好路由映射

models.py中的代码:

from django.db import models

class Book(models.Model):
    name=models.CharField(max_length=32)
    price=models.CharField(max_length=64)

views.py中的代码:

from django.shortcuts import render,HttpResponse
from app01 import  models

def index(request):
    models.Book.objects.create(name="xxx",price="123")
    return HttpResponse("ok")

方法一：项目的__init__.py文件中代码:

from django.db.models.signals import pre_save,post_save

def pre_save_func(sender,**kwargs):

    print("pre_save_func")
    print("pre_save_msg:",sender,kwargs)

def post_save_func(sender,**kwargs):
    print("post_save_func")
    print("post_save_msg:",sender,kwargs)

pre_save.connect(pre_save_func)             # models对象保存前触发callback函数
post_save.connect(post_save_func)           # models对象保存后触发函数

创建一个index.html网页,用浏览器打开这个项目,在服务端后台打印信息如下:

pre_save_func
pre_save_msg: <class 'app01.models.Book'> {'signal': <django.db.models.signals.ModelSignal object at 0x0000000002E62588>, 
'instance': <Book: Book object>, 'raw': False, 'using': 'default', 'update_fields': None}

post_save_func
post_save_msg: <class 'app01.models.Book'> {'signal': <django.db.models.signals.ModelSignal object at 0x0000000002E62630>, 
'instance': <Book: Book object>, 'created': True, 'update_fields': None, 'raw': False, 'using': 'default'}

比较打印的结果,可以看到models对象保存后,在打印信息里包含一个"create=True"的键值对.

方法二(推荐)：也可以使用装饰器来触发信号,把上面__init__.py中的代码修改:

from django.db.models.signals import post_save
from django.dispatch import receiver


@receiver(post_save)
def create_user(sender, instance, created, **kwargs):
    if created:
        print(sender)  # <class 'app01.models.Book'>
        print(instance)  # Book object (17)
        print(created)  # True
        print(kwargs)  # {'signal': <django.db.models.signals.ModelSignal object at 0x000002334A7966D8>, 'update_fields': None, 'raw': False, 'using': 'default'}