Django当DEBUG = False时，信号不触发问题

蓝绿色~菠菜2023-07-23 20:31

今天突然发现生产环境中，某些信号没有被正确触发，一番调查总结一下关于django信号执行问题。

先看一个现象：

python 复制代码

# host/signals.py
@receiver(m2m_changed, sender=Vm.products.through)
def on_m2m_changed(sender, instance, action, pk_set, **kwargs):
    do something


@receiver(m2m_changed, sender=Vm.tags.through)
def on_m2m_changed(sender, instance, action, pk_set, **kwargs):
    do something


DEBUG=True时：
当修改Vm.products.through表时，第一个信号可以正常被触发，没什么问题
当修改Vm.tags.through表时，第二个信号可以正常被触发，也没什么问题
DEBUG=False时：
当修改Vm.products.through表时，第一个信号不能被正确触发
当修改Vm.tags.through表时，第二个信号可以正常被触发，没什么问题

也就是说是否开启debug模式会影响第一个信号的触发，查了下官方文档发现：

警告

还需要注意的是，Django 默认将信号处理程序存储为弱引用，所以如果你的处理程序是一个本地函数，它可能会被垃圾回收。为了防止这种情况，当你调用信号的 connect() 时，传入 weak=False。

然后尝试传入weak=False，果然信号被正确触发了。看来真的如文档所说的一样，第一个信号处理函数被垃圾回收了。

那不对啊，项目中其他用到信号的地方也没加weak参数，也没发现这种信号不被触发的问题。

回头看看，发现我这两个多对多信号处理函数名称相同了，尝试换了不一样的函数名，即使不使用weak参数，两个信号处理函数也能被正确触发。

至此问题已清晰明了，是因为两个信号处理函数同名了，导致第一个被垃圾回收了。

总结：

同一个文件中的信号处理函数名称不能一样，否则靠前的函数会被垃圾回收，除非传入weak=False参数声明为强引用。