🚀
DjangoのCustomUserの設定
アプリケーションの立ち上げ
まずは、以下のコマンドでアプリケーションを作成します。
今回はCustomUserの設定をしていきます。
アプリケーションの立ち上げ
まずはCustomUserを設定するアプリケーションを立ち上げます。
以下のコマンドを実行し、アプリケーションを立ち上げます。
bash
poetry run python manage.py startapp accounts
CustomUserモデルの作成
コード全体は以下のように設定しました。
CustomUserの設定は様々だと思いますし、開発するアプリケーションによって欲しい設定は異なると思います。あくまでこの記事ではこのようにしたということで書いていきます。
accounts/models.py
backend/accounts/models.py
from django.contrib.auth.models import AbstractBaseUser, PermissionsMixin
from django.contrib.auth.base_user import BaseUserManager
from django.contrib.auth.validators import UnicodeUsernameValidator
from django.core.mail import send_mail
from django.db import models
from django.utils import timezone
from django.utils.translation import gettext_lazy as _
import uuid
class UserManager(BaseUserManager):
use_in_migrations = True
def _create_user(self, email, username, password=None, **extra_fields):
"""
指定されたメールアドレスとユーザー名でユーザーを作成し、保存します。
"""
if not email:
raise ValueError(_("The Email field must be set."))
email = self.normalize_email(email) # メールアドレスを正規化
user = self.model(email=email, username=username, **extra_fields)
user.set_password(password) # パスワードをハッシュ化して保存
user.save(using=self._db)
return user
def create_user(self, email, username, password=None, **extra_fields):
"""
通常のユーザーを作成します。
"""
extra_fields.setdefault("is_staff", False) # デフォルトでスタッフ権限はFalse
extra_fields.setdefault(
"is_superuser", False
) # デフォルトでスーパーユーザー権限はFalse
return self._create_user(email, username, password, **extra_fields)
def create_superuser(self, email, username, password=None, **extra_fields):
"""
スーパーユーザーを作成します。
"""
extra_fields.setdefault("is_staff", True) # スタッフ権限をTrueに設定
extra_fields.setdefault(
"is_superuser", True
) # スーパーユーザー権限をTrueに設定
if extra_fields.get("is_staff") is not True:
raise ValueError(_("Superuser must have is_staff=True."))
if extra_fields.get("is_superuser") is not True:
raise ValueError(_("Superuser must have is_superuser=True."))
return self._create_user(email, username, password, **extra_fields)
class CustomUser(AbstractBaseUser, PermissionsMixin):
"""
カスタムユーザーモデル。AbstractBaseUserを継承して、独自のユーザーモデルを定義します。
PermissionsMixinは、権限関連のフィールドとメソッドを提供します。
"""
username_validator = UnicodeUsernameValidator() # ユーザー名のバリデーター
uuid = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
username = models.CharField(
_("username"),
max_length=150,
unique=True,
help_text=_(
"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only."
),
validators=[username_validator],
error_messages={
"unique": _("A user with that username already exists."),
},
)
email = models.EmailField(_("email address"), unique=True, blank=False)
is_active = models.BooleanField(
_("active"),
default=True,
help_text=_(
"Designates whether this user should be treated as active. "
"Unselect this instead of deleting accounts."
),
)
is_staff = models.BooleanField( # 管理サイトへのログイン可否
_("staff status"),
default=False,
help_text=_("Designates whether the user can log into this admin site."),
)
date_joined = models.DateTimeField(_("date joined"), default=timezone.now)
objects = UserManager() # カスタムユーザーマネージャーを指定
# groupsとuser_permissionsのリレーション名を変更
groups = models.ManyToManyField(
"auth.Group",
verbose_name=("groups"),
blank=True,
help_text=(
"The groups this user belongs to. A user will get all permissions "
"granted to each of their groups."
),
related_name="custom_users_groups", # ここを変更
related_query_name="custom_user",
)
user_permissions = models.ManyToManyField(
"auth.Permission",
verbose_name=("user permissions"),
blank=True,
help_text=("Specific permissions for this user."),
related_name="custom_users_permissions", # ここを変更
related_query_name="custom_user_permission",
)
EMAIL_FIELD = "email" # メールアドレスをUSERNAME_FIELDとして使用
USERNAME_FIELD = "email" # ログインに使用するフィールドを指定
REQUIRED_FIELDS = ["username"] # ユーザー作成時に必須のフィールド
class Meta:
verbose_name = _("User")
verbose_name_plural = _("users")
def clean(self):
super().clean()
self.email = self.__class__.objects.normalize_email(self.email)
def email_user(self, subject, message, from_email=None, **kwargs):
"""
このユーザーにメールを送信します。
"""
send_mail(subject, message, from_email, [self.email], **kwargs)
def __str__(self):
return self.username
accounts/forms.py
backend/accounts/forms.py
from django.contrib.auth.forms import UserCreationForm, UserChangeForm
from .models import CustomUser
class MyUserChangeForm(UserChangeForm):
class Meta:
model = CustomUser
fields = '__all__'
class MyUserCreationForm(UserCreationForm):
class Meta:
model = CustomUser
fields = ('email',)
accounts/admin.py
backend/accounts/admin.py
from django.contrib import admin
from django.contrib.auth.admin import UserAdmin
from django.utils.translation import gettext_lazy as _
from .models import CustomUser
from .forms import MyUserChangeForm, MyUserCreationForm
class MyUserAdmin(UserAdmin):
fieldsets = (
(None, {"fields": ("email", "password")}),
(
_("Personal info"),
{"fields": ("username",)},
),
(
_("Permissions"),
{
"fields": (
"is_active",
"is_staff",
"is_superuser",
"groups",
"user_permissions",
)
},
),
(_("Important dates"), {"fields": ("last_login", "date_joined")}),
)
add_fieldsets = (
(
None,
{
"classes": ("wide",),
"fields": ("email", "password1", "password2"),
},
),
)
form = MyUserChangeForm
add_form = MyUserCreationForm
list_display = ("email", "username", "is_staff")
list_filter = ("is_staff", "is_superuser", "is_active", "groups")
search_fields = ("email", "username")
ordering = ("email",)
admin.site.register(CustomUser, MyUserAdmin)
マイグレーション
以下のコマンドでマイグレーションを実行します。
poetry run python manage.py makemigrations
poetry run python manage.py migrate
正常に実行されれば完了です。
superuserの設定
以下のコマンドにより、superuserを作成します。
poetry run python manage.py createsuperuser
管理画面
管理画面にアクセスします。
poetry run python manage.py runserver
指定されたURLにアクセスして、/adminにアクセスするとログイン画面が開きます。
また、先ほど作成したsuperuserを使用してログインすると、管理画面が表示されると思います。
以上がCustomUserの設定です。
Discussion