如何为Django项目各应用配置独立Signals避免重复触发？

问题场景 #

我希望为Django项目的每个应用设置独立的Signals，但当前保存某一应用的模型时，所有应用的Signals都会触发，导致日志消息重复。请问为Django项目不同应用配置Signals的正确方式是什么？

原始代码示例 #

app1/signals.py

# -*- coding: utf-8 -*-
import logging

from django.db.models.signals import post_save
from django.dispatch import receiver

from .models import *


@receiver(post_save)
def log_app1_updated_added_event(sender, **kwargs):
    '''Writes information about newly added or updated objects of app1 into log file'''

    logger = logging.getLogger(__name__)

    app1_object = kwargs['instance']
    
    if kwargs['created']:
        logger.info(f'added {app1_object }')
    else:
        logger.info(f'updated {app1_object }')

app2/signals.py

# -*- coding: utf-8 -*-
import logging

from django.db.models.signals import post_save
from django.dispatch import receiver

from .models import *


@receiver(post_save)
def log_app2_updated_added_event(sender, **kwargs):
    '''Writes information about newly added or updated objects of app2 into log file'''

    logger = logging.getLogger(__name__)

    app2_object = kwargs['instance']
    
    if kwargs['created']:
        logger.info(f'added {app2_object }')
    else:
        logger.info(f'updated {app2_object }')

app1/apps.py

from django.apps import AppConfig


class App1Config(AppConfig):
    name = 'App1'

    def ready(self):
        from app1 import signals

app2/apps.py

from django.apps import AppConfig


class App1Config(AppConfig):
    name = 'App2'

    def ready(self):
        from app2 import signals

settings.py日志配置片段

'loggers': {
        'django': {
            'handlers': ['console',],
            'propagate': False,
            'level': 'INFO',
        },
        'app1.signals': {
            'handlers': ['console', 'file'],
            'level': 'INFO',
        },
        'app2.signals': {
            'handlers': ['console', 'file'],
            'level': 'INFO',
        },
     }

问题原因 #

1. 信号未限定监听范围：当前的@receiver(post_save)未指定sender参数，意味着接收器会监听所有模型的post_save信号，无论所属应用，导致跨应用触发。
2. 应用配置类名错误：app2的apps.py中类名为App1Config，与应用名称不匹配，可能导致配置加载异常。

解决方案 #

1. 为信号接收器指定专属模型 #

给每个信号接收器添加sender参数，限定只监听当前应用的模型，避免跨应用触发。

2. 修正应用配置类名 #

将app2的配置类名改为与应用匹配的App2Config。

修改后的代码示例 #

app1/signals.py（指定单一模型）

# -*- coding: utf-8 -*-
import logging

from django.db.models.signals import post_save
from django.dispatch import receiver

# 替换为app1的具体模型类
from .models import App1Model


@receiver(post_save, sender=App1Model)
def log_app1_updated_added_event(sender, **kwargs):
    '''记录app1模型新增/更新日志'''

    logger = logging.getLogger(__name__)
    app1_object = kwargs['instance']
    
    if kwargs['created']:
        logger.info(f'added {app1_object }')
    else:
        logger.info(f'updated {app1_object }')

如果需要监听app1多个模型，可以添加多个接收器：

# 示例：监听app1的第二个模型
from .models import App1AnotherModel

@receiver(post_save, sender=App1AnotherModel)
def log_app1_another_model_event(sender, **kwargs):
    app1_obj = kwargs['instance']
    logger = logging.getLogger(__name__)
    logger.info(f'{"added" if kwargs["created"] else "updated"} {app1_obj}')

app2/signals.py（指定单一模型）

# -*- coding: utf-8 -*-
import logging

from django.db.models.signals import post_save
from django.dispatch import receiver

# 替换为app2的具体模型类
from .models import App2Model


@receiver(post_save, sender=App2Model)
def log_app2_updated_added_event(sender, **kwargs):
    '''记录app2模型新增/更新日志'''

    logger = logging.getLogger(__name__)
    app2_object = kwargs['instance']
    
    if kwargs['created']:
        logger.info(f'added {app2_object }')
    else:
        logger.info(f'updated {app2_object }')

app2/apps.py（修正类名）

from django.apps import AppConfig


class App2Config(AppConfig):
    name = 'App2'

    def ready(self):
        from app2 import signals

验证效果 #

修改完成后，保存app1的模型实例时，仅app1的信号接收器触发；保存app2的模型实例时，仅app2的信号接收器触发，日志不再重复输出。

内容的提问来源于stack exchange，提问作者Oleh