Django自定义CustomUser模型实现邮箱登录认证报错求助

问题梳理 #

• 自定义CustomUser继承AbstractUser，设置USERNAME_FIELD = 'email'实现邮箱登录
• 配置AUTH_USER_MODEL为api.CustomUser时，出现关联模型LogContracts.user引用默认auth.User的错误
• 配置为api.models.CustomUser时，Django提示无效模型引用，因为格式不符合app_label.ModelName要求

核心原因 #

1. 模型导入问题：拆分到api/models/CustomUser.py的模型未在api/models.py中导出，导致Django无法识别
2. 关联模型引用错误：项目中存在直接引用auth.User的外键字段，未更新为自定义用户模型
3. AUTH_USER_MODEL格式错误：必须遵循app_label.ModelName格式，不能包含子目录路径

分步解决 #

1. 修正模型模块的导入 #

在api/models.py中导入CustomUser，确保Django能从app的models模块找到该模型：

# api/models.py
from .models.CustomUser import CustomUser

2. 配置正确的AUTH_USER_MODEL #

在项目settings.py中设置：

AUTH_USER_MODEL = 'api.CustomUser'

注意：必须是app_label.ModelName格式，api是你的app名称，CustomUser是模型类名，不能加models子目录路径

3. 更新所有关联用户的模型字段 #

找到项目中所有引用默认auth.User的外键/一对一字段，比如报错中的LogContracts.user，修改为引用自定义用户模型：

方式一：通过settings引用（推荐）

# api/models/LogContracts.py
from django.conf import settings
from django.db import models

class LogContracts(models.Model):
    user = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
        related_name='log_contracts'
    )
    # 其他字段...

方式二：字符串引用

user = models.ForeignKey(
    'api.CustomUser',
    on_delete=models.CASCADE,
    related_name='log_contracts'
)

4. 重新生成迁移并同步数据库 #

如果是项目初期（无生产数据），建议清空数据库后执行以下命令：

# 删除旧的迁移文件（api/migrations下除__init__.py外的文件）
rm -rf api/migrations/0*.py

# 生成新迁移
python manage.py makemigrations

# 同步数据库
python manage.py migrate

5. 适配JWT认证（可选） #

如果使用Django REST Framework JWT，确保序列化器使用自定义用户模型：

# api/serializers.py
from django.contrib.auth import get_user_model
from rest_framework_simplejwt.serializers import TokenObtainPairSerializer

User = get_user_model()

class CustomTokenObtainPairSerializer(TokenObtainPairSerializer):
    @classmethod
    def get_token(cls, user):
        token = super().get_token(user)
        # 添加自定义字段（可选）
        token['email'] = user.email
        return token

    def validate(self, attrs):
        data = super().validate(attrs)
        # 返回额外用户信息（可选）
        data['user'] = {'email': self.user.email, 'username': self.user.username}
        return data

然后在settings.py中配置JWT使用自定义序列化器：

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework_simplejwt.authentication.JWTAuthentication',
    ),
}

SIMPLE_JWT = {
    'TOKEN_OBTAIN_SERIALIZER': 'api.serializers.CustomTokenObtainPairSerializer',
}

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