在 Django 中扩展用户模型的最佳方法是什么?
- 2024-12-02 08:41:00
- admin 原创
- 168
问题描述:
使用自定义字段扩展用户模型(与 Django 的身份验证应用程序捆绑在一起)的最佳方法是什么?我可能还想使用电子邮件作为用户名(用于身份验证目的)。
我已经看到了几种 方法,但无法决定哪一种是最好的。
解决方案 1:
最不痛苦且确实是 Django 推荐的方法是通过OneToOneField(User)
属性。
扩展现有的用户模型
…
如果您希望存储与 相关的信息
User
,则可以使用一对一关系来存储包含其他信息字段的模型。这种一对一模型通常称为配置文件模型,因为它可能存储与站点用户无关的身份验证信息。
也就是说,扩展django.contrib.auth.models.User
和取代它也是有效的......
替换自定义用户模型
某些类型的项目可能有身份验证要求,而 Django 的内置
User
模型并不总是适用。例如,在某些网站上,使用电子邮件地址作为身份标识比使用用户名更有意义。[编者:随后出现了两次警告和一次通知,指出这一举措十分严厉。]
我绝对不会更改 Django 源代码树中的实际用户类和/或复制和更改 auth 模块。
解决方案 2:
注意:此答案已被弃用。如果您使用的是 Django 1.7 或更高版本,请查看其他答案。
这是我的做法。
#in models.py
from django.contrib.auth.models import User
from django.db.models.signals import post_save
class UserProfile(models.Model):
user = models.OneToOneField(User)
#other fields here
def __str__(self):
return "%s's profile" % self.user
def create_user_profile(sender, instance, created, **kwargs):
if created:
profile, created = UserProfile.objects.get_or_create(user=instance)
post_save.connect(create_user_profile, sender=User)
#in settings.py
AUTH_PROFILE_MODULE = 'YOURAPP.UserProfile'
每次保存用户时,如果已创建,这将创建一个用户配置文件。然后您可以使用
user.get_profile().whatever
以下是来自文档的更多信息
http://docs.djangoproject.com/en/dev/topics/auth/#storing-additional-information-about-users
更新:请注意,AUTH_PROFILE_MODULE
自 v1.5 以来已弃用: https: //docs.djangoproject.com/en/1.5/ref/settings/#auth-profile-module
解决方案 3:
好吧,从 2008 年到现在已经过去了一段时间,是时候给出一些新的答案了。从 Django 1.5 开始,您将能够创建自定义 User 类。实际上,在我写这篇文章的时候,它已经合并到 master 中了,所以你可以尝试一下。
文档中有一些关于它的信息,或者如果你想深入了解它,可以参阅这个提交。
您所要做的就是将AUTH_USER_MODEL
路径添加到自定义用户类的设置中,该设置可以扩展AbstractBaseUser
(更多可定制的版本)或AbstractUser
(您可以扩展或多或少旧的用户类)。
对于懒得点击的人,这里有代码示例(取自文档):
from django.db import models
from django.contrib.auth.models import (
BaseUserManager, AbstractBaseUser
)
class MyUserManager(BaseUserManager):
def create_user(self, email, date_of_birth, password=None):
"""
Creates and saves a User with the given email, date of
birth and password.
"""
if not email:
raise ValueError('Users must have an email address')
user = self.model(
email=MyUserManager.normalize_email(email),
date_of_birth=date_of_birth,
)
user.set_password(password)
user.save(using=self._db)
return user
def create_superuser(self, username, date_of_birth, password):
"""
Creates and saves a superuser with the given email, date of
birth and password.
"""
u = self.create_user(username,
password=password,
date_of_birth=date_of_birth
)
u.is_admin = True
u.save(using=self._db)
return u
class MyUser(AbstractBaseUser):
email = models.EmailField(
verbose_name='email address',
max_length=255,
unique=True,
)
date_of_birth = models.DateField()
is_active = models.BooleanField(default=True)
is_admin = models.BooleanField(default=False)
objects = MyUserManager()
USERNAME_FIELD = 'email'
REQUIRED_FIELDS = ['date_of_birth']
def get_full_name(self):
# The user is identified by their email address
return self.email
def get_short_name(self):
# The user is identified by their email address
return self.email
def __unicode__(self):
return self.email
def has_perm(self, perm, obj=None):
"Does the user have a specific permission?"
# Simplest possible answer: Yes, always
return True
def has_module_perms(self, app_label):
"Does the user have permissions to view the app `app_label`?"
# Simplest possible answer: Yes, always
return True
@property
def is_staff(self):
"Is the user a member of staff?"
# Simplest possible answer: All admins are staff
return self.is_admin
解决方案 4:
自 Django 1.5 起,您可以轻松扩展用户模型并在数据库中保留单个表。
from django.contrib.auth.models import AbstractUser
from django.db import models
from django.utils.translation import ugettext_lazy as _
class UserProfile(AbstractUser):
age = models.PositiveIntegerField(_("age"))
您还必须在设置文件中将其配置为当前用户类
# supposing you put it in apps/profiles/models.py
AUTH_USER_MODEL = "profiles.UserProfile"
如果您想添加很多用户的偏好,OneToOneField 选项可能是一个更好的选择。
给开发第三方库的人的提示:如果你需要访问用户类,请记住人们可以更改它。使用官方助手获取正确的类
from django.contrib.auth import get_user_model
User = get_user_model()
解决方案 5:
对于存储用户的其他信息,有官方建议。Django Book 也在Profiles一节中讨论了这个问题。
解决方案 6:
下面是扩展用户的另一种方法。我觉得它比上面两种方法更清晰、更简单、更易读。
http://scottbarnham.com/blog/2008/08/21/extending-the-django-user-model-with-inheritance/
使用上述方法:
您不需要使用
user.get_profile().newattribute来访问与用户相关的附加信息你可以直接通过
user.newattribute访问其他新属性
解决方案 7:
每次使用 Django 保存后信号创建用户时,只需创建一个新条目即可轻松扩展用户配置文件
模型.py
from django.db.models.signals import *
from __future__ import unicode_literals
class UserProfile(models.Model):
user_name = models.OneToOneField(User, related_name='profile')
city = models.CharField(max_length=100, null=True)
def __unicode__(self): # __str__
return unicode(self.user_name)
def create_user_profile(sender, instance, created, **kwargs):
if created:
userProfile.objects.create(user_name=instance)
post_save.connect(create_user_profile, sender=User)
当创建新用户时,这将自动创建员工实例。
如果您希望扩展用户模型并希望在创建用户时添加更多信息,则可以使用 django-betterforms ( http://django-betterforms.readthedocs.io/en/latest/multiform.html )。这将创建一个用户添加表单,其中包含 UserProfile 模型中定义的所有字段。
模型.py
from django.db.models.signals import *
from __future__ import unicode_literals
class UserProfile(models.Model):
user_name = models.OneToOneField(User)
city = models.CharField(max_length=100)
def __unicode__(self): # __str__
return unicode(self.user_name)
表单.py
from django import forms
from django.forms import ModelForm
from betterforms.multiform import MultiModelForm
from django.contrib.auth.forms import UserCreationForm
from .models import *
class ProfileForm(ModelForm):
class Meta:
model = Employee
exclude = ('user_name',)
class addUserMultiForm(MultiModelForm):
form_classes = {
'user':UserCreationForm,
'profile':ProfileForm,
}
视图.py
from django.shortcuts import redirect
from .models import *
from .forms import *
from django.views.generic import CreateView
class AddUser(CreateView):
form_class = AddUserMultiForm
template_name = "add-user.html"
success_url = '/your-url-after-user-created'
def form_valid(self, form):
user = form['user'].save()
profile = form['profile'].save(commit=False)
profile.user_name = User.objects.get(username= user.username)
profile.save()
return redirect(self.success_url)
添加用户.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<form action="." method="post">
{% csrf_token %}
{{ form }}
<button type="submit">Add</button>
</form>
</body>
</html>
urls.py
from django.conf.urls import url, include
from appName.views import *
urlpatterns = [
url(r'^add-user/$', AddUser.as_view(), name='add-user'),
]
解决方案 8:
像专业人士一样扩展 Django 用户模型 (UserProfile)
我发现这个非常有用:链接
摘录:
from django.contrib.auth.models import User
class Employee(models.Model):
user = models.OneToOneField(User)
department = models.CharField(max_length=100)
>>> u = User.objects.get(username='fsmith')
>>> freds_department = u.employee.department
解决方案 9:
在 Django 3.0+ 版本中这非常简单(如果您不在项目中):
在models.py中
from django.db import models
from django.contrib.auth.models import AbstractUser
class CustomUser(AbstractUser):
extra_field=models.CharField(max_length=40)
在settings.py中
首先,注册你的新应用,然后在AUTH_PASSWORD_VALIDATORS下
添加
AUTH_USER_MODEL ='users.CustomUser'
最后,在管理员中注册你的模型,运行makemigrations并迁移,它将成功完成。
官方文档:https ://docs.djangoproject.com/en/3.2/topics/auth/customizing/#substituting-a-custom-user-model
解决方案 10:
已经太晚了,但是我的答案是针对那些使用最新版本的 Django 寻找解决方案的人。
models.py
:
from django.db import models
from django.contrib.auth.models import User
from django.db.models.signals import post_save
from django.dispatch import receiver
class Profile(models.Model):
user = models.OneToOneField(User, on_delete=models.CASCADE)
extra_Field_1 = models.CharField(max_length=25, blank=True)
extra_Field_2 = models.CharField(max_length=25, blank=True)
@receiver(post_save, sender=User)
def create_user_profile(sender, instance, created, **kwargs):
if created:
Profile.objects.create(user=instance)
@receiver(post_save, sender=User)
def save_user_profile(sender, instance, **kwargs):
instance.profile.save()
您可以在这样的模板中使用它:
<h2>{{ user.get_full_name }}</h2>
<ul>
<li>Username: {{ user.username }}</li>
<li>Location: {{ user.profile.extra_Field_1 }}</li>
<li>Birth Date: {{ user.profile.extra_Field_2 }}</li>
</ul>
就像views.py
这样:
def update_profile(request, user_id):
user = User.objects.get(pk=user_id)
user.profile.extra_Field_1 = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit...'
user.save()
解决方案 11:
在这里我尝试解释如何使用额外字段扩展 Django 的默认用户模型,这很简单,只需这样做即可。
Django 允许使用AbstractUser扩展默认用户模型
注意:-首先创建一个要在用户模型中添加的额外字段模型,然后运行命令python manage.py makemigrations和python manage.py move
首先运行 ---> python manage.py makemigrations然后
第二次运行python manage.py migration
步骤:-创建一个带有额外字段的模型,这些字段你想添加到Django默认用户模型中(在我的情况下,我创建了CustomUser
模型.py
from django.db import models
from django.contrib.auth.models import AbstractUser
# Create your models here.
class CustomUser(AbstractUser):
mobile_no = models.IntegerField(blank=True,null=True)
date_of_birth = models.DateField(blank=True,null=True)
在 settings.py 中添加你创建的模型的名称,在我的例子中,CustomUser是用户模型。在 setttings.py 中注册以使其成为默认用户模型,
#settings.py
AUTH_USER_MODEL = 'myapp.CustomUser'
最后在admin.py中注册了CustomUser模型
admin.py
@admin.register(CustomUser)
class CustomUserAdmin(admin.ModelAdmin):
list_display = ("username","first_name","last_name","email","date_of_birth", "mobile_no")
然后运行命令python manage.py makemigrations
然后python manage.py 迁移
然后python manage.py createsuperuser
现在你可以看到你的模型默认用户模型扩展了(mobile_no,date_of_birth)
解决方案 12:
Django 1.5 中的新功能,现在您可以创建自己的自定义用户模型(在上述情况下,这似乎是件好事)。请参阅“在 Django 中自定义身份验证”
这可能是 1.5 版本中最酷的新功能。
解决方案 13:
这就是我所做的,而且在我看来这是最简单的方法。为您的新定制模型定义一个对象管理器,然后定义您的模型。
from django.db import models
from django.contrib.auth.models import PermissionsMixin, AbstractBaseUser, BaseUserManager
class User_manager(BaseUserManager):
def create_user(self, username, email, gender, nickname, password):
email = self.normalize_email(email)
user = self.model(username=username, email=email, gender=gender, nickname=nickname)
user.set_password(password)
user.save(using=self.db)
return user
def create_superuser(self, username, email, gender, password, nickname=None):
user = self.create_user(username=username, email=email, gender=gender, nickname=nickname, password=password)
user.is_superuser = True
user.is_staff = True
user.save()
return user
class User(PermissionsMixin, AbstractBaseUser):
username = models.CharField(max_length=32, unique=True, )
email = models.EmailField(max_length=32)
gender_choices = [("M", "Male"), ("F", "Female"), ("O", "Others")]
gender = models.CharField(choices=gender_choices, default="M", max_length=1)
nickname = models.CharField(max_length=32, blank=True, null=True)
is_active = models.BooleanField(default=True)
is_staff = models.BooleanField(default=False)
REQUIRED_FIELDS = ["email", "gender"]
USERNAME_FIELD = "username"
objects = User_manager()
def __str__(self):
return self.username
不要忘记在您的中添加这行代码settings.py
:
AUTH_USER_MODEL = 'YourApp.User'
这就是我所做的并且它总是有效。
解决方案 14:
我建议用比扩展现有用户模型更具可定制性的自定义用户模型来替代。
替换自定义用户模型:
可以添加额外的字段。
可以删除默认字段。
可以将默认
username
和password
身份验证更改为email
和password
身份验证。必须是第一次迁移到数据库,否则会出现错误。
*您可以看到我的答案,其中解释了如何使用AbstractUser或AbstractBaseUser和PermissionsMixin设置email
和身份验证,并且您可以看到我的答案和我的答案,其中解释了和之间的区别。password
`AbstractUser`AbstractBaseUser
扩展现有的用户模型:
可以添加额外的字段。
无法删除默认字段。
无法将
username
和password
身份验证更改为email
和password
身份验证。不需要是第一次迁移到数据库。
*您可以看到我的答案,解释如何扩展用户模型以使用OneToOneField()添加额外字段。
解决方案 15:
简单有效的方法是models.py
from django.contrib.auth.models import User
class CustomUser(User):
profile_pic = models.ImageField(upload_to='...')
other_field = models.CharField()
解决方案 16:
尝试一下:
创建一个名为的模型Profile
,并用 引用用户OneToOneField
并提供 选项related_name
。
模型.py
from django.db import models
from django.contrib.auth.models import *
from django.dispatch import receiver
from django.db.models.signals import post_save
class Profile(models.Model):
user = models.OneToOneField(User, on_delete=models.CASCADE, related_name='user_profile')
def __str__(self):
return self.user.username
@receiver(post_save, sender=User)
def create_profile(sender, instance, created, **kwargs):
try:
if created:
Profile.objects.create(user=instance).save()
except Exception as err:
print('Error creating user profile!')
现在,要使用对象直接访问配置文件,User
您可以使用related_name
。
视图.py
from django.http import HttpResponse
def home(request):
profile = f'profile of {request.user.user_profile}'
return HttpResponse(profile)
解决方案 17:
目前从 Django 2.2 开始,启动新项目时推荐的方法是创建一个从 AbstractUser 继承的自定义用户模型,然后将 AUTH_USER_MODEL 指向该模型。