如何在Django中使Profile模型返回关联User的username字段?
在Profile序列化结果中包含关联User的username
需求背景
项目使用Django自带User模型(含username字段),自定义了Profile模型与User关联。希望返回Profile对象时直接带上关联User的username,无需前端额外发起请求获取——尤其在需要同时获取聊天消息发送方、接收方username时,额外请求的效率极低。
现有模型与序列化器代码:
模型代码
User= get_user_model() class Profile(models.Model): user = models.ForeignKey(User, on_delete=models.CASCADE) id_user = models.IntegerField() department= models.CharField(max_length=50,blank=True) degree= models.CharField(max_length=20,blank=True) year= models.CharField(max_length=20,blank=True) bio = models.TextField(blank=True) profileimg= models.TextField(default=DEFAULT_IMAGE_DATA) def __str__(self): return self.user.username
序列化器代码
class ProfileSerializer(serializers.ModelSerializer): class Meta: model = Profile fields=['id','user', 'id_user', 'department', 'degree', 'year', 'bio','profileimg'] class ChatMsgSerializer(serializers.ModelSerializer): reciever_profile= ProfileSerializer(read_only=True) sender_profile= ProfileSerializer(read_only=True) class Meta: model = ChatMsg fields=['id','user', 'sender','sender_profile', 'reciever','reciever_profile', 'msg', 'is_read', 'date']
解决方案
只需修改ProfileSerializer,添加username字段即可,以下两种实现方式都很简洁:
方式一:使用SerializerMethodField
通过自定义方法获取关联User的username:
class ProfileSerializer(serializers.ModelSerializer): username = serializers.SerializerMethodField() def get_username(self, obj): # 从关联的user对象中取出username return obj.user.username class Meta: model = Profile # 将新增的username字段加入返回字段列表 fields=['id','user', 'username', 'id_user', 'department', 'degree', 'year', 'bio','profileimg']
方式二:使用SlugRelatedField(更简洁)
直接关联到User模型的username字段,无需编写额外方法:
class ProfileSerializer(serializers.ModelSerializer): username = serializers.SlugRelatedField(source='user', slug_field='username', read_only=True) class Meta: model = Profile fields=['id','user', 'username', 'id_user', 'department', 'degree', 'year', 'bio','profileimg']
修改后,ChatMsgSerializer返回的sender_profile和reciever_profile中会自动包含username字段,前端直接从Profile对象中读取即可,无需额外请求。
额外建议:Profile模型中的
id_user字段属于冗余字段,直接通过obj.user.id即可获取用户ID,可考虑删除该字段以简化模型。
内容的提问来源于stack exchange,提问作者Abhay Chandra
相关产品推荐
相关产品推荐

