Django的信号
信号简介
Django提供一种信号机制。其实就是观察者模式,又叫发布-订阅(Publish/Subscribe) 。当发生一些动作的时候,发出信号,然后监听了这个信号的函数就会执行。
通俗来讲,就是一些动作发生的时候,信号允许特定的发送者去提醒一些接受者。用于在框架执行操作时解耦。
Django内置信号
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:
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
方式一:
#放到__init__里 from django.db.models.signals import pre_save import logging def callBack(sender, **kwargs): print(sender) print(kwargs) # 创建对象写日志 logging.basicConfig(level=logging.DEBUG) # logging.error('%s创建了一个%s对象'%(sender._meta.db_table,kwargs.get('instance').title)) logging.debug('%s创建了一个%s对象'%(sender._meta.model_name,kwargs.get('instance').title)) pre_save.connect(callBack)
方式二:
from django.db.models.signals import pre_save from django.dispatch import receiver @receiver(pre_save) def my_callback(sender, **kwargs): print("对象创建成功") print(sender) print(kwargs)
自定义信号
a. 定义信号(一般创建一个py文件)(toppings,size 是接受的参数)
import django.dispatch pizza_done = django.dispatch.Signal(providing_args=["toppings", "size"])
b. 注册信号
def callback(sender, **kwargs): print("callback") print(sender,kwargs) pizza_done.connect(callback)
c. 触发信号
from 路径 import pizza_done pizza_done.send(sender='seven',toppings=123, size=456)
由于内置信号的触发者已经集成到Django中,所以其会自动调用,而对于自定义信号则需要开发者在任意位置触发。
练习:数据库添加一条记录时生成一个日志记录。
源码分析
django中得signals和操作系统(linux)中的signal完全是两会事,后者的signal是软件中断,提供一种处理异步事件得方法,信号是系统定义好的,可用作进程间传递消息得一种方法,而django中的信号只是一个普通的类,不能跨进程,看其代码更像一个。。。callback。。。
django signal类定义在django/dispatch/dispatch.py中
class Signal(object): def __init__(self, providing_args=None): #providing_args 定义receiver调用参数格式,为None也没关系 self.receivers = [] ...... def connect(self, receiver, sender=None, weak=True, dispatch_uid=None): #看清楚了,其实就是把receiver保存起来,receiver是一个函数对象,就是该signal得handler ...... if dispatch_uid: lookup_key = (dispatch_uid, _make_id(sender)) else: lookup_key = (_make_id(receiver), _make_id(sender)) ...... self.lock.acquire() try: for r_key, _ in self.receivers: if r_key == lookup_key: break else: self.receivers.append((lookup_key, receiver)) finally: self.lock.release() def disconnect(self, receiver=None, sender=None, weak=True, dispatch_uid=None): #取消connect,把receiver从self.receivers删除就行了 ...... def send(self, sender, **named): #在事件发生时调用,发出信号,如有receive connect该信号,则调用之 responses = [] if not self.receivers: return responses for receiver in self._live_receivers(_make_id(sender)): response = receiver(signal=self, sender=sender, **named) responses.append((receiver, response)) return responses def send_robust(self, sender, **named): #基本同上 ...... def _live_receivers(self, senderkey): #从self.receivers中找出相应得receiver ...... def _remove_receiver(self, receiver): """ Remove dead receivers from connections. """ ......
整个信号得定义就这么简单,再来看看django中已定义好得一些signal, 在django/db/models/signal.py中
class Model(object): ...... def __init__(self, *args, **kwargs): signals.pre_init.send(sender=self.__class__, args=args, kwargs=kwargs) ...... signals.post_init.send(sender=self.__class__, instance=self) def save_base(self, raw=False, cls=None, origin=None, force_insert=False, force_update=False, using=None): ...... if origin and not meta.auto_created: signals.pre_save.send(sender=origin, instance=self, raw=raw, using=using) ...... # Signal that the save is complete if origin and not meta.auto_created: signals.post_save.send(sender=origin, instance=self, created=(not record_exists), raw=raw, using=using)