正确的理解和使用Django信号(Signals)


Posted in Python onApril 14, 2021

Django 提供一个了“信号分发器”机制,允许解耦的应用在框架的其它地方发生操作时会被通知到。 通俗而讲Django信号的工作原理就是当某个事件发生的时候会发出一个信号(signals), 而监听这个信号的函数(receivers)就会立即执行。Django信号的应用场景很多,尤其是用于不同模型或程序间的联动。常见例子包括创建User对象实例时创建一对一关系的UserProfile对象实例,或者每当用户下订单时触发给管理员发邮件的动作。今天小编我就分享下如何正确使用Django的信号(signals)。

Django信号的一个简单例子

假设我们有一个如下User模型,我们希望每次有User对象新创建时都打印出有新用户注册的提示信息,我们可以使用Django信号(signals)轻松实现。我们的信号发送者sender是User模型,每当User模型执行post_save动作时就会发出信号。此时我们自定义的create_user函数一旦监听到User发出的post_save信号就会执行,先通过if created判断对象是新创建的还是被更新的;如果对象是新创建的,就会打印出提示信息。

# models.py

from django.db import models

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

class User(models.Model):
    name = models.CharField(max_length=16)
    gender = models.CharField(max_length=32, blank=True)

def create_user(sender, instance, created, **kwargs):

    if created:

        print("New user created!")

post_save.connect(create_user, sender=User)

在上例中我们使用了信号(post_save)自带的connect的方法将自定义的函数与信号发出者(sender)User模型进行了连接。在实际应用中一个更常用的方式是使用@receiver装饰器实现发送者与监听函数的连接,如下所示。@receiver(post_save, sender=User)读起来的意思就是监听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):
    name = models.CharField(max_length=16)
    gender = models.CharField(max_length=32, blank=True)

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

    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信号。由于post_save可同时用于模型的创建和更新,我们用if created这个判断来加以区别。

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

class Profile(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    birth_date = models.DateField(null=True, blank=True)

@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()

Django常用内置信号

之前的例子中我们使用的都是post_save信号,即在模型调用save()方法后才发送信号。Django其它常用内置信号还包括:

  • django.db.models.signals.pre_save & post_save在模型调用 save()方法之前或之后发送。
  • django.db.models.signals.pre_init& post_init在模型调用_init_方法之前或之后发送。
  • django.db.models.signals.pre_delete & post_delete在模型调用delete()方法或查询集调用delete() 方法之前或之后发送。
  • django.db.models.signals.m2m_changed在模型多对多关系改变后发送。
  • django.core.signals.request_started & request_finished Django建立或关闭HTTP 请求时发送。

如何正确放置Django信号的监听函数代码

在之前案例中,我们将Django信号的监听函数写在了models.py文件里。当一个app的与信号相关的自定义监听函数很多时,此时models.py代码将变得非常臃肿。一个更好的方式把所以自定义的信号监听函数集中放在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'

小结

在本文里我们总结了Django信号(signals)的工作原理,介绍了如何使用Django信号实现模型或程序的联动。最后我们还总结了Django常用内置信号以及如何正确放置自定义的信号监听函数。欢迎关注我们更多Python Web开发和Django原创文章。

以上就是正确的理解和使用Django信号(Signals)的详细内容,更多关于Django信号(Signals)的资料请关注三水点靠木其它相关文章!

Python 相关文章推荐
Linux下使用python调用top命令获得CPU利用率
Mar 10 Python
python 截取 取出一部分的字符串方法
Mar 01 Python
Python中元组,列表,字典的区别
May 21 Python
Python中字典的浅拷贝与深拷贝用法实例分析
Jan 02 Python
Django如何配置mysql数据库
May 04 Python
Python装饰器知识点补充
May 28 Python
树莓派动作捕捉抓拍存储图像脚本
Jun 22 Python
numpy.linalg.eig() 计算矩阵特征向量方式
Nov 29 Python
使用pytorch搭建AlexNet操作(微调预训练模型及手动搭建)
Jan 18 Python
Python实现病毒仿真器的方法示例(附demo)
Feb 19 Python
Python用5行代码实现批量抠图的示例代码
Apr 14 Python
Python 利用flask搭建一个共享服务器的步骤
Dec 05 Python
编写python程序的90条建议
Apr 14 #Python
Python基础知识之变量的详解
理解深度学习之深度学习简介
Apr 14 #Python
python基于scrapy爬取京东笔记本电脑数据并进行简单处理和分析
深度学习小工程练习之垃圾分类详解
python3美化表格数据输出结果的实现代码
Apr 14 #Python
Python生成九宫格图片的示例代码
You might like
消息持续发送的完整例子
2006/10/09 PHP
两款万能的php分页类
2015/11/12 PHP
3种php生成唯一id的方法
2015/11/23 PHP
laravel中的一些简单实用功能
2018/11/03 PHP
Javascript 遍历对象中的子对象
2009/07/03 Javascript
使用forever管理nodejs应用教程
2014/06/03 NodeJs
Javascript中设置默认参数值示例
2014/09/11 Javascript
jQuery 和 CSS 的文本特效插件集锦
2014/12/12 Javascript
jquery实现的动态回到顶部特效代码
2015/10/28 Javascript
jquery UI Datepicker时间控件的使用及问题解决
2016/04/28 Javascript
JavaScript表单焦点自动切换代码
2016/07/24 Javascript
Javascript将JSON日期格式化
2016/08/23 Javascript
基于JavaScript实现数码时钟效果
2020/03/30 Javascript
js中url对象化管理分析
2017/12/29 Javascript
vue 实现通过手机发送短信验证码注册功能
2018/04/19 Javascript
详解Chart.js轻量级图表库的使用经验
2018/05/22 Javascript
JS实现统计字符串中字符出现个数及最大个数功能示例
2018/06/04 Javascript
使用JavaScript中的lodash编写双色球效果
2018/06/24 Javascript
React-router4路由监听的实现
2018/08/07 Javascript
Vue form表单动态添加组件实战案例
2019/09/02 Javascript
[02:51]DOTA2战队出征照拍摄花絮 TI3明星化身时尚男模
2013/07/22 DOTA
python缩进区别分析
2014/02/15 Python
Python time模块详解(常用函数实例讲解,非常好)
2014/04/24 Python
python验证码识别的实例详解
2016/09/09 Python
快速了解Python中的装饰器
2018/01/11 Python
python3 unicode列表转换为中文的实例
2018/10/26 Python
Python Flask框架模板操作实例分析
2019/05/03 Python
python修改文件内容的3种方法详解
2019/11/15 Python
BISSELL官网:北美吸尘器第一品牌
2019/03/14 全球购物
致长跑运动员广播稿
2014/01/31 职场文书
大学生未来职业生涯规划书
2014/02/15 职场文书
中学生民族团结演讲稿
2014/08/27 职场文书
教师节倡议书
2014/08/30 职场文书
长江三峡导游词
2015/01/31 职场文书
优秀团员个人总结
2015/02/26 职场文书
党员观看《筑梦中国》心得体会
2016/01/18 职场文书