如何在Django序列化器中判断ManyRelatedManager是否为空？

相关代码 #

models.py #

class Role:
    name = models.CharFiled(max_length=100)

    comp = models.ForeignKey(Company, models.CASCADE,
                             related_name="comp_roles")

    users = models.ManyToManyField(User, related_name='user_roles',
                                    related_query_name='user_role',
                                    through='UserRole')

class UserRole(models.Model):
    user = models.ForeignKey(User, on_delete=models.CASCADE)
    role = models.ForeignKey(Role, on_delete=models.CASCADE)

api_views.py 中的查询语句 #

• Role.objects.filter(comp_id=self.comp_id).prefetch_related('users')
• Role.objects.filter(comp_id=self.comp_id)

RoleSerializer.py #

class RoleSerializer(serializers.ModelSerializer):

    users = serializers.SerializerMethodField()

    def get_users(self, obj):
        logger.info(f"this is obj.users: {obj.users}")
        logger.info(f"this is n obj.users: {obj.users == None}")

        # hit the db:
        # if not obj.users.all():
        # if obj.users.exists() == None:

        # no hit the db:
        # if obj.users.all() == None:
        # if obj.users == None:

        if obj.users.all() == None:
            logger.info(f"obj.users is None!")
            return None
        
        logger.info(f"obj.users is not None!")
        serializer = UserReadSerializer(obj.users.all(), many=True)
        return serializer.data

当前obj.users == None和obj.users.all() == None的判断结果始终为false，需要在get_users方法中正确判断关联的用户是否为空，从而返回None或序列化后的用户数据。

核心问题是：Django的ManyToMany关联对象永远不会等于None——obj.users是ManyRelatedManager实例，obj.users.all()返回的是QuerySet实例，这两者都不会等于None，所以之前的判断逻辑完全不成立。

针对你的两种查询场景（有预取/无预取），可以用以下几种方式处理：

1. 直接判断用户列表是否为空（兼容所有场景） #

def get_users(self, obj):
    user_list = obj.users.all()
    if not user_list:
        return None
    return UserReadSerializer(user_list, many=True).data

• 如果已经用prefetch_related('users')预取数据，obj.users.all()会直接使用缓存，不会触发新的SQL查询；
• 未预取时，会触发一次查询获取用户列表。

2. 用exists()高效判断（适合无预取场景） #

如果想避免获取完整用户列表，用exists()只检查是否存在关联记录，性能更优：

def get_users(self, obj):
    if not obj.users.exists():
        return None
    return UserReadSerializer(obj.users.all(), many=True).data

• 预取过数据的情况下，exists()也会直接用缓存判断，不会额外查询数据库。

3. 检查预取缓存（针对明确使用prefetch_related的场景） #

如果确定当前查询用了预取，可以直接读取Django的预取缓存，完全避免数据库查询：

def get_users(self, obj):
    # 检查是否存在预取的users缓存
    if hasattr(obj, '_prefetched_objects_cache') and 'users' in obj._prefetched_objects_cache:
        user_list = obj._prefetched_objects_cache['users']
        if not user_list:
            return None
        return UserReadSerializer(user_list, many=True).data
    # 无预取时走正常判断逻辑
    if not obj.users.exists():
        return None
    return UserReadSerializer(obj.users.all(), many=True).data

内容的提问来源于stack exchange，提问作者Seyed Mostafa SeyedAshoor