正確的理解和使用Django信號(hào)(Signals)

Django 提供一個(gè)了“信號(hào)分發(fā)器”機(jī)制，允許解耦的應(yīng)用在框架的其它地方發(fā)生操作時(shí)會(huì)被通知到。 通俗而講Django信號(hào)的工作原理就是當(dāng)某個(gè)事件發(fā)生的時(shí)候會(huì)發(fā)出一個(gè)信號(hào)(signals), 而監(jiān)聽(tīng)這個(gè)信號(hào)的函數(shù)(receivers)就會(huì)立即執(zhí)行。Django信號(hào)的應(yīng)用場(chǎng)景很多，尤其是用于不同模型或程序間的聯(lián)動(dòng)。常見(jiàn)例子包括創(chuàng)建User對(duì)象實(shí)例時(shí)創(chuàng)建一對(duì)一關(guān)系的UserProfile對(duì)象實(shí)例，或者每當(dāng)用戶下訂單時(shí)觸發(fā)給管理員發(fā)郵件的動(dòng)作。今天小編我就分享下如何正確使用Django的信號(hào)(signals)。

Django信號(hào)的一個(gè)簡(jiǎn)單例子

假設(shè)我們有一個(gè)如下User模型，我們希望每次有User對(duì)象新創(chuàng)建時(shí)都打印出有新用戶注冊(cè)的提示信息，我們可以使用Django信號(hào)(signals）輕松實(shí)現(xiàn)。我們的信號(hào)發(fā)送者sender是User模型，每當(dāng)User模型執(zhí)行post_save動(dòng)作時(shí)就會(huì)發(fā)出信號(hào)。此時(shí)我們自定義的create_user函數(shù)一旦監(jiān)聽(tīng)到User發(fā)出的post_save信號(hào)就會(huì)執(zhí)行，先通過(guò)if created判斷對(duì)象是新創(chuàng)建的還是被更新的；如果對(duì)象是新創(chuàng)建的，就會(huì)打印出提示信息。

# 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)

在上例中我們使用了信號(hào)(post_save)自帶的connect的方法將自定義的函數(shù)與信號(hào)發(fā)出者(sender)User模型進(jìn)行了連接。在實(shí)際應(yīng)用中一個(gè)更常用的方式是使用@receiver裝飾器實(shí)現(xiàn)發(fā)送者與監(jiān)聽(tīng)函數(shù)的連接，如下所示。@receiver(post_save, sender=User)讀起來(lái)的意思就是監(jiān)聽(tīng)User模型發(fā)出的post_save信號(hào)。

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信號(hào)實(shí)現(xiàn)不同模型的聯(lián)動(dòng)更新

我們?cè)賮?lái)看一個(gè)復(fù)雜一點(diǎn)的例子。我們有一個(gè)Profile模型，與User模型是一對(duì)一的關(guān)系。我們希望創(chuàng)建User對(duì)象實(shí)例時(shí)也創(chuàng)建Profile對(duì)象實(shí)例，而使用post_save更新User對(duì)象時(shí)不創(chuàng)建新的Profile對(duì)象。這時(shí)我們就可以自定義create_user_profile和save_user_profile兩個(gè)監(jiān)聽(tīng)函數(shù)，同時(shí)監(jiān)聽(tīng)sender(User模型)發(fā)出的post_save信號(hào)。由于post_save可同時(shí)用于模型的創(chuàng)建和更新，我們用if created這個(gè)判斷來(lái)加以區(qū)別。

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常用內(nèi)置信號(hào)

之前的例子中我們使用的都是post_save信號(hào)，即在模型調(diào)用save()方法后才發(fā)送信號(hào)。Django其它常用內(nèi)置信號(hào)還包括:

• django.db.models.signals.pre_save post_save在模型調(diào)用 save()方法之前或之后發(fā)送。
• django.db.models.signals.pre_init post_init在模型調(diào)用_init_方法之前或之后發(fā)送。
• django.db.models.signals.pre_delete post_delete在模型調(diào)用delete()方法或查詢集調(diào)用delete() 方法之前或之后發(fā)送。
• django.db.models.signals.m2m_changed在模型多對(duì)多關(guān)系改變后發(fā)送。
• django.core.signals.request_started request_finished Django建立或關(guān)閉HTTP 請(qǐng)求時(shí)發(fā)送。

如何正確放置Django信號(hào)的監(jiān)聽(tīng)函數(shù)代碼

在之前案例中，我們將Django信號(hào)的監(jiān)聽(tīng)函數(shù)寫(xiě)在了models.py文件里。當(dāng)一個(gè)app的與信號(hào)相關(guān)的自定義監(jiān)聽(tīng)函數(shù)很多時(shí)，此時(shí)models.py代碼將變得非常臃腫。一個(gè)更好的方式把所以自定義的信號(hào)監(jiān)聽(tīng)函數(shù)集中放在app對(duì)應(yīng)文件夾下的signals.py文件里，便于后期集中維護(hù)。

假如我們有個(gè)account的app，包含了User和Pofile模型，我們不僅需要在account文件夾下新建signals.py，還需要修改account文件下apps.py和__init__.py，以導(dǎo)入創(chuàng)建的信號(hào)監(jiān)聽(tīng)函數(shù)。

# 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'

小結(jié)

在本文里我們總結(jié)了Django信號(hào)(signals)的工作原理，介紹了如何使用Django信號(hào)實(shí)現(xiàn)模型或程序的聯(lián)動(dòng)。最后我們還總結(jié)了Django常用內(nèi)置信號(hào)以及如何正確放置自定義的信號(hào)監(jiān)聽(tīng)函數(shù)。歡迎關(guān)注我們更多Python Web開(kāi)發(fā)和Django原創(chuàng)文章。

以上就是正確的理解和使用Django信號(hào)(Signals)的詳細(xì)內(nèi)容，更多關(guān)于Django信號(hào)(Signals)的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！