如何在Django allauth中自定义REST用户注册字段？

我之前也遇到过一模一样的问题——自定义了User模型，配置了表单却完全没生效，接口还是只显示默认字段。核心原因是：rest接口（/rest-auth/registration/）用的是序列化器（Serializer）而非普通的Django表单，只配置allauth的SignupForm根本没用，得针对性地处理dj-rest-auth的注册序列化器。

下面是一步步的解决流程：

1. 先确认基础配置是否正确 #

首先确保你的自定义User模型和UserManager已经正确配置，并且在settings.py里指定了：

# settings.py
AUTH_USER_MODEL = "your_app.CustomUser"  # 替换成你的app名和模型名

# 同时确保INSTALLED_APPS包含这些
INSTALLED_APPS = [
    # ...
    "django.contrib.sites",
    "allauth",
    "allauth.account",
    "dj_rest_auth",
    "dj_rest_auth.registration",
    # ...
]
SITE_ID = 1

2. 自定义注册序列化器（关键！） #

创建serializers.py，继承dj-rest-auth的RegisterSerializer，添加你的自定义字段（比如phone_number），或者删除不需要的默认字段：

# your_app/serializers.py
from dj_rest_auth.registration.serializers import RegisterSerializer
from rest_framework import serializers
from .models import CustomUser

class CustomRegisterSerializer(RegisterSerializer):
    # 示例1：添加自定义字段phone_number
    phone_number = serializers.CharField(max_length=15, required=True)
    
    # 示例2：如果要删除username字段（比如用邮箱作为登录标识）
    username = None

    # 重写get_cleaned_data，把自定义字段加入清洗后的数据
    def get_cleaned_data(self):
        cleaned_data = super().get_cleaned_data()
        # 把自定义字段的验证后数据加进去
        cleaned_data["phone_number"] = self.validated_data.get("phone_number", "")
        return cleaned_data

    # 重写save方法，把自定义字段赋值给用户实例并保存
    def save(self, request):
        user = super().save(request)
        user.phone_number = self.cleaned_data["phone_number"]
        user.save()
        return user

3. 在settings里指定自定义序列化器 #

告诉dj-rest-auth用我们的序列化器来处理注册请求：

# settings.py
REST_AUTH_REGISTER_SERIALIZERS = {
    "REGISTER_SERIALIZER": "your_app.serializers.CustomRegisterSerializer",
}

4. （可选）配置allauth的表单（针对网页注册） #

如果你同时需要网页端的注册表单也生效，可以自定义SignupForm并配置：

# your_app/forms.py
from allauth.account.forms import SignupForm
from django import forms

class CustomSignupForm(SignupForm):
    phone_number = forms.CharField(max_length=15, required=True)

    def save(self, request):
        user = super().save(request)
        user.phone_number = self.cleaned_data["phone_number"]
        user.save()
        return user

然后在settings里添加：

# settings.py
ACCOUNT_FORMS = {
    "signup": "your_app.forms.CustomSignupForm",
}

5. 调整allauth的全局配置（比如禁用username） #

如果要删除默认的username字段，还需要在settings里配置allauth的规则：

# settings.py
ACCOUNT_USER_MODEL_USERNAME_FIELD = None  # 告诉allauth你的用户模型没有username字段
ACCOUNT_EMAIL_REQUIRED = True
ACCOUNT_USERNAME_REQUIRED = False
ACCOUNT_AUTHENTICATION_METHOD = "email"  # 用邮箱作为登录凭证

6. 测试验证 #

重启Django服务，发送POST请求到/rest-auth/registration/，请求体示例：

{
    "email": "test@example.com",
    "password1": "TestPass123!",
    "password2": "TestPass123!",
    "phone_number": "13800138000"
}

此时接口应该能正确接收phone_number字段，并且新创建的用户会包含这个字段的值。

常见坑点排查 #

• 忘记在settings.py里指定REST_AUTH_REGISTER_SERIALIZERS：这是最容易犯的错误，导致自定义序列化器不生效。
• 自定义User模型的USERNAME_FIELD和REQUIRED_FIELDS配置错误：确保和你的模型字段匹配。
• 序列化器里的字段名和模型字段名不一致：比如模型里是phone，序列化器里写成phone_number，会导致赋值失败。

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