Django signals 信号总结

故事背景

最近在做的项目中都遇到使用 django 信号量，故此总结信号相关的使用。

什么是信号

Django 中内置一个 信号调度器，它可以帮助应用程序在框架中的其他地方发生某些固定操作时能够得到通知。简而言之：信号允许某些发送器通知一组接收器某些操作已经发生。当接受器接受到这一通知时可以做响应的处理。

Django 中内置的信号集

模型信号

模型初始化时
- django.db.models.signals.pre_init（模型在初始化时发出）
- django.db.models.signals.post_init（模型在被初始化之后发出）
模型 save()方法相关信号
- django.db.models.signals.pre_save (模型在被保存之前发出)
- django.db.model.signals.post_save（模型对象被保存之后发出）
模型 delete()方法相关信号
- dajngo.db.models.signals.pre_delete（模型被删除之前）
- django.db.models.signals.post_delete（模型被删除之后）
模型多对多(manytomanyField)字段发生更改时
- django.db.models.signals.m2m_changed（模型中多对多字段发生改变）
执行迁移之前
- django.db.models.signals.pre_migrate（在模型迁移之前执行）
- django.db.models.signals.post_migrate（在模型迁移之后执行）

网络请求相关

django 发起或者结束一个 http 请求相关信号
- django.core.signals.request_started（django 发起一个 http 请求前）
- django.core.signals.request_finished（django 发起一个 http 请求之后）
django 发送请求发生错误时
- django.core.signals.got_request_exception（发送请求发生错误时）

Django 信号量使用

使用 Signal.connect()方法注册一个接收器函数，当发送信号时调用接收器。信号的所有接收器函数都会按照注册时的顺序一个接一个调用。

Signal.connect(receiver, sender=None, weak=True, dispatch_uid=None)

receiver：将连接到此信号的回调函数
sender：指定要从其接收信号的特定发送方
weak：Django 默认将信号处理程序存储为弱引用，因此如果你的接收器函数时本地函数，则可能会对其进行垃圾回收。如果想避免这种情况发生可以当你要调用 connct() 方法时传入 weak=False
disptch_uid：在可能发送重复信号的情况下，信号接收器的唯一标识

接受信号函数

下面我们定义一个接收函数，接受函数可以是任何 python 函数或者方法：

def my_callback(sender, **kwargs):print('hello world')

注意⚠️：该函数接受一个 sneder 参数以及关键字参数（**kwargs），所有信号处理程序都必须接受这些参数。

连接接受函数

Django 提供两种方法可以将接收器连接到信号。

方式一：Signal.connet(my_callback)

from django.core.signals import request_finishedrequest_finished.connect(my_callback)

方式二：receiver(sigal)
- 参数 signal：一个用于连接函数的信号包含多个信号列表
- 接受函数和连接接受函数放在在一起
```
from django.core.signals import request_finished
from django.dispatch import receiver@receiver(request_finished)
def my_callback(sender, **kwargs):print('hello world')
```
以上两种方式都能到达 my_callback 函数在每次请求完成时被调用

接受到特定发送器发送的信号

在某些情况下有些信号被发送多次，但你只对这些信号中某部分信号感兴趣。假设我们有 User 以及 Enterprise 两个 model 我们只想接受当模型 User 保存后的信号，代码如下：

from django.db.models.signals import post_save
from django.dispatch import receiver
from . models import User@receiver(post_save, sender=Udser)
# 这里的 instance 可以表示为当前变化的模型实例
def my_handel(sender, instance, **kwargs):# to do ...

防止信号重复

在某些情况下，接受器可能同时接受相同信号多次，这可能会导致接收函数被注册多次，因此对于一个信号时间调用同样多次，为防止这种相同信号被接受多次的情况发生，我们可以传递一个唯一标识符作为 dispatch_uid 参数来标识接收方函数。这个标识符通常是一个字符串，对于每个唯一 dispatch_uid 值，接受器函数值与信号绑定一次：

from django.core.signals import post_savepost_save.connect(my_callback, dispatch_uid='my_unique_identifier')

django 信号量实际使用

监听某个模型中某个字段的变化

假设我们有一个 User 模型，当我们用户名发生改变时需要重置 token，这时我们只需要监听 User 中 token 是否变化，如果变化则重置 token，使用信号来实现这一需求

# 用户模型class User(models.Model):id = models.BigIntegerField(primary_key=True)name = models.CharField(max_length=32, verbose_name='用户名')areaCode = models.CharField(max_length=10, blank=True, verbose_name='手机区号')phone = models.CharField(max_length=20, verbose_name='用户手机号', blank=True)email = models.EmailField(max_length=50, verbose_name='用户邮箱', blank=True)avatar = models.CharField(max_length=255, verbose_name='用户头像')token = models.CharField(max_length=50, verbose_name='token')

# 信号量实现以上场景from django.db.models.signals import post_init, post_save
from django.dispatch import receiverfrom . models import User@receiver(post_init, sender=User)
def init_signal(sender, instance, **kwargs):# 在模型初始化时将 name 赋值给 __origin_nameinstance.__origin_name = instance.name@receiver(post_save, sender=User)
def save_signal(sender, instance, **kwargs):# 当模型被保存时查看此时的 name 和 __origin_name 是否相等，如果不相等则重置 tokenif instance.__origin_name and instance.__origin_name != instance.name:# 重置 token