django的信号signals详解

骑猪去兜风z1

已于 2022-08-26 10:07:10 修改

阅读量3.5k

点赞数 1

分类专栏： python_django_杂谈文章标签： django python 后端

于 2022-08-25 20:29:08 首次发布

本文链接：https://blog.csdn.net/qq_52385631/article/details/126531614

版权

python_django_杂谈专栏收录该内容

80 篇文章 12 订阅

订阅专栏

介绍：

Django 提供一个了“信号分发器”机制，允许解耦的应用在框架的其它地方发生操作时会被通知到。

通俗而讲Django信号的工作原理，就是当某个事件发生的时候，会发出一个信号(signals), 而监听这个信号的函数(receivers)就会立即执行。

就是A动了，给B发一个通知，然后B可以准备干点事情

应用场景

用户登陆后，系统向他发送最新动态信息。
数据库数据发生变化后，实现缓存数据同步变化。
订单中商品数量影响库存数量，即不同模型的联动更新。

使用原则

如果一个应用程序想要触发它引用的应用程序中的行为，则不要使用信号，而是直接导入它所需要的行为。

如果一个应用程序想要触发依赖于该应用程序的应用程序中的行为，则可以在第二个应用程序中用接收器接收第一个应用程序发送给它的信号。

如果信号接收器要处理大量I/O操作，也不要使用信号机制，因为它基于同步实现。

用法

Django常用内置信号函数介绍

Model signals

    pre_init                    # django的modal执行其构造方法前，自动触发
    post_init                   # django的modal执行其构造方法后，自动触发
    pre_save                    # django的modal对象保存save()前，自动触发
    post_save                   # django的modal对象保存save()后，自动触发
    pre_delete                  # django的modal对象删除delete()前，自动触发
    post_delete                 # django的modal对象删除delete()后，自动触发
    m2m_changed  # django的modal中使用m2m字段操作第三张表（add,remove,clear）前后，自动触发
    class_prepared # 程序启动时，检测已注册的app中modal类，对于每一个类，自动触发
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

基础用法

需求，两个模型，当模型user创建实例的时候，打印出创建实例，当更新时，不提示

from django.db import models

from django.db.models import signals


class User(models.Model):
    name = models.CharField(max_length=16)


# 自定义函数，名字随便起
def create_user(sender, instance, created, **kwargs):
    if created:
        print("New user created!")


# 借用内置post_save进行二者表模型的连接,create_user被通知者，sender发送者
signals.post_save.connect(create_user, sender=User)

装饰器用法

在实际应用中，一个更常用的方式是，使用@receiver装饰器，，实现发送者与监听函数的连接

from django.db import models

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


# User模型
class User(models.Model):
    name = models.CharField(max_length=16)


# post_save内置连接，sender发送者
@receiver(post_save, sender=User)
def create_user(sender, instance, created, **kwargs):
    # instance 更新
    # created  创建
    if created:
        print("New user created!")

Django信号实现不同模型的联动更新

我们有一个Profile模型，与User模型是一对一的关系。

我们希望，创建User对象实例时，也创建Profile对象实例，而使用post_save更新User对象时，不创建新的Profile对象。

这时我们就可以自定义，create_user_profile和save_user_profile两个监听函数，同时监听sender(User模型)发出的post_save信号。

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


class User(models.Model):
    username = models.CharField(max_length=36)


class Profile(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)


@receiver(post_save, sender=User)
def create_user_profile(sender, instance, created, **kwargs):
    if created:
        Profile.objects.create(user=instance)


@receiver(post_save, sender=User)
def save_user_profile(sender, instance, **kwargs):
    instance.profile.save()

signals拆分(推荐)

介绍

一个更好的方式，把自定义的信号监听函数，集中放在app对应文件夹下的signals.py文件里，便于后期集中维护。

案例

假如我们有个account的app，包含了User和Pofile模型，我们不仅需要在account文件夹下新建signals.py，还需要修改account文件下apps.py和__init__.py，以导入创建的信号监听函数。

account/signals.py

from django.db.models.signals import post_save
from django.dispatch import receiver
from .models import User, Profile



@receiver(post_save, sender=User)
def create_user_profile(sender, instance, created, **kwargs):

  if created:

      Profile.objects.create(user=instance)



@receiver(post_save, sender=User)
def save_user_profile(sender, instance, **kwargs):

    instance.profile.save()

account/apps.py

from django.apps import AppConfig

class AccountConfig(AppConfig):
    name = 'account'
    # 导入
    def ready(self):
        import account.signals

account/init.py

default_app_config = 'account.apps.AccountConfig'

view

# 测试
def update_data(request):
    # 群更新会触发
    # query = ElasticNews.objects.all()
    # for item in query:
    #     item.title = 'uuuuuuuuuuu'
    #     item.save()

    # 单更新会触发
    # obj = ElasticNews.objects.filter(id=3).first()
    # obj.title = '99999999999'
    # obj.save()

    # create会触发
    # ElasticNews.objects.create(title='111', content='222',price='85')

    # update不会触发es与mysql同步,也不会触发信号post_save
    ElasticNews.objects.filter(id=1).update(title='圆梦去', content='222', price='85')
    return JsonResponse({'status': 200})