Django REST Framework：UserProfile接口如何返回关联User模型字段？

嘿，这个需求我太熟悉了！在DRF里要让UserProfile接口返回关联User模型的字段，有几个实用的方案，我给你挨个说清楚：

方案1：使用嵌套序列化器（最直观的方式） #

这种方式适合你想把User的字段以嵌套结构返回的场景，步骤很简单：

1. 先定义一个User模型的序列化器，指定要返回的字段
2. 在UserProfileSerializer里关联这个序列化器

from rest_framework import serializers
from django.contrib.auth.models import User
from .models import UserProfile

# 定义User的序列化器，只返回需要的字段
class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ('first_name', 'last_name', 'email')

class UserProfileSerializer(serializers.ModelSerializer):
    # 关联User序列化器，read_only=True避免修改User数据
    user = UserSerializer(read_only=True)

    class Meta:
        model = UserProfile
        # 同时包含UserProfile自身字段和嵌套的user字段
        fields = ('state', 'city', 'add1', 'user')

这样当你发送GET请求时，返回的结构会是：

{
  "state": "California",
  "city": "Los Angeles",
  "add1": "123 Main St",
  "user": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com"
  }
}

方案2：使用SerializerMethodField（平级返回字段） #

如果你希望把User的字段和UserProfile的字段平级返回，而不是嵌套结构，可以用这个方法，还能自定义字段处理逻辑：

class UserProfileSerializer(serializers.ModelSerializer):
    # 声明需要从User获取的字段
    first_name = serializers.SerializerMethodField()
    last_name = serializers.SerializerMethodField()
    email = serializers.SerializerMethodField()

    # 每个字段对应一个get_xxx方法，从关联的user对象中取值
    def get_first_name(self, obj):
        return obj.user.first_name
    
    def get_last_name(self, obj):
        return obj.user.last_name
    
    def get_email(self, obj):
        return obj.user.email

    class Meta:
        model = UserProfile
        # 把所有需要返回的字段列出来
        fields = ('state', 'city', 'add1', 'first_name', 'last_name', 'email')

返回的结构会是平级的：

{
  "state": "California",
  "city": "Los Angeles",
  "add1": "123 Main St",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com"
}

方案3：重写to_representation方法（灵活定制返回结构） #

如果需要批量添加多个关联字段，或者要对返回数据做更复杂的修改，可以重写序列化器的to_representation方法：

class UserProfileSerializer(serializers.ModelSerializer):
    class Meta:
        model = UserProfile
        fields = ('state', 'city', 'add1')
    
    def to_representation(self, instance):
        # 先获取默认的UserProfile序列化数据
        representation = super().to_representation(instance)
        # 把User的字段追加到返回数据中
        representation['first_name'] = instance.user.first_name
        representation['last_name'] = instance.user.last_name
        representation['email'] = instance.user.email
        # 还可以在这里做其他定制，比如组合字段
        representation['full_name'] = f"{instance.user.first_name} {instance.user.last_name}"
        return representation

优化性能：避免N+1查询 #

不管用哪种方案，都建议在你的ViewSet里用select_related预加载关联的User模型，减少数据库查询次数：

from rest_framework import viewsets
from .models import UserProfile
from .serializers import UserProfileSerializer

class UserProfileViewSet(viewsets.ModelViewSet):
    # 用select_related预加载user，避免每个Profile单独查一次User
    queryset = UserProfile.objects.select_related('user').all()
    serializer_class = UserProfileSerializer

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