Python高级技术之：`Django`的信号（`Signals`）：在`Web`应用中实现解耦和事件驱动。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，大家好！今天咱们来聊聊 Django 里的“信号”，这玩意儿就像 Web 应用里的“小喇叭”，哪里发生了啥事儿，它就嗷嗷地喊，告诉大家一声。有了它，咱就能实现解耦和事件驱动，让代码更优雅、更灵活。

一、啥是信号？为啥要用它？

想象一下，你开了一家电商网站，用户注册成功后，你可能需要做以下几件事：

发送欢迎邮件
给用户增加积分
记录用户注册日志
同步用户信息到第三方 CRM 系统

如果把这些逻辑都写在用户注册的视图函数里，代码会变得非常臃肿，而且耦合性很高。以后如果需要增加或修改某个功能，就得改动视图函数，风险很大。

这时候，信号就派上用场了。你可以定义一个“用户注册成功”的信号，然后让其他函数（也就是“接收者”）来监听这个信号。当用户注册成功时，信号就会被“发射”，所有监听它的接收者都会被调用。

用人话说，就是你注册成功了，信号这个“小喇叭”就喊一声：“新用户注册啦！”，然后各个“部门”（接收者）听到喇叭声，就知道该干啥了。

信号的好处：

解耦： 各个功能模块之间互不依赖，修改一个模块不会影响其他模块。
事件驱动： 系统对事件做出响应，而不是按部就班地执行。
可扩展性： 很容易增加或删除功能，只需添加或移除接收者即可。
代码清晰： 逻辑分散在各个接收者中，视图函数更简洁。

二、Django 信号的种类

Django 内置了很多常用的信号，它们大致可以分为两类：

模型信号（Model Signals）： 在模型实例发生变化时触发，比如保存、删除等。
请求/响应信号（Request/Response Signals）： 在处理 HTTP 请求和响应时触发。

下面是一些常用的模型信号：

信号名称	触发时机
`pre_save`	在模型实例保存之前触发。
`post_save`	在模型实例保存之后触发。
`pre_delete`	在模型实例删除之前触发。
`post_delete`	在模型实例删除之后触发。
`m2m_changed`	在多对多关系发生变化时触发（例如，添加、删除、清空关联对象）。

常用的请求/响应信号：

信号名称	触发时机
`request_started`	在 Django 接收到 HTTP 请求时触发。
`request_finished`	在 Django 完成处理 HTTP 请求并发送响应后触发。
`got_request_exception`	当处理请求时发生未捕获的异常时触发。

除了内置信号，你还可以自定义信号，以满足特定的需求。

三、如何使用信号？

使用信号主要涉及三个步骤：

定义信号（可选）： 如果使用内置信号，可以跳过此步骤。
定义接收者（Receiver）： 编写函数或方法来处理信号。
连接信号和接收者： 将接收者连接到信号，以便在信号触发时调用接收者。

1. 定义信号（自定义信号）

如果你需要自定义信号，可以使用 django.dispatch.Signal 类。通常在一个单独的 signals.py 文件中定义。

# myapp/signals.py
from django.dispatch import Signal

user_registered = Signal(providing_args=["user"])  # 定义一个名为 user_registered 的信号，它会传递 user 对象

providing_args 参数指定了信号会传递给接收者的参数。

2. 定义接收者

接收者就是一个普通的 Python 函数或方法，它接收信号传递的参数，并执行相应的操作。

# myapp/receivers.py
from django.dispatch import receiver
from .signals import user_registered
from django.core.mail import send_mail
from django.conf import settings
from .models import UserProfile

@receiver(user_registered)  # 使用 @receiver 装饰器将 send_welcome_email 函数连接到 user_registered 信号
def send_welcome_email(sender, **kwargs):
    user = kwargs['user']
    send_mail(
        '欢迎注册！',
        '感谢您的注册！',
        settings.DEFAULT_FROM_EMAIL,
        [user.email],
        fail_silently=False,
    )

    # 创建用户 Profile
    UserProfile.objects.create(user=user)

@receiver 装饰器用于将函数连接到信号。
sender 参数表示发送信号的对象（通常是一个模型类）。
**kwargs 参数包含信号传递的其他参数，比如我们自定义的 user 参数。

3. 连接信号和接收者

有两种方法可以将信号和接收者连接起来：

使用 @receiver 装饰器（推荐）： 如上面的例子所示，使用 @receiver 装饰器可以简化连接过程。
手动连接： 在 ready() 方法中手动连接信号和接收者。

# myapp/apps.py
from django.apps import AppConfig

class MyappConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'myapp'

    def ready(self):
        import myapp.receivers  # 确保 receivers.py 中的代码被执行
        from .signals import user_registered
        from .receivers import send_welcome_email  # 显式导入接收者

        # 手动连接信号和接收者
        user_registered.connect(send_welcome_email)

重要： 必须在 apps.py 的 ready() 方法中导入 receivers.py 文件，才能确保接收者被注册。并且在myapp/apps.py中使用user_registered.connect(send_welcome_email)手动连接信号和接收者时，需要显式导入接收者函数send_welcome_email，保证接收者函数能够被找到。

4. 发射信号

在需要触发信号的地方，调用信号的 send() 方法。

# myapp/views.py
from django.shortcuts import render, redirect
from django.contrib.auth.forms import UserCreationForm
from django.contrib.auth import login
from .signals import user_registered

def register(request):
    if request.method == 'POST':
        form = UserCreationForm(request.POST)
        if form.is_valid():
            user = form.save()
            login(request, user)
            user_registered.send(sender=register, user=user)  # 发射 user_registered 信号，传递 user 对象
            return redirect('home')
    else:
        form = UserCreationForm()
    return render(request, 'register.html', {'form': form})

user_registered.send(sender=register, user=user) 这行代码发射了 user_registered 信号。

sender 参数表示发送信号的对象，通常是视图函数、模型类等。
user 参数是我们自定义的参数，它会被传递给接收者。

四、一个完整的例子

假设我们有一个 Product 模型，当商品库存不足时，我们需要发送邮件通知管理员。

定义信号（可选）： 在 products/signals.py 中定义一个 stock_low 信号。

# products/signals.py
from django.dispatch import Signal

stock_low = Signal(providing_args=["product"])

定义接收者： 在 products/receivers.py 中定义一个 send_stock_low_email 函数，用于发送邮件。

# products/receivers.py
from django.dispatch import receiver
from .signals import stock_low
from django.core.mail import send_mail
from django.conf import settings

@receiver(stock_low)
def send_stock_low_email(sender, **kwargs):
    product = kwargs['product']
    send_mail(
        '商品库存不足！',
        f'商品 {product.name} 库存不足，请及时补充！',
        settings.DEFAULT_FROM_EMAIL,
        ['[email protected]'],  # 替换为管理员邮箱
        fail_silently=False,
    )

连接信号和接收者： 在 products/apps.py 的 ready() 方法中导入 receivers.py 文件。

# products/apps.py
from django.apps import AppConfig

class ProductsConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'products'

    def ready(self):
        import products.receivers # 确保 receivers.py 中的代码被执行

发射信号： 在 Product 模型的 save() 方法中，当库存低于某个阈值时，发射 stock_low 信号。

# products/models.py
from django.db import models
from .signals import stock_low

class Product(models.Model):
    name = models.CharField(max_length=255)
    stock = models.IntegerField(default=0)

    def save(self, *args, **kwargs):
        super().save(*args, **kwargs)
        if self.stock < 10:  # 当库存低于 10 时，发送信号
            stock_low.send(sender=self.__class__, product=self)

这样，当商品库存低于 10 时，管理员就会收到邮件通知。

五、一些注意事项

信号的顺序： 接收者按照它们被连接到信号的顺序执行。如果你需要控制执行顺序，可以使用 priority 参数（例如：@receiver(signal, priority=10)）。
避免循环依赖： 确保信号和接收者之间的依赖关系不会导致循环依赖。
异常处理： 在接收者中处理可能发生的异常，避免影响其他接收者。
测试： 编写测试用例来验证信号和接收者的功能是否正常。可以使用 django.test.signals.assertNumSignals() 来断言信号被触发的次数。

六、使用场景

除了上面提到的例子，信号还可以用于以下场景：

审计日志： 记录用户对数据的修改操作。
缓存失效： 当数据发生变化时，清除相关的缓存。
任务调度： 当某个事件发生时，触发一个异步任务。
第三方集成： 将 Django 应用与其他系统集成。

七、总结

Django 信号是一种强大的机制，可以帮助你构建解耦、可扩展、事件驱动的 Web 应用。合理地使用信号，可以让你的代码更优雅、更易于维护。

希望今天的讲座能帮助大家更好地理解 Django 信号。记住，信号就像 Web 应用里的“小喇叭”，善用它，可以让你的代码更高效、更灵活！

下次有机会再跟大家分享其他有趣的技术话题，感谢大家的观看！散会！

发表回复 取消回复

发表回复取消回复