正确的理解和使用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 相关文章推荐
python爬虫入门教程之点点美女图片爬虫代码分享
Sep 02 Python
Python中使用不同编码读写txt文件详解
May 28 Python
老生常谈Python序列化和反序列化
Jun 28 Python
Python网络爬虫神器PyQuery的基本使用教程
Feb 03 Python
详解tensorflow实现迁移学习实例
Feb 10 Python
Python爬虫工程师面试问题总结
Mar 22 Python
完美解决Python 2.7不能正常使用pip install的问题
Jun 12 Python
pygame游戏之旅 python和pygame安装教程
Nov 20 Python
Django实现一对多表模型的跨表查询方法
Dec 18 Python
python nmap实现端口扫描器教程
May 28 Python
wxpython布局的实现方法
Nov 01 Python
Python使用jupyter notebook查看ipynb文件过程解析
Jun 02 Python
编写python程序的90条建议
Apr 14 #Python
Python基础知识之变量的详解
理解深度学习之深度学习简介
Apr 14 #Python
python基于scrapy爬取京东笔记本电脑数据并进行简单处理和分析
深度学习小工程练习之垃圾分类详解
python3美化表格数据输出结果的实现代码
Apr 14 #Python
Python生成九宫格图片的示例代码
You might like
CI框架实现优化文件上传及多文件上传的方法
2017/01/04 PHP
Laravel配合jwt使用的方法实例
2020/10/25 PHP
javascript动态加载二
2012/08/22 Javascript
jQuery使用动态渲染表单功能完成ajax文件下载
2013/01/15 Javascript
SwfUpload在IE10上不出现上传按钮的解决方法
2013/06/25 Javascript
使用Plupload实现直接上传附件至七牛云存储
2014/12/26 Javascript
JS实现的简洁纵向滑动菜单(滑动门)效果
2015/10/19 Javascript
Angular 根据 service 的状态更新 directive
2016/04/03 Javascript
JavaScript学习笔记--常用的互动方法
2016/12/07 Javascript
JS控件bootstrap suggest plugin使用方法详解
2017/03/25 Javascript
浅谈通过JS拦截 pushState和replaceState事件
2017/07/21 Javascript
使用Electron构建React+Webpack桌面应用的方法
2017/12/15 Javascript
解决layui前端框架 form表单,table表等内置控件不显示的问题
2018/08/19 Javascript
nodejs遍历文件夹下并操作HTML/CSS/JS/PNG/JPG的方法
2018/11/01 NodeJs
Layui 动态禁止select下拉的例子
2019/09/03 Javascript
详解React 条件渲染
2020/07/08 Javascript
Js图片点击切换轮播实现代码
2020/07/27 Javascript
解决Element中el-date-picker组件不回填的情况
2020/11/07 Javascript
Python编程中time模块的一些关键用法解析
2016/01/19 Python
一个基于flask的web应用诞生 用户注册功能开发(5)
2017/04/11 Python
使用Python3制作TCP端口扫描器
2017/04/17 Python
Flask框架URL管理操作示例【基于@app.route】
2018/07/23 Python
python微信公众号之关注公众号自动回复
2018/10/25 Python
python实现浪漫的烟花秀
2019/01/30 Python
python实现简易学生信息管理系统
2020/04/05 Python
利用python生成照片墙的示例代码
2020/04/09 Python
matplotlib之多边形选区(PolygonSelector)的使用
2021/02/24 Python
回馈慈善的设计师太阳镜:DIFF eyewear
2019/10/17 全球购物
2014年迎新年活动方案
2014/02/19 职场文书
青安岗事迹材料
2014/05/14 职场文书
计算机求职信
2014/07/02 职场文书
求职信格式范文
2015/03/19 职场文书
2015教师个人师德工作总结
2015/10/23 职场文书
利用python Pandas实现批量拆分Excel与合并Excel
2021/05/23 Python
OpenCV-Python使用cv2实现傅里叶变换
2021/06/09 Python
Elasticsearch6.2服务器升配后的bug(避坑指南)
2022/09/23 Servers