Django-signal组件

Django-signal组件

Django4.2信号官档：https://docs.djangoproject.com/zh-hans/4.2/ref/signals/#signals

Django有一个"信号调度器(signal dispatcher)"。其实就是观察者模式，又叫发布-订阅(Publish/Subscribe) 。当发生一些动作的时候，发出信号，然后监听了这个信号的函数就会执行。

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

1 自定义信号

• 定义信号

  import django.dispatch
  
  # 自定义信号
  cut_info_signal = django.dispatch.Signal()
  

• 注册回调

  from utils.signals import cut_info_signal
  
  
  def callback_1(sender, **kwargs):
      print("callback-1")
  
  
  def callback_2(sender, **kwargs):
      print("callback-2")
  
  
  cut_info_signal.connect(callback_1)
  cut_info_signal.connect(callback_2)
  

• 触发信号

  from utils.signals import cut_info_signal
  cut_info_signal.send("触发了此信号")
  

将某些动作都注册在一个信号中，一旦达到条件则触发信号(所有回调都执行)。

2 内置信号

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中model类，对于每一个类，自动触发
    
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 func1(*args, **kwargs):
      print("func1")
  
  
  def func2(*args, **kwargs):
      print("func2")
  
  
  post_save.connect(func1)
  post_save.connect(func2)
  

• 触发信号

  from app01 import models
  
  def demo(request):
      models.UserInfo.objects.create(name="wilson", age=21)
      return HttpResponse("OK")
  

当然，我们将args和kwargs打印出来就可以看到两个信号都是由UserInfo表触发的

用法二：使用装饰器

from app01 import models
from django.http import HttpResponse
from django.db.models.signals import post_save


@post_save.connect
def func1(*args, **kwargs):
    print("func1", args, kwargs)


@post_save.connect
def func2(*args, **kwargs):
    print("func2", args, kwargs)


# post_save.connect(func1)
# post_save.connect(func2)


def demo(request):
    models.UserInfo.objects.create(name="wilson", age=21)
    return HttpResponse("OK")

注意信号定义位置

信号的定义和注册我们一般不放在视图函数中，转而放在项目根目录的__init__.py文件中（只要项目启动，该文件会自动加载）

3 migrate信号应用

当我们执行python manage.py makemigrations和python manage.py migrate后，会自动生成两张有数据的表django_content_type和auth_permission

其实现原理就是，在Django启动时，会在post_migrate信号中注册函数，当我们执行python manage.py migrate时，Django除了会根据已注册的app中migrations文件夹中的配置创建表，还会执行post_migrate信号中注册的函数，向django_content_type和auth_permission表中新增数据

我们可以在Django-auth组件中找到源码：

流程图：