使用信号监控 Django 模型对象字段值的变化

曾经终败给现在 2022-06-12 00:50 52阅读 0赞

Django 信号 (Signals) 的功能类似于 WordPress 的动作 (action)，用于为项目全局增加事件的广播 (dispatch) 与接收 (receive) 机制。其中，灵活使用其内置的模型信号 (Model Signals) 的接收功能就可以监控大部分模型对象 (Model instances) 的变化。因为不需要修改模型本身的代码，在进行跨应用 (App) 监控时有低耦合的优势。

## 基本用法 ##

信号的基本用法官方文档上的 [主题][Link 1] 与 [参考][Link 2] 上已经有详细描述。本文只提几个要点（本文环境：Django 1.8 & Python 3.4）：

### 代码组织 ###

官方推荐在应用目录下新增一个 `signals.py` 文件，同时参考官方文档的 [应用配置][Link 3] 节中自定义应用配置 (AppConfig) ，重载应用配置类的 `run` 方法，在该方法内调用 `from . import signals`

### 接收信号 ###

推荐使用 `django.dispatch.receiver` 这个装饰器进行信号的接收：

from django.db.models import signals
     from django.dispatch import receiver
    
     from students.models import Student
     from .models import Announcement
    
     @receiver(signals.post_save, sender=Student)
     def welcome_student(instance, created, **kwargs):
         if created:
             Announcement.objects.create(content='Welcome new student ' + instance.name)

从代码可读性的角度来讲，建议一个接收函数只做一件事。

## 监控特定字段 (field) 值的变化 ##

从上一段代码可以知道，通过接收模型 `post_save` 信号，可以得知发生了保存模型对象的操作，并且还可以区分出是创建了模型对象还是更新了模型对象。然而，模型信号并没有提供针对特定字段值变化的广播功能，虽然该信号提供了 `update_fields` 参数，但是并不能证明在该参数中的字段名的字段值一定发生了变化，所以我们要采用一个结合 `post_init` 信号的变通方法。

举一个例子：当学生名字发生改变之后发布一条公告。

from django.db.models import signals
     from django.dispatch import receiver
    
     from students.models import Student
     from .models import Announcement
    
     @receiver(signals.post_init, sender=Student)
     def welcome_student(instance, **kwargs):
         instance.__original_name = instance.name
    
     @receiver(signals.post_save, sender=Student)
     def welcome_student(instance, created, **kwargs):
         if not created and instance.__original_name != instance.name:
             Announcement.objects.create(content=
                 'Student %s has renamed to %s' % (instance.__original_name, instance.name))

简单的说就是在该模型广播 `post_init` 信号的时候，在模型对象中缓存当前的字段值；在模型广播 `post_save` （或 `pre_save` ）的时候，比较该模型对象的当前的字段值与缓存的字段值，如果不相同则认为该字段值发生了变化。

[Link 1]: https://docs.djangoproject.com/en/1.8/topics/signals/
[Link 2]: https://docs.djangoproject.com/en/1.8/ref/signals/
[Link 3]: https://docs.djangoproject.com/en/1.8/ref/applications/