Django 源码解读-signal实现（一）

signal在django中用于发送通知，在django中内置的信号包括 post_save, pre_delete 等；使用这些信号可以很方便实现业务逻辑与model之间的解耦。

应用场景

适用于：当修改model的时候，需要执行一些与当前app无关额外的操作，比如逻辑中包含第三方的库；执行的多个行为且后续仍可能添加操作等；
不适用：修改当前app中的某个model，这种场景建议放到save函数中执行；

适用场景，比如当用户订单支付成功之后，通常需要做以下事情

• 发送邮件通知用户支付成功
• 通知聊天程序（阿里旺旺）
• 通知卖家备货
• 开始追踪物流信息
• 其他可能的行为....

以上行为都依赖于支付成功事件；如果上述行为写到model的save() 函数中，就会使得业务逻辑紧耦合；推荐的做法是使用signal发送一个通知到消息队列，其他的任务（进程）监听消息队列，然后分别执行上述行为；

例子

1. signal应用的例子：

# order/models.py
class Order(models.Model):
    """

    """
    ORDER_STATUS = (
        ("TRADE_CLOSED", "超时关闭"),
        ("PAYING", "待支付"),
        ("UNCONFIRMED", "待付款确认"),
        ("CONFIRMED", "已确认"),
    )

    user = models.ForeignKey(UserModel, related_name="user_orders", verbose_name="用户", db_index=True)
    # 订单号规则，使用统一方法创建，主机id，进程号，时间ms+随机数
    order_sn = models.CharField(max_length=35, verbose_name="订单号", null=True, blank=True, unique=True, db_index=True)
    trade_no = models.CharField(max_length=100, unique=True, null=True, blank=True, verbose_name=u"交易号", db_index=True)

    pay_status = models.CharField(choices=ORDER_STATUS, default="PAYING", blank=True, max_length=30, verbose_name="订单状态")
    post_message = models.CharField(max_length=200, verbose_name="订单留言", default="", blank=True, null=True)
    order_mount = models.FloatField(default=0.0, verbose_name="订单金额")
    
    confirm_time = models.DateTimeField(null=True, blank=True, verbose_name="确认时间", default=None)
    create_time = models.DateTimeField(auto_now_add=True, verbose_name="创建时间")

    class Meta:
        verbose_name = u"订单"
        verbose_name_plural = verbose_name

#order/signals.py
from django.db.models.signals import post_save
from django.dispatch import receiver

@receiver(post_save, sender=Order)
def order_change(sender, instance=None, created=False, **kwargs):
    if not created and instance:
        if instance.pay_status == "CONFIRMED":
            # 发送订单信息到消息队列

# apps.py
# 这里需要import signals文件
from django.apps import AppConfig
from django.db.models.signals import post_save

class OrderConfig(AppConfig):
    def ready(self):
        import order.signals

2. anti-pattern 例子，pizza model包含一个 意大利香肠字段 has_pepperoni；ToppingSales用于统计各种属性的销售数量；当售出一份pizza之后，如果包含意大利香肠，则修改ToppingSales 中name为意大利香肠的销售量；

# File: models.py
from django.db import models

class Pizza(models.Model):
    has_pephas_pepperoniperoni = models.BooleanField(default=False)
   
class ToppingSales(models.Model):
    name = models.CharField(max_length=100, unique=True)
    units_sold = models.PositiveIntegerField(default=0)


# File: signals.py
from django.db.models.signals import post_save
from django.db.models import F
from django.dispatch import receiver
from .models import Pizza
@receiver(post_save, sender=Pizza)
def pizza_saved_handler(sender, instance, created, **kwargs):
    if created and instance.has_pepperoni:
        ToppingSales.objects.filter(name='pepperoni').update(
            units_sold=F('units_sold') + 1)

# File: app.py
from django.apps import AppConfig

class PizzeriaConfig(AppConfig):

    def ready(self):
        import pizza.signals

这里使用signal仅仅是为了修改使用意大利香肠的pizza 销售数量，仅一个行为关注此事件而且位于同一app内部；这种情况下推荐使用save 解决。

class Pizza(models.Model):
    has_pepperoni = models.BooleanField(default=False)
   
    def save(self, *args, **kwargs):
        created = self.pk is None
        super(Pizza, self).save(*args, **kwargs)
        if created and self.has_pepperoni:
            ToppingSales.objects.filter(name='pepperoni').update(
                units_sold=F('units_sold') + 1)           
   
class ToppingSales(models.Model):
    name = models.CharField(max_length=100, unique=True)
    units_sold = models.PositiveIntegerField(default=0)

分析

这里的signal的实现是应用的Observer设计模式，使用场景等可以参照设计模式书中描述；UML 类图如下：

20140820164359863.png

根据图中显示，Observer包含（聚合）了Subject的的实例（ConcreteObserver 注册到subject对象中），当事件发生之后，Subject instance通过notifyObservers() 接口实现通知具体Observer；

  def notifyObserver() :
    for observer in self.observers:
      observer.update()