참고: testdriven.io: Creating a Custom User Model in Django

---

username ? email !

장고의 기본 유저 모델(User AbstractUser)을 사용하게 되면 로그인 아이디는 username으로 설정된다.

그 이유는 기본 유저 모델은 UserManager 클래스를 사용하기 때문이다.

class UserManager

기본 유저 모델을 사용할 경우 _create_user 함수에서 username 입력을 필수로 하고

if not username:
	raise ValueError("The given username must be set")

AbstractUser 클래스에서 USERNAME_FIELD를 username으로 설정한다.

USERNAME_FIELD = "username"

따라서 username이 아닌 email을 로그인 아이디로 사용하고 싶다면 위 내용들을 변경시켜야 한다.

class BaseUserManager

위 사진에서 UserManager 클래스는 BaseUserManager 클래스를 상속하는 것을 알 수 있다.
로그인 아이디를 email로 바꾸기 위해 먼저 BaseUserManager 클래스를 상속하는 CustomUserManager 클래스를 만들어보자.

# accounts/managers.py

from django.contrib.auth.base_user import BaseUserManager
from django.utils.translation import gettext_lazy as _


class CustomUserManager(BaseUserManager):
    """
    Custom user model manager where email is the unique identifiers
    for authentication instead of usernames.
    """
    def create_user(self, email, password, **extra_fields):
        """
        Create and save a User with the given email and password.
        """
        if not email:
            raise ValueError(_('The Email must be set'))
        email = self.normalize_email(email)
        user = self.model(email=email, **extra_fields)
        user.set_password(password)
        user.save()
        return user

    def create_superuser(self, email, password, **extra_fields):
        """
        Create and save a SuperUser with the given email and password.
        """
        extra_fields.setdefault('is_staff', True)
        extra_fields.setdefault('is_superuser', True)
        extra_fields.setdefault('is_active', 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, password, **extra_fields)

CustomUserManager 클래스에서 기존의 username에 해당하는 부분을 email로 변경하였다.

다음으로 accounts/models.py에서 커스텀 매니저를 사용하는 커스텀 모델을 작성하면 된다.

커스텀 모델을 작성할 때는 AbstractUser AbstractBaseUser 둘 다 사용할 수 있다.

class AbstractUser

AbstractUser 클래스를 상속하여 커스텀 모델을 작성할 때는 기존 클래스에서 정의되어 있는 내용들을 변경해줘야 한다.

class CustomAbstractUser(AbstractUser):
    username = None  # username을 사용 안할 경우
    email = models.EmailField(_('email address'), unique=True)

    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = []

    objects = CustomUserManager()

    def __str__(self):
        return self.email

objects필드를 기존 Usermanager()에서 CustomUserManager()로 바꿔주었다.

username필드는 None으로 변경해주고 email 필드에 unique=True를 추가로 설정, USERNAME_FIELD를 email로 변경해주었다.

class AbstractBaseUser

AbstractBaseUser 클래스를 상속하여 커스텀 모델을 작성할 때는 기존 password필드 외 필요한 필드들을 모두 작성하면 된다.

class CustomAbstractBaseUser(AbstractBaseUser, PermissionsMixin):
    email = models.EmailField(_('email address'), unique=True)
    is_staff = models.BooleanField(default=False)
    is_active = models.BooleanField(default=True)
    date_joined = models.DateTimeField(default=timezone.now)

    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = []

    objects = CustomUserManager()

    def __str__(self):
        return self.email

---

로그인 아이디를 email로 설정하는 법에 대해 알아보았다.