Django AllAuth 章使用自定义字段扩展 Django AllAuth 用户模型

王林

发布时间：2024-08-14 12:15:34

635人浏览过

来源于dev.to

转载

注意：本文最初发布在我的 substack 上，网址为 https://andresalvareziglesias.substack.com/

这是 django allauth 系列文章的最后一章。在这五章中，我们发现了一个小奇迹，一个非常有用的 django 组件来处理我们所有的身份验证需求。在本章中，我们将学习如何扩展基本的 django 用户模型以添加自定义字段。

章节列表

第 1 章 - django 中 auth 的一体化解决方案
第 2 章 - 如何安装和配置 django allauth
第 3 章 - 使用 django allauth 进行社交登录
第 4 章 - 自定义 django allauth ui
第 5 章 - 使用自定义字段扩展 django allauth 用户模型 ←这个！

Django AllAuth 章使用自定义字段扩展 Django AllAuth 用户模型

django 用户模型

allauth 使用标准 django 用户模型，加上一些额外的表来处理社交登录和登录令牌。在 django 5 中，用户模型位于 django.contrib.auth 包中，并且有一堆预定义字段，您可以在官方文档中阅读：

https://docs.djangoproject.com/en/5.0/ref/contrib/auth/

有时，这对于我们的项目来说还不够。 django 允许您创建自定义用户表和用户管理器，来处理每个项目的需求。

我们将创建一个自定义用户表和一个自定义 usermanager 来处理我们的登录和注册过程。

创建自定义用户表

在我们的示例项目中打开 models.py 并编写如下代码：

class mycustomuser(abstractbaseuser):
   email = models.emailfield(unique=true)
   first_name = models.charfield(max_length=30, blank=true)
   last_name = models.charfield(max_length=30, blank=true)
   is_active = models.booleanfield(default=true)
   is_admin = models.booleanfield(default=false)
   timezone = models.charfield(max_length=30, default='utc')
   is_custom = models.booleanfield(default=false)
   is_staff = models.booleanfield(default=false)
   created_at = models.datetimefield(auto_now_add=true)
   updated_at = models.datetimefield(auto_now=true)

   objects = mycustomusermanager()
   username_field = 'email'
   email_field = 'email'

   def __str__(self):
       return self.email
   def has_perm(self, perm, obj=none):
       return true
   def has_module_perms(self, app_label):
       return true

   @property
   def is_utc(self):
       return self.timezone == 'utc'

我们可以定义一个从 django 的 abstractbaseuser 模型扩展而来的新 user 模型。在这个新模型中，我们可以添加我们需要的所有字段或自定义属性。

这些行很重要：

   objects = mycustomusermanager()
   username_field = 'email'
   email_field = 'email'

通过这些行，我们将用户模型与自定义 usermanager 链接起来，并且我们还定义了充当唯一“用户名”的字段。

记得在 admin.py 中注册新模型，以便通过 django 管理工具进行管理。

from django.contrib import admin
from .models import mycustomuser

admin.site.register(mycustomuser)

创建自定义用户管理器

再次打开我们的示例项目中的 models.py （或者如果需要的话，为自定义 usermanager 生成另一个文件）并编写如下代码：

class mycustomusermanager(baseusermanager):

   def create_user(self, email, password=none):
       if not email:
           raise valueerror('users must have an email address')

       user = self.model(
           email=self.normalize_email(email),
       )

       user.set_password(password)

       user.save(using=self._db)
       return user

   def create_superuser(self, email, password):
       user = self.create_user(
           email=email,
           password=password,
       )

       user.is_admin = true
       user.is_staff = true

       user.save(using=self._db)
       return user

在此示例中，我们扩展 baseusermanager 来创建自定义 usermanager。它创建了我们的新用户，并按照我们的预期填充自定义字段。

蓝色商务公司网站(XDcms内核)1.0

本系统使用的是XDcms内核，在原来基础上做来相应修改前台修改调用数据，可以使用{loop catid=栏目ID}{/loop}方式调用主要功能： A、内容管理模型，自定义字段，更方便扩展功能。自带模型：单页模型、新闻模型、产品模型、招聘模型 B、栏目自定义，便于内容管理 C、内容模块化，二次开发更便捷。自带模块：幻灯片、QQ客服、友情链接、自定义表单(在线留言、简历管理) D、模板管理，后台

下载

我们在自定义用户模型的 usermanager 之前定义，因此 django 知道在新用户创建期间要使用什么类。

使用自定义用户管理器和模型

在我们项目的设置文件中，我们可以使用以下命令设置项目的当前用户模型：

# Set custom user model as the active one
AUTH_USER_MODEL = 'demo.MyCustomUser'

# Configure AllAuth username related management, because we are 
# using the e-mail as username. See:
# https://docs.allauth.org/en/latest/account/advanced.html
ACCOUNT_AUTHENTICATION_METHOD = 'email'
ACCOUNT_EMAIL_REQUIRED = True
ACCOUNT_UNIQUE_EMAIL = True
ACCOUNT_USERNAME_REQUIRED = False
ACCOUNT_USER_MODEL_USERNAME_FIELD = None

只需这个小更改（以及像往常一样所需的数据库迁移），我们就可以开始使用 allauth 注册视图创建用户，以查看我们闪亮的自定义 usermanager 及其正在运行的模型。快速又简单。

我们还禁用 allauth 用户名相关管理，因为我们在本例中使用电子邮件作为用户名。