Django之信号
01-什么是信号?
Django 提供一个“信号分发器”,允许解耦的应用在框架的其它地方发生操作时会被通知到。 简单来说,信号允许特定的sender通知一组receiver某些操作已经发生。 这在多处代码和同一事件有关联的情况下很有用。
02-内置信号
# 模型信号
Model signals pre_init # django的modal执行其构造方法前,自动触发 post_init # django的modal执行其构造方法后,自动触发 pre_save # django的modal对象保存前,自动触发 post_save # django的modal对象保存后,自动触发 pre_delete # django的modal对象删除前,自动触发 post_delete # django的modal对象删除后,自动触发 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 # 创建数据库连接时,自动触发
Django 提供了一系列的内建信号,允许用户的代码获得DJango的特定操作的通知。这包含一些有用的通知:
django.db.models.signals.pre_save & django.db.models.signals.post_save 在模型 save()方法调用之前或之后发送。 django.db.models.signals.pre_delete & django.db.models.signals.post_delete 在模型delete()方法或查询集的delete() 方法调用之前或之后发送。 django.db.models.signals.m2m_changed 模型上的 ManyToManyField 修改时发送。 django.core.signals.request_started & django.core.signals.request_finished Django建立或关闭HTTP 请求时发送。
对于Django内置的信号,仅需注册指定信号,当程序执行相应操作时,自动触发注册函数:
方式1:
# __init__.py 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 def callback(sender, **kwargs): print("pre_save_callback") print(sender, kwargs) pre_save.connect(callback) # 该脚本代码需要写到app或者项目的初始化文件中,当项目启动时执行注册代码
也可以使用装饰器来触发信号,把上面__init__.py
中的代码修改:
方式二:
from django.core.signals import request_finished from django.dispatch import receiver @receiver(request_finished) def callback(sender, **kwargs): print("Request finished!")
则在本次请求结束后自动触发callback函数,在后台"request finished"
这句话。
03-自定义信号
3.1 定义信号
所有信号都是 django.dispatch.Signal 的实例。 providing_args是一个列表,由信号将提供给监听者的参数名称组成。 理论上是这样,但是实际上并没有任何检查来保证向监听者提供了这些参数。
新建一个项目,配置好路由,在项目根目录下创建一个singal.py
的文件,内容为:
# 自定义信号 from django.dispatch import Signal bath_done = Signal(providing_args=['amount', 'temperature'])
这里定义了一个洗澡水烧好了的信号,它接受两个参数:amount表示水量,temperature表示温度。
3.2 注册信号
# __init__.py from singal import bath_done from django.dispatch importreceiver @receiver(bath_done) def my_action(sender, **kwargs): print(sender) print(kwargs) print('脱衣服泡个澡吧!')
3.3 触发信号
# views.py from singal import bath_done bath_done.send(sender='斯嘉丽', amount='一浴缸', temperature='40°')
由于内置信号的触发者已经集成到Django中,所以其会自动调用,而对于自定义信号则需要开发者在任意位置触发。即在任意位置,导入这个函数,然后进行方法调用。