正确的理解和使用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 相关文章推荐
Django如何实现内容缓存示例详解
Sep 24 Python
对Python中range()函数和list的比较
Apr 19 Python
python在文本开头插入一行的实例
May 02 Python
Python设置在shell脚本中自动补全功能的方法
Jun 25 Python
Scrapy框架使用的基本知识
Oct 21 Python
Python的log日志功能及设置方法
Jul 11 Python
Python利用requests模块下载图片实例代码
Aug 12 Python
tensorflow 实现打印pb模型的所有节点
Jan 23 Python
pandas中ix的使用详细讲解
Mar 09 Python
python+requests接口自动化框架的实现
Aug 31 Python
Python2及Python3如何实现兼容切换
Sep 01 Python
python使用scapy模块实现ARP扫描的过程
Jan 21 Python
编写python程序的90条建议
Apr 14 #Python
Python基础知识之变量的详解
理解深度学习之深度学习简介
Apr 14 #Python
python基于scrapy爬取京东笔记本电脑数据并进行简单处理和分析
深度学习小工程练习之垃圾分类详解
python3美化表格数据输出结果的实现代码
Apr 14 #Python
Python生成九宫格图片的示例代码
You might like
PHP中GET变量的使用
2006/10/09 PHP
php 日期和时间的处理-郑阿奇(续)
2011/07/04 PHP
PHP使用HTML5 FormData对象提交表单操作示例
2019/07/02 PHP
php文件上传原理与实现方法详解
2019/12/20 PHP
PHP xpath提取网页数据内容代码解析
2020/07/16 PHP
PHP并发场景的三种解决方案代码实例
2021/02/27 PHP
基于JavaScript实现继承机制之原型链(prototype chaining)的详解
2013/05/07 Javascript
JavaScript中访问节点对象的方法有哪些如何使用
2013/09/24 Javascript
JS图像无缝滚动脚本非常好用
2014/02/10 Javascript
jquery操作checkbox实现全选和取消全选
2014/05/02 Javascript
BootStrap selectpicker
2016/06/20 Javascript
基于Three.js插件制作360度全景图
2016/11/29 Javascript
详解Vue监听数据变化原理
2017/03/08 Javascript
JavaScript简介_动力节点Java学院整理
2017/06/26 Javascript
Vue实现一个返回顶部backToTop组件
2017/07/25 Javascript
vue2.0安装style/css loader的方法
2018/03/14 Javascript
vue使用pdfjs显示PDF可复制的实现方法
2018/12/14 Javascript
微信小程序实现swiper切换卡内嵌滚动条不显示的方法示例
2018/12/20 Javascript
放弃 Python 转向 Go语言有人给出了 9 大理由
2017/10/20 Python
numpy排序与集合运算用法示例
2017/12/15 Python
100行Python代码实现自动抢火车票(附源码)
2018/01/11 Python
python超时重新请求解决方案
2019/10/21 Python
Python全局锁中如何合理运用多线程(多进程)
2019/11/06 Python
Python日志logging模块功能与用法详解
2020/04/09 Python
Python 使用生成器代替线程的方法
2020/08/04 Python
python 8种必备的gui库
2020/08/27 Python
如何利用Python matplotlib绘制雷达图
2020/12/21 Python
PyCharm+Miniconda3安装配置教程详解
2021/02/16 Python
Lands’ End英国官方网站:高质量男女服装
2017/10/07 全球购物
高中军训感言200字
2014/02/23 职场文书
2015年学校办公室工作总结
2015/05/26 职场文书
新生儿未入户证明
2015/06/23 职场文书
企业宣传语大全
2015/07/13 职场文书
银行客户经理培训心得体会
2016/01/09 职场文书
Html5新增了哪些功能
2021/04/16 HTML / CSS
Java实现二维数组和稀疏数组之间的转换
2021/06/27 Java/Android