Django内置User模型添加角色后，接口未返回角色字段问题排查

问题描述 #

我使用django.contrib.auth.models中的User对象存储用户名和密码，同时创建了与User一对一关联的Role模型，需要在注册的POST请求中传入角色信息并关联到用户。但发送包含"role": "Customer"的POST请求后，接口仅返回username字段，没有角色信息，请问问题出在哪里？

相关代码 #

serializers.py

from rest_framework import serializers
from django.contrib.auth.models import User
from django.contrib.auth.password_validation import validate_password

class RegisterSerializer(serializers.ModelSerializer):

username = serializers.CharField(required=True)
password = serializers.CharField(write_only=True, required=True, validators=[validate_password])
password2 = serializers.CharField(write_only=True, required=True)
role_name= serializers.CharField(required=True)


class Meta:
    model = User
    fields = ('username', 'password', 'password2', 'role_name')
    
def validate(self, attrs):
    if attrs['password'] != attrs['password2']:
        raise serializers.ValidationError({"password": "Password fields didn't match."})
        
    return attrs
    
def validate_username(self, value):
    if User.objects.filter(username__iexact=value).exists():
        raise serializers.ValidationError("A user with this username already exists.")
    return value

def create(self, validated_data):
    user = User.objects.create(
        username=validated_data['username']
    )
    role = Role(user=user, role_name='role_name') 
    role.save()

    user.set_password(validated_data['password'])
    user.save()

    return user

models.py

from django.db import models
from django.contrib.auth.models import User


class Role(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    role_name = models.CharField(max_length=50)

    def __str__(self):
        return self.role_name

POST请求体示例

{"username":"name22","password":"$pwd1234","password2":"$pwd1234", "role": "Customer" }

接口返回结果

{
    "username": "name27"
}

问题原因分析 #

1. 请求字段与序列化器字段不匹配：请求体传入的是role字段，但序列化器定义的是role_name，两者名称不一致，导致前端传入的角色值根本没被序列化器接收。
2. Role创建逻辑硬编码错误：在create方法中，创建Role时写死了role_name='role_name'，而非使用校验后的用户输入值validated_data['role_name']，导致角色名被固定为字符串"role_name"，而非用户传入的实际值。
3. 序列化器未配置返回角色字段：当前序列化器的Meta类绑定的是User模型，默认只会序列化返回User本身的字段，不会自动包含关联的Role信息，因此即使Role创建成功，返回结果也不会展示角色数据。

修复方案 #

修正后的serializers.py #

from rest_framework import serializers
from django.contrib.auth.models import User
from django.contrib.auth.password_validation import validate_password
from .models import Role  # 导入Role模型

class RegisterSerializer(serializers.ModelSerializer):
    password = serializers.CharField(write_only=True, required=True, validators=[validate_password])
    password2 = serializers.CharField(write_only=True, required=True)
    role = serializers.CharField(required=True)  # 与请求体字段统一

    class Meta:
        model = User
        fields = ('username', 'password', 'password2', 'role')

    def validate(self, attrs):
        if attrs['password'] != attrs['password2']:
            raise serializers.ValidationError({"password": "密码字段不匹配。"})
        return attrs
    
    def validate_username(self, value):
        if User.objects.filter(username__iexact=value).exists():
            raise serializers.ValidationError("该用户名已存在。")
        return value

    def create(self, validated_data):
        # 取出角色值并从validated_data中移除（User模型无此字段）
        role_name = validated_data.pop('role')
        user = User.objects.create(username=validated_data['username'])
        # 使用用户传入的值创建Role
        Role.objects.create(user=user, role_name=role_name)
        user.set_password(validated_data['password'])
        user.save()
        return user
    
    # 重写返回逻辑，添加角色信息
    def to_representation(self, instance):
        representation = super().to_representation(instance)
        # 获取关联的Role对象
        role = Role.objects.get(user=instance)
        representation['role'] = role.role_name
        return representation

修复说明 #

1. 统一字段名称：将序列化器字段改为role，与请求体的字段保持一致，确保角色数据能被正确接收。
2. 修正Role创建逻辑：从validated_data中取出用户传入的角色值，用于创建Role对象，避免硬编码错误。
3. 自定义返回内容：重写to_representation方法，在返回用户数据时主动添加关联的角色信息，让接口返回包含角色字段。

修复后返回示例 #

{
    "username": "name22",
    "role": "Customer"
}

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