在Django中使用自定义字段扩展User模型

用自定义字段扩展User模型(与Django的身份验证应用程序绑定)的最佳方法是什么?我还可能想使用电子邮件作为用户名(用于身份验证)。

我已经见过 方法来做了,但不能决定哪一个是最好的。

302089 次浏览
有一个关于存储关于用户的附加信息的官方推荐。 Django Book在配置文件节中也讨论了这个问题

最不痛苦也是django推荐的方法是通过OneToOneField(User)属性。

扩展现有的用户模型 . 0扩展现有的用户模型

...

如果您希望存储与User相关的信息,您可以将一对一的关系用于包含附加信息字段的模型。这种一对一的模型通常称为概要文件模型,因为它可能存储有关站点用户的非身份验证相关信息。

也就是说,扩展django.contrib.auth.models.User并替换它也可以……

替换自定义用户模型

有些类型的项目可能有身份验证要求,Django内置的User模型并不总是合适的。例如,在一些网站上,使用电子邮件地址代替用户名更有意义。

[Ed: 两个警告和一个通知紧随,提到这是相当激烈。]

我绝对不会去修改Django源代码树中的User类,也不会复制和修改认证模块。

下面是另一种扩展User的方法。 我觉得它比上面两种方法更清楚,简单,易读

http://scottbarnham.com/blog/2008/08/21/extending-the-django-user-model-with-inheritance/

使用上述方法:

  1. 你不用用 .newattribute user.get_profile ()来访问附加信息 与用户相关
  2. 你可以直接访问 通过 user.newattribute < / em >

注意:这个答案是不赞成的。如果你使用的是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自1.5版起已弃用

自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

这是Django 1.5中的新功能,现在你可以创建自己的自定义用户模型(在上述情况下,这似乎是一件好事)。参考在Django中自定义身份验证

这可能是1.5版本中最酷的新功能。

从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()

像Pro一样扩展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

你可以通过每次使用Django post save信号创建用户时创建一个新条目来扩展用户配置文件

models.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模型中定义的所有字段的用户添加表单。

models.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)

forms.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,
}

views.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)

addUser.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'),
]

这就是我所做的,在我看来这是最简单的方法。为您的新定制模型定义对象管理器,然后定义您的模型。

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'

我就是这么做的,而且总是管用。

目前在Django 2.2中,当开始一个新项目时,推荐的方法是创建一个自定义的用户模型,它继承自AbstractUser,然后将AUTH_USER_MODEL指向该模型。

来源:# EYZ0

简单有效的方法是 models.py < / p >
from django.contrib.auth.models import User
class CustomUser(User):
profile_pic = models.ImageField(upload_to='...')
other_field = models.CharField()

现在已经太迟了,但我的答案是给那些用最新版本的Django寻找解决方案的人的。

# EYZ0:

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()

试试这个:

创建一个名为Profile的模型,并使用OneToOneField引用用户,并提供一个选项related_name

models.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

views.py

from django.http import HttpResponse


def home(request):
profile = f'profile of {request.user.user_profile}'
return HttpResponse(profile)

在Django 3.0+ (如果你不在一个项目的中间)版本中非常简单:

在# EYZ0

from django.db import models
from django.contrib.auth.models import AbstractUser


class CustomUser(AbstractUser):
extra_field=models.CharField(max_length=40)

在# EYZ0

首先,注册你的新应用,然后在AUTH_PASSWORD_VALIDATORS 添加< / p >

AUTH_USER_MODEL ='users.CustomUser'

最后,在管理中注册你的模型,运行makemigrations和migrate,它将成功完成。

官方文件:https://docs.djangoproject.com/en/3.2/topics/auth/customizing/#substituting-a-custom-user-model

在这里,我试图解释如何用额外的字段扩展Django的默认用户模型

Django允许使用AbstractUser扩展默认的用户模型

注意:-首先创建一个额外的字段模型,你想添加到用户模型,然后运行命令Python manage.py makemigrationsPython manage.py迁移

第一轮——># EYZ0然后

第二次运行Python manage.py迁移

步骤:-创建一个带有额外字段的模型,你想添加到Django默认用户模型中(在我的例子中,我创建了CustomUser

model.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是用户模型。在settings .py中注册,使其成为默认用户模型,

#settings.py


AUTH_USER_MODEL = 'myapp.CustomUser'

最后注册CustomUser模型在admin.py # admin.py < / p >

@admin.register(CustomUser)
class CustomUserAdmin(admin.ModelAdmin):
list_display = ("username","first_name","last_name","email","date_of_birth", "mobile_no")

然后执行Python manage.py makemigrations命令

然后# EYZ0

然后# EYZ0

现在你可以看到你的模型Default User模型扩展了(mobile_no date_of_birth)

enter image description here