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


442

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

我已经看到了几种 方法,但是还不能确定哪种方法最好。


24
大多数答案已过时/过时。请参阅stackoverflow.com/a/22856042/781695&stackoverflow.com/q/14104677/781695&stackoverflow.com/q/16880461/781695 – 2014
用户

@buffer-您链接到的第一个问题(stackoverflow.com/a/22856042/781695)已删除。其他仍然有效。
托尼

3
要使用电子邮件代替用户名进行身份验证,本文很有用。


我很着迷,看到在Django发布之前的2008年问了这个问题@Farinha
Tessaracter

Answers:


253

做到这一点最痛苦且确实是Django推荐的方法是通过OneToOneField(User)属性。

扩展现有的用户模型

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

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

替代自定义用户模型

某些项目可能具有身份验证要求,而Django的内置User模型并不总是适用于此。例如,在某些站点上,使用电子邮件地址代替您的用户名作为您的识别令牌更有意义。

[Ed:随后出现两个警告和一个通知,并指出这太过激烈了。]

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


50
FYI新的(1.0+)推荐的方法是OneToOneField(用户)docs.djangoproject.com/en/dev/topics/auth/...
戴夫Forgac

2
PBS的肖恩骑士给了一些很好的原因,你应该不会延长django.contrib.auth.models.User。请改用OneToOneField(User)。
pydanny 2011年

2
user = models.ForeignKey(User, unique=True)这和user = models.OneToOneField(User)吗?我认为最终效果是一样的吗?但是也许后端的实现是不同的。
山姆·斯托林加

7
任何人都可以链接到Shawn Riders的论据/理由吗?
杰里米·布兰查德

1
以下是有关从django 1.7文档开始的扩展用户模型的一些附加信息
Derek Adair 2014年

226

注意:不建议使用此答案。如果您使用的是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


6
感谢清晰的示例,请注意def create_user ....不是UserProfile类的一部分,应左对齐。
PhoebeB

5
使用此解决方案,其他模型的外键应该指向User还是UserProfile?
安德鲁克(Andrewrk)2010年

9
其他模型应使用user = models.ForeignKey( User ),并通过检索配置文件对象user.get_profile()。记住要from django.contrib.admin.models import User
Craig Trader 2010年

1
通过使用此方法,我需要在检索常用信息(名称,密码)和自定义信息时分开,还是可以立即进行处理?创建新用户也一样吗?
马丁·特里高

5
该答案和评论已过时,例如AUTH_PROFILE_MODULE已过时,User
用户

196

好吧,自2008年以来已经过去了一些时间,现在该是一个新答案了。从Django 1.5开始,您将能够创建自定义User类。实际上,在撰写本文时,它已经合并到master中,因此您可以尝试一下。

文档中有一些有关此信息的信息,或者如果您想深入了解此信息,请在此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

create_user函数似乎没有存储用户名,怎么办?
Orca 2013年

6
因为在此示例中,email是用户名。
OndrejSlinták2013年

5
您需要添加unique=True到电子邮件字段中才能USERNAME_FIELD接受它
Richard de Wit 2014年

您好,我试图按照您所说的创建自定义用户,但是无法使用自定义用户电子邮件的电子邮件登录。你不介意说为什么吗?
Lionel 2014年

没有细节,我真的无法帮助您。如果您提出新的问题会更好。
2014年

47

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

3
如果您打算使用django_social_auth,我建议使用OneToOne关系。请勿使用此方法,否则它将破坏您的迁移。
Nimo 2014年

@Nimo:您能否详细说明或引用参考
用户

@buffer,已经有很长一段时间了,但是我想我尝试了组合django_social_auth插件并为社交身份验证用户定义AUTH_USER_MODEL。然后,当我运行manage.py migration时,它弄乱了我的应用程序。相反,当我使用社交身份验证用户模型作为此处描述的OneToOne关系时:stackoverflow.com/q/10638293/977116
Nimo 2014年

3
可能与Changing this setting after you have tables created is not supported by makemigrations and will result in you having to manually write a set of migrations to fix your schema来源有关:docs.djangoproject.com/en/dev/topics/auth/customizing/…– 2014
用户


23

以下是扩展用户的另一种方法。与上面两种方法相比,我觉得它更加清晰,容易,可读。

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

使用以上方法:

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

1
我更喜欢Scott的方法,它基于User对象的继承,而不是直接脱离模型。谁能说这种方法不明智?
BozoJoe 2010年

1
@BozoJoe -我只是碰到了这个问题进口自卸数据,这似乎是使用这种方法的结果:stackoverflow.com/questions/8840068/...
奔Regenspan

15

您可以在每次使用Django发布保存信号创建用户时通过创建一个新条目来简单地扩展用户配置文件

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)

表格

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

嗨,谢谢你的回答。我仍在努力了解如何在urls.py..any提示中将它们链接在一起?
2016年

@sal添加了网址示例,您可以立即检查
Atul Yadav

谢谢!!。它对我有很大帮助。很好的例子
Sunny Chaudhari

@AtulYadav ..您使用的Django是什么版本?
丽都

8

像Pro一样扩展Django用户模型(UserProfile)

我发现这非常有用:链接

摘录:

从django.contrib.auth.models导入用户

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

2
做完了 我不理解为什么是-1。在这种情况下,编辑胜过投票。
Massimo Variolo

3

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

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


1
确实是的。但要注意,除非有必要,否则应避免这种情况。尽管您对所记录的后果感到满意,但出于这个问题的原因实施自己的做法是完全有效的。为了简单地添加字段,建议与常规用户模型建立关系。
gertvdijk

2

这就是我所做的,并且我认为这是最简单的方法。为新的自定义模型定义对象管理器,然后定义模型。

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'

这就是我所做的,并且始终有效。



0

简单有效的方法是models.py

from django.contrib.auth.models import User
class CustomUser(User):
     profile_pic = models.ImageField(upload_to='...')
     other_field = models.CharField()
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.