Django5+Vue3 系列文章

前言

此项目采用 Django 框架的 5.0.7 版本进行开发。
Django 5.0 支持的 Python 版本为 3.10、3.11 和 3.12。
CSDN 专栏链接: ~快捷传送门: 留个赞再走呗 😭! ~

国内外 User 模型的差异

尽管 Django 的 User 模型设计成熟，但由于国内外使用环境差异，存在一些不适用和缺失的功能，例如缺少对手机号的支持，以及国外姓名分为 first_name 和 last_name。为了解决这个问题，我们不直接替换原有的 User 模型，而是选择扩展它。这样，我们可以自定义 User 模型以适应国内环境，同时保留 Django 强大的内建认证系统功能。通过重写 User 对象，我们实现了模型的本地化定制，确保了功能的完整性和扩展性。

重写 User 模型

终端创建 django 应用

python manage.py startapp oaauth

如果出现如下创建失败，请自行选择 MySQL 数据库驱动程序:

django.core.exceptions.ImproperlyConfigured: Error loading MySQLdb module.
Did you install mysqlclient?

从性能上推荐 mysqlclient，从操作简易性推荐使用 pymysql，此处使用 pymysql 示例（终端下载 pymysql）:

pip install pymysql

# 请自行手动添加到项目根目录的__init__.py文件中
import pymysql
pymysql.install_as_MySQLdb()

此时再次运行 python manage.py startapp oaauth，则名为 oaauth 的应用创建成功

创建 apps 管理包

因为项目会创建众多 app 应用，为了方便管理在此创建一个名为 apps 的软件包进行统一管理

Tips: 创建完成后需将 oaauth 应用文件夹放进 oaauth 文件夹中，如下:

settings 安装 oaauth 应用

# Application definition

INSTALLED_APPS = [
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",

    # 安装rest_framework
    'rest_framework',
    # 安装django-cors-headers
    'corsheaders',
    'apps.oaauth'
]

重写 User 模型

打开 apps --> oaauth -->models.py 文件

导入 User 模型

from django.contrib.auth.models import User

复制 User 模型

由于 User 模型基于 AbstractUser 扩展，而 AbstractUser 又继承自 AbstractBaseUser 和 PermissionsMixin，我们选择在 AbstractUser 类上进行重写，复制其代码以实现自定义。

重写 User 模型

​​from django.db import models
from django.contrib.auth.models import User, AbstractBaseUser, PermissionsMixin, BaseUserManager
from django.contrib.auth.hashers import make_password


class UserStatusChoices(models.IntegerChoices):
    # 已经激活
    ACTIVED = 1
    # 没有激活
    UNACTIVE = 2
    # 被锁定
    LOCKED = 3


class OAUserManager(BaseUserManager):
    use_in_migrations = True

    # 密码源自于AbstractBaseUser类
    def _create_user(self, realname, email, password, **extra_fields):
        """
        创建用户
        """
        if not realname:
            raise ValueError("必须设置真实姓名! ")
        email = self.normalize_email(email)  # 邮箱标准化
        user = self.model(realname=realname, email=email, **extra_fields)  # 此处的self.model实际上等于OAUser
        user.password = make_password(password)
        user.save(using=self._db)
        return user

    def create_user(self, realname, email=None, password=None, **extra_fields):
        """
        创建普通用户
        """
        extra_fields.setdefault("is_staff", True)
        extra_fields.setdefault("is_superuser", False)
        return self._create_user(realname, email, password, **extra_fields)

    def create_superuser(self, realname, email=None, password=None, **extra_fields):
        """
        创建超级用户
        """
        extra_fields.setdefault("is_staff", True)
        extra_fields.setdefault("is_superuser", True)
        extra_fields.setdefault("status", UserStatusChoices.ACTIVED)

        if extra_fields.get("is_staff") is not True:
            raise ValueError("超级用户必须设置is_staff=True.")
        if extra_fields.get("is_superuser") is not True:
            raise ValueError("超级用户必须设置is_superuser=True.")

        return self._create_user(realname, email, password, **extra_fields)


class OAUser(AbstractBaseUser, PermissionsMixin):
    """
    自定义的User模型
    """
    realname = models.CharField(max_length=150, unique=False)  # 公司体量庞大,可能会出现同名者
    email = models.EmailField(unique=True, blank=False)  # 邮箱唯一且不为空
    telephone = models.CharField(max_length=20, blank=True)
    is_staff = models.BooleanField(default=True)
    # 只要关注status即可,无须关注is_active
    status = models.IntegerField(choices=UserStatusChoices, default=UserStatusChoices.UNACTIVE)
    is_active = models.BooleanField(default=True)
    date_joined = models.DateTimeField(auto_now_add=True)

    objects = OAUserManager()

    EMAIL_FIELD = "email"
    # USERNAME_FIELD: 是用来做鉴权的,会把authenticate的username参数传给USERNAME_FIELD指定的字段
    # form django.contrib.auth import authenticate
    USERNAME_FIELD = "email"
    # REQUIRED_FIELDS: 指定哪些字段时必须要传的,但是不能重复包含USERNAME_FIELD和EMAIL_FIELD已经设置过的值
    REQUIRED_FIELDS = ["realname", "password"]

    def clean(self):
        super().clean()
        self.email = self.__class__.objects.normalize_email(self.email)

    def get_full_name(self):
        return self.realname

    def get_short_name(self):
        return self.realname

setttings 覆盖原有 User 模型

# 覆盖django自带的User模型
# 格式: 'app.<User模型名>'
AUTH_USER_MODEL = "oaauth.OAUser"

# 错误示例:
# AUTH_USER_MODEL = 'apps.oaauth.models.OAUser'

模型映射

终端依次运行:

python manage.py makemigrations
python manage.py migrate

若数据库同步成功则显示如下:

测试: 创建超级用户

(venv) PS D:\yourterminal> python manage.py createsuperuser
Email: dianzanjiaguanzhu@qq.com
Realname: dianzanjiaguanzhu
密码: 123456
Superuser created successfully.

总结

本节详细介绍了对 Django 框架中 User 对象的重写过程及其应用。