カスタムフィールドを使用してユーザーモデル(Djangoの認証アプリにバンドルされている)を拡張するための最良の方法は何ですか?また、(認証目的で)ユーザー名として電子メールを使用したいと思います。
15 に答える
これを行う最も簡単で実際に Django が推奨する方法は、OneToOneField(User)
プロパティを使用することです。
既存の User モデルの拡張
…</p>
に関連する情報を保存する場合は、追加情報のフィールドを含むモデルと 1 対 1 の関係
User
を使用できます。この 1 対 1 のモデルは、サイト ユーザーに関する非認証関連の情報を格納する場合があるため、プロファイル モデルと呼ばれることがよくあります。
とはいえ、それを拡張django.contrib.auth.models.User
して置き換えることも機能します...
カスタム User モデルの置き換え
User
一部の種類のプロジェクトには、Django の組み込みモデルが常に適切であるとは限らない認証要件がある場合があります。たとえば、一部のサイトでは、ユーザー名の代わりに電子メール アドレスを ID トークンとして使用する方が理にかなっています。[編集: 2 つの警告と 1 つの通知が続き、これはかなり抜本的なものであると述べています。]
Django ソース ツリーの実際の User クラスを変更したり、auth モジュールをコピーして変更したりすることは絶対に避けたいと思います。
さて、2008 年からしばらく時間が経ち、新しい答えを出す時が来ました。Django 1.5 以降、カスタム User クラスを作成できます。実は、これを書いている時点ですでに 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
ユーザーに関する追加情報の保存に関する公式の推奨事項があります。Django Book のProfilesセクションでもこの問題について説明しています。
以下は、ユーザーを拡張する別のアプローチです。上記の2つのアプローチよりも明確で、簡単で、読みやすいと思います。
http://scottbarnham.com/blog/2008/08/21/extending-the-django-user-model-with-inheritance/
上記のアプローチを使用する:
- ユーザーに関連する追加情報にアクセスするためにuser.get_profile().newattributeを使用する必要はありません
- user.newattributeを介して追加の新しい属性に直接アクセスできます
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)
フォーム.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>
urls.py
from django.conf.urls import url, include
from appName.views import *
urlpatterns = [
url(r'^add-user/$', AddUser.as_view(), name='add-user'),
]
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'
最後に、モデルを admin に登録し、makemigrations と migrate を実行すると、正常に完了します。
公式ドキュメント: https://docs.djangoproject.com/en/3.2/topics/auth/customizing/#substituting-a-custom-user-model
Django 1.5 の新機能として、独自のカスタム ユーザー モデルを作成できるようになりました (上記の場合、これは良いことのようです)。「Django での認証のカスタマイズ」を参照してください。
おそらく 1.5 リリースで最もクールな新機能です。
これが私がしていることであり、私の意見では、これを行う最も簡単な方法です。新しいカスタマイズされたモデルのオブジェクト マネージャーを定義してから、モデルを定義します。
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'
これは私がしていることであり、常に機能します。