Django自定义模型QuerySet动态返回翻译字段的实现问题

问题背景 #

现有多语言模型架构：每个业务模型（如Car）对应一个翻译模型（如CarTranslation），翻译模型存储对应语言的文本字段值。需求是在视图中根据用户语言设置，返回对应语言的翻译内容（无翻译时返回默认英文内容），原实现通过序列化器上下文处理，现希望改用自定义QuerySet/模型管理器优化。

尝试两种QuerySet实现均报错：ValueError: The annotation 'name' conflicts with a field on the model.

错误原因 #

1. 第一种实现：直接用模型已存在的name/description作为注解字段名，Django禁止注解名与模型原有字段名重复，因此触发冲突错误。
2. 第二种实现：先注解为translated_*，再通过values()重命名回原字段名，但values()返回的是字典QuerySet，无法适配依赖模型实例的ModelSerializer，同时重命名操作也无法覆盖模型本身的字段定义，仍会导致冲突。

解决方案 #

方案1：FilteredRelation关联+序列化器字段映射 #

通过FilteredRelation关联指定语言的翻译记录，注解为不冲突的字段名，再在序列化器中映射回原字段名，既避免注解冲突，又能正常使用ModelSerializer。

1. 自定义QuerySet与模型管理器

from django.db.models import FilteredRelation, Q, F
from django.db.models.functions import Coalesce
from django.db import models

class CarQuerySet(models.QuerySet):
    def with_translation(self, language):
        if language == "en":
            return self
        # 过滤关联当前语言的翻译记录
        return self.annotate(
            target_translation=FilteredRelation(
                'cartranslation_set',
                condition=Q(cartranslation_set__language=language)
            )
        ).annotate(
            # 优先取翻译值，无翻译则用原模型字段值
            translated_name=Coalesce(F('target_translation__name'), F('name')),
            translated_description=Coalesce(F('target_translation__description'), F('description'))
        )

class CarManager(models.Manager):
    def get_queryset(self):
        return CarQuerySet(self.model, using=self._db)

class Car(models.Model):
    name = models.CharField(max_length=255)
    description = models.TextField()
    objects = CarManager()

class CarTranslation(models.Model):
    car = models.ForeignKey(to=Car, on_delete=models.CASCADE)
    language = models.CharField(choices=LANGUAGE_CHOICES, max_length=10)
    name = models.CharField(max_length=255)
    description = models.TextField()

2. 序列化器映射字段

from rest_framework import serializers
from .models import Car

class CarSerializer(serializers.ModelSerializer):
    # 将序列化器的name/description指向QuerySet注解的翻译字段
    name = serializers.CharField(source='translated_name')
    description = serializers.CharField(source='translated_description')

    class Meta:
        model = Car
        fields = ['id', 'name', 'description']

3. 视图调用

from rest_framework.generics import ListAPIView
from .models import Car
from .serializers import CarSerializer

class CarView(ListAPIView):
    serializer_class = CarSerializer

    def get_queryset(self):
        user_language = self.request.user.language
        return Car.objects.with_translation(user_language)

方案2：模型Property方法自动返回翻译值 #

如果不想修改序列化器，可以在模型中添加property方法，自动返回注解的翻译值或原字段值：

class Car(models.Model):
    name = models.CharField(max_length=255)
    description = models.TextField()
    objects = CarManager()

    @property
    def name(self):
        return getattr(self, 'translated_name', self._name)
    
    @property
    def description(self):
        return getattr(self, 'translated_description', self._description)
    
    # 保留原字段的私有访问入口
    @property
    def _name(self):
        return super().name
    
    @property
    def _description(self):
        return super().description

此时序列化器无需修改，直接使用原字段名即可自动获取翻译后的值。

额外修正点 #

原第二种实现中存在语法错误：car==OuterRef("pk")应改为car=OuterRef("pk")，双等于号会导致参数传递错误。

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