Django ORM中Case与When的用法及报错排查

问题场景 #

一段可在MySQL命令行正常运行的SQL查询，转写为Django ORM代码时触发错误，需要理解Case和When的工作原理并定位报错原因。

原SQL查询

SELECT CASE WHEN LENGTH(au.first_name) < 1 THEN au.username ELSE concat(au.first_name,' ',au.last_name)
END AS fullname FROM rewards_usercard ru RIGHT JOIN auth_user au ON ru.user_id = au.id;

报错的Django ORM代码

from django.db.models import Case, When, Q, CharField, Value
from django.db.models.functions import Length, Concat
from django.db.models.lookups import LessThan

queryset = UserCard.objects.annotate(
            full_name = Case(
                When(condition=Q(
                    LessThan(Length('user__first_name'),1)
                ), then='user__username'),
                default = Concat('user__first_name', Value(' '), 'user__last_name'),
                output_field=CharField()
            )
            )

错误信息

cannot unpack non-iterable LessThan object

Django ORM中Case和When的工作原理 #

• Case：对应SQL里的CASE语句，用来实现条件分支逻辑。它会按顺序匹配每个When子句的条件，返回第一个匹配的then值；所有条件都不满足时，返回default指定的值。output_field用来明确返回结果的字段类型，避免Django自动推断出错。
• When：定义单个条件分支，condition参数接受查询条件（可以是Q对象、查询表达式的比较结果），then参数指定满足条件时返回的值（可以是字段名、表达式或者常量值）。

报错原因 #

你错误地将LessThan这个Lookup实例直接传入了Q()构造函数。Q对象的构造逻辑是接收键值对形式的查询条件（比如user__first_name__length__lt=1）或者其他Q对象组合，而LessThan(Length('user__first_name'),1)是一个不可迭代的Lookup对象，Q无法对其进行解析，从而抛出“无法解包不可迭代的LessThan对象”的错误。

修正后的代码 #

有两种正确的写法：

写法一：使用表达式直接比较

from django.db.models import Case, When, CharField, Value
from django.db.models.functions import Length, Concat

queryset = UserCard.objects.annotate(
    full_name=Case(
        When(Length('user__first_name') < 1, then='user__username'),
        default=Concat('user__first_name', Value(' '), 'user__last_name'),
        output_field=CharField()
    )
)

写法二：使用Q对象的字段查询语法

from django.db.models import Case, When, Q, CharField, Value
from django.db.models.functions import Concat

queryset = UserCard.objects.annotate(
    full_name=Case(
        When(Q(user__first_name__length__lt=1), then='user__username'),
        default=Concat('user__first_name', Value(' '), 'user__last_name'),
        output_field=CharField()
    )
)

另外注意：原SQL是RIGHT JOIN，但Django ORM默认从UserCard出发关联user是左连接，如果需要完全匹配原SQL的右连接逻辑，应该从User模型出发反向关联UserCard，示例如下：

from django.contrib.auth.models import User

queryset = User.objects.annotate(
    full_name=Case(
        When(first_name__length__lt=1, then='username'),
        default=Concat('first_name', Value(' '), 'last_name'),
        output_field=CharField()
    )
).filter(usercard__isnull=False)  # 若需过滤存在UserCard的用户则保留filter，否则移除

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