[Django] User Model 확장하기

📚 django UserModel 

 

Django 에서는 표준 User Model을 제공하고 있다.

 

해당 User Model은 django.contrib.auth.models.User에 다음과 같이 정의 되어 있다.

class User(AbstractUser):
    class Meta(AbstractUser.Meta):
        swappable = 'AUTH_USER_MODEL'

 

아래는 User 모델에서 정의되어 있는 칼럼들이다. 

username = models.CharField()
first_name = models.CharField()
last_name = models.CharField()
email = models.EmailField()
is_staff = models.BooleanField()
is_active = models.BooleanField()
date_joined = models.DateTimeField()

📚 django UserModel 확장하기

 

Django 프로젝트를 진행하다보면, 기본적으로 제공하는 User모델에서 더 필요한 필드가 있을 수 있다. 따라서 User Model을 확장해야 하는 필요성을 느끼게 되는데, 이를 확장하는 방법을 알아보자

 

 

Django 에서 User Model을 확장 또는 커스터마이즈 하는 방법은 3가지가 있다. 

• 표준 User 모델과 1대 1 관계를 가지는 모델을 만드는 방법
• AbstractUser을 상속받는 모델을 만드는 방법
• AbstractBaseUser을 상속받는 모델을 만드는 방법

 

 

 

📕 표준 User 모델과 1대1 관계를 가지는 모델을 만드는 방법

 

해당 방법은 표준 User 모델과 1대1 관계를 가지는 모델을 만들어 유저 정보를 추가하고 싶은 정보를 쓴다. 

class UserAddInfo(models.Model):
	user = models.OneToOneField(settings.AUTH_USER_MODEL)
 	department = models.CharField()
 	image = models.ImageField()

하지만 해당 방법은 기존 칼럼을 반드시 이용하여야 하며, email로 로그인할 수 있 도록 변경할 수 없다. 또한 테이블이 여러개로 나뉘기 때문에 성능면 에서도 봤을때도 좋지 않기에, 크게 추천하지 않는 방식이다. 

 

 

 

📕 AbstarctUser을 상속한 모델을 만드는 방법

 

AbstaractUser은 표준 User 모델이 상속하여 이용하는 방법이다. AbstractUser 모델은 django.contrib.auth.models에 다음과 같이 정의되어 있다. 

 

class AbstractUser(AbstractBaseUser, PermissionsMixin):
    # 기본 제공 속성
    username_validator = UnicodeUsernameValidator()
    username = models.CharField(_('username'), max_length=150, unique=True,…)
    first_name = models.CharField(_('first name'), max_length=30, blank=True)
    last_name = models.CharField(_('last name'), max_length=150, blank=True)
    email = models.EmailField(_('email address'), blank=True)
    is_staff = models.BooleanField(_('staff status'), default=False,…)
    is_active = models.BooleanField(_('active'), default=True,…)
    date_joined = models.DateTimeField(_('date joined'), default=timezone.now)

    objects = UserManager()

    EMAIL_FIELD = 'email'
    USERNAME_FIELD = 'username'
    REQUIRED_FIELDS = ['email']

    class Meta:
        verbose_name = _('user')
        verbose_name_plural = _('users')
        abstract = True

 

 

 AbstaractUser은 AbstaractUser과 PermissionMixin을 상속받고 있다.  해당 방법은 테이블이 여러 개로 나뉘어 퍼포먼스가 나빠지는 등의 불편함은 없지만, 칼럼(속성) 추가만 가능하므로 모델의 유연성이 낮다.

 

표준 User 모델에 칼럼만을 추가하고 싶은 경우에는 이 방법을 이용하면 편리하다.

 

 

📕 AbstarctUser을 상속한 모델을 만드는 방법

 

AbstractBaseUser은 django.contrib.auth.base_user에 다음과 같이 정의되어 있다.

class AbstractBaseUser(models.Model):
    password = models.CharField(_('password'), max_length=128)
    last_login = models.DateTimeField(_('last login'), blank=True, null=True)

    is_active = True

    REQUIRED_FIELDS = []

    _password = None

    class Meta:
        abstract = True

 

AbstractBaseUser은 django.db.models.Model 상속 받고 있다. AbstractBaseUser에는 인증 기능이 포함되어 있으므로 독자적인 필드를 설정하는 것이 가능하다.

 

즉, 인증 이외의 부분은 어떤 것도 구현되어 있지않은 클래스로, first_name이나 last_name이라는 필요없는 필드를 User 모델에 쓰지 않아도된다. AbstractBaseUser을 상속받는 User 모델을 만드는 것은 귀찮지만, 커스터마이즈의 유연성이 방법 중이 가장 높다.  

 

 

해당 커스텀 User 모델을 작성하는 방법은 다음과 같다. 

from django.db import models
from django.contrib.auth.models import PermissionsMixin
from django.contrib.auth.base_user import AbstractBaseUser, BaseUserManager
from django.core.mail import send_mail
from django.utils import timezone
from django.contrib.auth.validators import UnicodeUsernameValidator
from django.utils.translation import gettext_lazy as _

class UserManager(BaseUserManager):
    use_in_migrations = True

    def _create_user(self, username, email, password, **extra_fields):
        if not email:
            raise ValueError('Email을 입력해주세요.')
        email = self.normalize_email(email)
        username = self.model.normalize_username(username)
        user = self.model(username=username, email=email, **extra_fields)
        user.set_password(password)
        user.save(using=self.db)
        return user
    def create_user(self, username, email, password=None, **extra_fields):
        extra_fields.setdefault('is_staff', False)
        extra_fields.setdefault('is_superuser', False)
        return self._create_user(email, password, **extra_fields)

    def create_superuser(self, username, email, password, **extra_fields):
        extra_fields.setdefault('is_staff', True)
        extra_fields.setdefault('is_superuser', True)
        if extra_fields.get('is_staff') is not True:
            raise ValueError('is_staff=True일 필요가 있습니다.')
        if extra_fields.get('is_superuser') is not True:
            raise ValueError('is_superuser=True일 필요가 있습니다.')
        return self._create_user(username, email, password, **extra_fields)
        

class User(AbstractBaseUser, PermissionsMixin):
    username_validator = UnicodeUsernameValidator()

    username = models.CharField(_("username"), max_length=50, validators=[username_validator], blank=True)
    email = models.EmailField(_("email_address"), unique=True)
    is_staff = models.BooleanField(_("staff status"), default=False)
    is_active = models.BooleanField(_("active"), default=True)
    date_joined = models.DateTimeField(_("date joined"), default=timezone.now)

    objects = UserManager()
    USERNAME_FIELD = "email"
    EMAIL_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)

 

• UserManager
  
  터미널에서 유저를 생성할 때 호출되는 클래스이다. 

• User

 

- object : 해당 모델에서 objects 변수는 views.py 에서 User 모델의 정보를 얻을 때 이용한다.

user = User.objects.get(username="blank")

- USERNAME_FIELD :고유 식별자로 사용되는 사용자 모델의 필드 이름을 설명하는 문자열이다. 이것은 일반적으로 일종의 사용자 이름이지만 이메일 주소 또는 기타 고유 식별자일 수도 있다.

- EMAIL_FIELD : 모델의 이메일 필드 이름을 설명하는 문자열이다. User 값은  get_email_field_name()에 의해 반환됩니다

- is_active : 사용자가 "활성"으로 간주되는지 여부를 나타내는 Bool 속성

- is_staff : 스태프 권한 

- clean() : normalize_username()을 호출하여 사용자 이름을 정규화 한다. super()이 매서드를 재정의할때는 정규화를 유지하기 위해 호출하여야 한다.

 

 

📙 settings.py

AUTH_USER_MODEL = 'users.User'

 

 

📙 admin.py

 

관리자 사이트에 커스텀 User을 이용할 수 있도록 하기 위해 어플리케이션의 admin.py을 변경한다. 또한 이 코드에서는 UserCreationForm 이나 UserCahngeForm도 그대로 이용할 수 없으므로 전용 Form을 만들었다.

 

from django.contrib import admin
from django.contrib.auth.admin import UserAdmin
from django.contrib.auth.forms import UserChangeForm, UserCreationForm
from django.utils.translation import gettext_lazy as _
from .models import User

class MyUserChangeForm(UserChangeForm):
    class Meta:
        model = User
        fields = '__all__'

class MyUserCreationForm(UserCreationForm):
    class Meta:
        model = User
        fields = ('email','username')

class MyUserAdmin(UserAdmin):
    fieldsets = (
        (None, {'fields': ('email', 'password', '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(User, MyUserAdmin)

 

 

 

---

참조 :

 

https://engineer-mole.tistory.com/301

[Django] User모델 커스터마이즈하기 (커스텀 User 모델)

https://wikidocs.net/10294

04) 커스텀 User 모델 (AbstractBaseUser의 상속)