Django中自定义信号的使用和配置示例

下面是在django中定义一个自定义信号，并且使用信号的示例

在Django中，提供类django.dispatch.Signal作为内置信号/自定义信号的基类，该类是一个发布订阅模型，具体定义可以参考官方文档： https://docs.djangoproject.com/zh-hans/4.2/_modules/django/dispatch/dispatcher/#Signal

整个过程可以简述为：

Signal类定义了一个发布订阅类，使用self.receivers来存储订阅者（必须是一个callable），使用signal(实例).connect函数或者receivers装饰器来添加订阅者，使用signal.send函数来发送订阅信息。signal.send函数会调用每个订阅者(callable)

测试过程

1. 定义信号

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

​# 定义信号（Django3.1后不再使用 providing_args）
my_custom_signal = Signal()

2. 发送信号

发送信号时，直接传递需要的参数即可。

# myapp/views.py
from django.http import HttpResponse
from myapp.signals import my_custom_signal
​def my_view(request):    
# 发送信号
    my_custom_signal.send(sender=None, arg1="value1", arg2="value2")
    return HttpResponse("Signal sent!")

3. 接收信号

接收信号时，通过 **kwargs 获取传递的参数。

# myapp/signals.py
from django.dispatch import receiver
from myapp.signals import my_custom_signal
​@receiver(my_custom_signal)
def my_signal_handler(sender, **kwargs):
    arg1 = kwargs.get("arg1")    
    arg2 = kwargs.get("arg2")    
    print(f"Signal received! arg1={arg1}, arg2={arg2}")

4. 确保信号接收器被加载

在 apps.py 中确保信号接收器被加载。

# myapp/apps.py
from django.apps import AppConfig​
class MyAppConfig(AppConfig):    
    name = 'myapp'​    
    def ready(self):        
    # 导入信号接收器        
        import myapp.signals

在 settings.py 中确保应用配置被正确加载：

# settings.py
INSTALLED_APPS = [    
...    'myapp.apps.MyAppConfig',  # 使用应用的配置类    
...
]