User Model을 수정하는 두 가지 방법
전 글에서는 User를 제외한 다른 model을 직접 설계해 보았다. 여기서 User와 연결할 때, 이미 주어진 model을 사용하였고 그 경로는 django.contrib.auth.models였다. 가상 환경에 설치된 django 코드를 살펴봐서 User가 어떤 식으로 생겼는지 알아보자.
class User(AbstractUser):
"""
Users within the Django authentication system are represented by this
model.
Username and password are required. Other fields are optional.
"""
class Meta(AbstractUser.Meta):
swappable = "AUTH_USER_MODEL"다음과 같이 User는 AbstractUser를 상속받은 클래스임을 확인할 수 있다. Meta class에 swappable이라는 변수가 지정되어 있어서 찾아봤더니, 그 값인 AUTH_USER_MODEL은 settings.py에 지정해서 내가 사용할 User model을 정의하는 데 쓸 수 있다. 즉 지금은 기본 django user로 지정되어 있으나, AUTH_USER_MODEL을 settings.py에 설정하여 내가 만든 custom user model로 사용할 model을 바꿀 수 있다는 것이다. 즉, AbstractUser를 상속받는 새 User를 정의한 후 AUTH_USER_MODEL을 수정해 준다면 우리가 원하는 대로 User를 수정할 수 있다.
User Model을 아예 건드리지 않고 데이터만 넣을 수 있는 방법도 있다. 기존 User와 1대 1로 관계를 맺는 profile model을 추가하여 개인정보를 넣는 것이다. 데이터 추가만 해도 된다면 이 방법도 충분히 고려할 수 있는 방법이다.
의사 결정
나는 앞서 이야기한 두 방법 중 전자를 쓰기로 했다.
AbstractUser를 상속하지 않는다면 기존에 Django에 정의되어 있는 field 자체는 수정할 수 없다. AbstractUser class의 코드를 직접 살펴보도록 하자.
class AbstractUser(AbstractBaseUser, PermissionsMixin):
"""
An abstract base class implementing a fully featured User model with
admin-compliant permissions.
Username and password are required. Other fields are optional.
"""
username_validator = UnicodeUsernameValidator()
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."),
},
)
first_name = models.CharField(_("first name"), max_length=150, 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,
help_text=_("Designates whether the user can log into this admin site."),
)
is_active = models.BooleanField(
_("active"),
default=True,
help_text=_(
"Designates whether this user should be treated as active. "
"Unselect this instead of deleting accounts."
),
)
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
def clean(self):
super().clean()
self.email = self.__class__.objects.normalize_email(self.email)
def get_full_name(self):
"""
Return the first_name plus the last_name, with a space in between.
"""
full_name = "%s %s" % (self.first_name, self.last_name)
return full_name.strip()
def get_short_name(self):
"""Return the short name for the user."""
return self.first_name
def email_user(self, subject, message, from_email=None, **kwargs):
"""Send an email to this user."""
send_mail(subject, message, from_email, [self.email], **kwargs)여기 보면 username이나 first_name, last_name 등의 field들의 길이 제한이 설정되어 있는데, 이 field들을 재정의하기 위해서는 AbstractUser를 상속해야 한다. 기획이 확정되는 대로 길이 제한이나 유효성 검사 조건 등을 바꿀 필요가 있기 때문에, 유연하게 이를 수정할 수 없는 후자는 적합하지 않다는 결론을 내렸다.
코드 작성하기
이제 위 방식대로 코드를 작성해 보자. 일단 User model은 게시판 기능에 한정한 기능이 아니므로 계정 관리를 위한 account app 을 생성하여 거기에 user를 정의하도록 한다. 유효성 검사 기준을 벌써 설정하지는 않고, 일단 field만 만들어 두고 진행할 것이다.
from django.db import models
from django.contrib.auth.models import AbstractUser
class User(AbstractUser):
id = models.AutoField(primary_key=True, db_column="id")
username = models.CharField(max_length=20, unique=True) # login ID 역할을 한다.
email = models.EmailField(verbose_name="email address", max_length=255, unique=True)
password = models.CharField(max_length=20, null=False)
nickname = models.CharField(max_length=10, unique=True)
role field의 경우 이미 is_staff와 is_superuser를 지원하고 있기 때문에 굳이 넣을 필요가 없다. 또한 created_at field도 해당 역할을 하는 data_joined field가 존재하기 때문에 추가하지 않았다.
이제 settings.py에 AUTH_USER_MODEL = "account.User"를 한 줄 추가하고 Django 내에서 제공하는 admin에서도 User를 확인해야 하므로 account app의 admin.py에 User를 등록해 준다.
from django.contrib import admin
from django.contrib.auth.admin import UserAdmin
from .models import Users
admin.site.register(Users, UserAdmin)Installed_app을 수정하는 것도 잊지 말아야 migration이 정상 수행된다. 기존에 생성했던 table은 Drop해 주고 migration 관련 파일들도 전부 삭제해 주자.
INSTALLED_APPS = [
"account.apps.AccountConfig",
"community.apps.CommunityConfig",
"django.contrib.admin",
"django.contrib.auth",
"django.contrib.contenttypes",
"django.contrib.sessions",
"django.contrib.messages",
"django.contrib.staticfiles",
]마지막으로 기존 User를 참조하고 있던 community app의 model들을 from account.models import User로 import 부분을 수정하여 내가 만든 User로 수정하면 된다. 그 뒤 migration을 수행하자.
다음과 같이 account_user table이 정상적으로 생긴 것을 확인할 수 있다.
다음 목표
이제 model까지 짰으니 view를 건드려야 하는데, Django Template을 이용하지 않을 것이기 때문에 Django Rest Framework를 사용해야 한다. 다음 글에서는 이를 사용하는 방법을 알아보고 프로젝트에 설치한 후 적용까지 해 볼 것이다.
