用Django中的自定义字段扩展用户模型
使用自定义字段来扩展用户模型(与Django的身份validation应用程序捆绑在一起)的最佳方式是什么? 我也可能想使用电子邮件作为用户名(用于身份validation的目的)。
我已经看到了一些 方法来做到这一点,但不能决定哪一个是最好的。
Django推荐的最简单的方法是通过OneToOneField(User)
属性。
扩展现有的用户模型
…
如果您希望存储与
User
相关的信息,则可以使用包含字段的模型的一对一关系来获取更多信息。 这种一对一模式通常被称为configuration文件模型,因为它可能存储有关站点用户的非auth相关信息。
这就是说,扩展django.contrib.auth.models.User
并取代它也可以…
replace自定义用户模型
某些types的项目可能具有身份validation要求,而Django的内置
User
模型并不总是适合的。 例如,在一些网站上,使用电子邮件地址作为您的身份标记而不是用户名更有意义。[编辑: 两个警告和一个通知后面提到,这是非常激烈的 。]
我肯定会远离更改Django源代码树中的实际User类和/或复制和更改auth模块。
注意:这个答案已被弃用。 如果您使用的是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'
这将创build一个用户configuration文件,每次保存用户,如果它被创build。 你可以使用
user.get_profile().whatever
这里有一些来自文档的更多信息
http://docs.djangoproject.com/en/dev/topics/auth/#storing-additional-information-about-users
更新:请注意, AUTH_PROFILE_MODULE
自v1.5 AUTH_PROFILE_MODULE
已弃用: https : AUTH_PROFILE_MODULE
那么,自2008年以来有一段时间了,是时候回答一些新的问题了。 由于Django 1.5你将能够创build自定义的用户类。 其实在我写这个的时候已经和主人合并了,所以你可以试试看。
在文档中有一些关于它的信息,或者如果你想深入了解它,在这个提交 。
您只需将AUTH_USER_MODEL
添加到具有自定义用户类path的设置中,该path可以扩展AbstractBaseUser
(更多可定制版本)或AbstractUser
(您可以扩展的或多或less的旧用户类)。
对于懒惰点击的人,这里的代码示例(从文档中获取 ):
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
有关于存储关于用户的附加信息的官方build议。 Django Book也在“ configuration文件”一节中讨论了这个问题。
由于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"))
您还必须在设置文件中将其configuration为当前用户类别
# supposing you put it in apps/profiles/models.py AUTH_USER_MODEL = "profiles.UserProfile"
如果你想添加很多用户的喜好,OneToOneField选项可能是一个更好的select思路。
对于开发第三方库的人来说:如果你需要访问用户类,记住人们可以改变它。 使用官方的帮手来获得正确的课程
from django.contrib.auth import get_user_model User = get_user_model()
下面是扩展用户的另一种方法。 我觉得上面两种方法比较清楚,容易,可读。
http://scottbarnham.com/blog/2008/08/21/extending-the-django-user-model-with-inheritance/
使用上面的方法:
- 您不需要使用user.get_profile()。newattribute来访问与用户相关的附加信息
- 你可以通过user.newattribute直接访问额外的新属性
您可以简单地扩展用户configuration文件,每次创build用户时使用django后保存信号创build一个新的条目
models.py
from django.db.models.signals import * from __future__ import unicode_literals class userProfile(models.Model): userName = models.OneToOneField(User, related_name='profile') city = models.CharField(max_length=100, null=True) def __unicode__(self): # __str__ return unicode(self.userName) def create_user_profile(sender, instance, created, **kwargs): if created: userProfile.objects.create(userName=instance) post_save.connect(create_user_profile, sender=User)
这将在创build新用户时自动创build员工实例。
如果您希望扩展用户模型,并希望在创build用户时添加更多信息,则可以使用django-betterforms( http://django-betterforms.readthedocs.io/en/latest/multiform.html )。 这将创build一个用户添加表单,其中包含userProfile模型中定义的所有字段。
models.py
from django.db.models.signals import * from __future__ import unicode_literals class userProfile(models.Model): userName = models.OneToOneField(User) city = models.CharField(max_length=100) def __unicode__(self): # __str__ return unicode(self.userName)
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 = ('userName',) 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 = "addUser.html" success_url = '/your url after user created' def form_valid(self, form): user = form['user'].save() profile = form['profile'].save(commit=False) profile.userName = 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='addDistributor'), ]
像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
新的Django 1.5,现在你可以创build自己的自定义用户模型(这似乎是在上面的情况下做的好事)。 参考'在Django中定制authentication'
可能是1.5版本中最酷的新function。