无username字段的自定义用户模型使用dj-rest-auth注册触发FieldDoesNotExist错误
问题根因
这个报错根本和你的自定义序列化器没关系——异常发生在Python模块导入阶段,根本走不到业务逻辑层:
- 项目启动加载URLconf时,一旦导入
rest_auth.registration.urls,就会直接执行dj-rest-auth内置RegisterSerializer的类定义代码 - 这个类在定义阶段就会调用allauth的
get_username_max_length()工具方法,默认到自定义用户模型里找username字段的长度参数 - 你搭建的自定义用户模型根本没有username字段,同时也没给allauth传递“这个模型没有username字段”的信号,所以刚加载完类定义就抛出
FieldDoesNotExist,后面的路由匹配、序列化器选择逻辑全被打断 - 你之前修改site-packages文件能正常运行,本质是删掉了类定义阶段那行查找username的代码,但这是完全绕开框架适配逻辑的临时hack,版本升级就会直接失效。
无需修改源码的标准解决方案
1. 补充缺失的allauth核心配置
你之前已经配置了ACCOUNT_USERNAME_REQUIRED = False,但这个配置仅控制注册流程是否强制传入username参数,并没有修改allauth对用户模型字段结构的默认假设——allauth会默认所有自定义用户模型都保留username字段,只是注册时可以不要求填写。只需要在settings.py里补一行配置,从根源上告知allauth“当前用户模型压根没有username这个字段”:
# 加到你已有的allauth配置块中即可 ACCOUNT_USER_MODEL_USERNAME_FIELD = None
2. 确认自定义用户模型的适配规范
要让allauth和dj-rest-auth正常运行,你的users.User模型必须满足几个基础要求,不然就算解决了当前的username报错,后续登录、用户创建环节也会触发其他异常:
- 类属性设置
USERNAME_FIELD = "email",告诉Django当前模型使用email作为唯一登录标识 - 类属性设置
EMAIL_FIELD = "email",告诉allauth当前模型存储邮箱的字段名称 - 带齐
is_active、is_staff、date_joined这些标准用户字段,以及set_password()、check_password()这些通用方法——一般继承AbstractBaseUser+PermissionsMixin就会自动满足这些要求。
3. 优化自定义注册序列化器的兼容性
你现在的序列化器直接继承了原生serializers.Serializer,相当于把allauth内置的密码一致性校验、密码强度校验等逻辑全部丢弃,后续很可能出现两次密码输入不一致也能注册成功的问题。建议直接继承dj-rest-auth提供的内置注册序列化器基类,手动覆盖移除不需要的username字段即可:
from rest_auth.registration.serializers import RegisterSerializer from rest_framework import serializers class CustomRegisterSerializer(RegisterSerializer): # 基类自带username字段,这里直接覆盖为None即可 username = None email = serializers.EmailField(required=True) password1 = serializers.CharField(write_only=True) password2 = serializers.CharField(write_only=True) def get_cleaned_data(self): # 仅提取注册需要的核心字段,避免传入不存在的模型参数 return { "password1": self.validated_data.get("password1", ""), "email": self.validated_data.get("email", ""), }
这种写法会自动复用allauth内置的校验逻辑,不需要手动重复实现通用校验规则。
效果验证
完成以上配置后重启Django服务:
- 服务启动加载rest-auth注册路由时,allauth会识别到
ACCOUNT_USER_MODEL_USERNAME_FIELD = None配置,不再尝试查找用户模型中的username字段,从根源上消除报错 - 注册请求会正常路由到你自定义的序列化器,完成用户创建流程
- 全程不需要修改任何第三方包的源码,后续dj-rest-auth、allauth版本升级时这套配置会自动适配,不会出现hack方案的兼容问题。
避坑提示
- 不要为了适配allauth在自定义用户模型中添加无实际用途的username字段,会造成长期的字段冗余
- 配置
ACCOUNT_USER_MODEL_USERNAME_FIELD = None后,allauth会完全以email作为用户唯一标识,不需要额外添加额外的username唯一约束 - 如果你之前为了绕过报错临时修改了site-packages里的第三方源码,记得改回原始状态,避免后续版本升级出现文件冲突
内容的提问来源于stack exchange,提问作者t-bone
相关产品推荐
相关产品推荐

