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()
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,490评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,581评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,830评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,957评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,974评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,754评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,464评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,357评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,847评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,995评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,137评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,819评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,482评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,023评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,149评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,409评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,086评论 2 355

推荐阅读更多精彩内容

  • Django Model 定义语法 版本:1.7主要来源:https://docs.djangoproject.c...
    罗田阅读 31,033评论 2 42
  • Web框架之Django: (1)简介: Django是一个由Python写成开源的重量级Web应用框架,采用MT...
    老肖阅读 3,057评论 0 18
  • ``` window.location.hrref = "http://www.***.com"; ```
    i_木木木木木阅读 173评论 0 0
  • 起早摸黑忙忙碌碌就这样一天一天的过着重复生活,你会发现只会有人问你挣多少钱,却很少有人问你辛不辛苦,开不开...
    徐小姐123阅读 555评论 0 1
  • 原创/苹儿(茵草芳菲) 在石榴花盛开的五月中旬,受身居浙江、事业有成的刘同学之邀,我们一群毕业近40年的师生相聚浦...
    茵草芳菲阅读 2,325评论 21 26