django - 在 Django 中使用自定义字段扩展用户模型

Question

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

我已经看到了一些 方法来做到这一点，但无法决定哪一个是最好的。

Answer 1

最不痛苦且确实是 Django 推荐的方法是通过OneToOneField(User)属性。

扩展现有的用户模型

…</p>

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

也就是说，扩展django.contrib.auth.models.User和替换它也有效......

替换自定义用户模型

某些类型的项目可能有身份验证要求，而 Django 的内置User模型并不总是合适的。例如，在某些网站上，使用电子邮件地址而不是用户名作为您的标识令牌更有意义。

[Ed：随后是两个警告和一个通知，提到这非常激烈。]

我肯定不会更改 Django 源代码树中的实际 User 类和/或复制和更改 auth 模块。

Answer 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

Answer 3

好吧，自 2008 年以来已经过去了一段时间，是时候给出一些新的答案了。从 Django 1.5 开始，您将能够创建自定义用户类。其实在我写这个的时候，已经合并到master里面了，大家可以试试。

在docs中有一些关于它的信息，或者如果你想更深入地研究它，在这个 commit中。

您所要做的就是添加AUTH_USER_MODEL带有自定义用户类路径的设置，该自定义用户类可以扩展AbstractBaseUser（更可定制的版本）或AbstractUser（您可以扩展或多或少的旧用户类）。

对于懒得点击的人，这里的代码示例（取自docs）：

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

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

Answer 5

官方建议存储有关用户的其他信息。Django Book 在Profiles部分也讨论了这个问题。

Answer 6

下面是另一种扩展用户的方法。我觉得它比上述两种方法更清晰、更容易、更易读。

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

使用上述方法：

1. 您不需要使用 user.get_profile().newattribute来访问与用户相关的附加信息
2. 您可以通过 user.newattribute直接访问其他新属性

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

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>

网址.py

from django.conf.urls import url, include
from appName.views import *
urlpatterns = [
    url(r'^add-user/$', AddUser.as_view(), name='add-user'),
]

Answer 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

Answer 9

在 Django 3.0+ 版本中非常容易。

在模型.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'

最后，在 admin 中注册你的模型，运行 makemigrations 和 migrate，就可以成功完成了。

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

Answer 10

Django 1.5 中的新功能，现在您可以创建自己的自定义用户模型（在上述情况下这似乎是件好事）。请参阅“在 Django 中自定义身份验证”

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

Answer 11

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

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'

这就是我所做的，它总是有效的。

Answer 12

为时已晚，但我的答案是针对那些使用最新版本的 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()

Answer 13

简单有效的方法是models.py

from django.contrib.auth.models import User
class CustomUser(User):
     profile_pic = models.ImageField(upload_to='...')
     other_field = models.CharField()

Answer 14

目前从 Django 2.2 开始，建议在启动新项目时创建一个继承自 AbstractUser 的自定义用户模型，然后将 AUTH_USER_MODEL 指向该模型。

来源：https ://docs.djangoproject.com/en/2.2/topics/auth/customizing/#using-a-custom-user-model-when-starting-a-project

Answer 15

试试这个：

创建一个名为的模型Profile并使用 a 引用用户，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)