AbstractBaseUser

장현웅·2023년 10월 5일

🐣 AbstractBaseUser

프로젝트에 맞게 사용자 모델을 원하는대로 정의해주기 위해 AbstractBaseUser를 사용해봤습니다.

Django는 내장 사용자 모델을 사용할 수도 있지만,

AbstractBaseUser를 사용하여 사용자 모델을 정의하면, Django의 내장 사용자 모델을 확장하고 커스터마이즈할 수 있습니다. 필요한 필드를 추가하거나 기본 필드를 변경하는 등 프로젝트에 맞는 고유한 데이터 모델을 정의할 수 있습니다.

또한, 사용자 인증 시스템도 프로젝트에 맞게 직접 구현한 방식으로 제어할 수 있어 사용자 데이터의 보안을 맘껏 개선할 수 있습니다.

🐥 AbstractBaseUser를 사용하여 사용자 모델을 정의

"""
'AbstractBaseUser'를 사용하여 사용자 모델을 커스터마이징하고 사용자 모델을 보안적으로 강화하고 사용자 인증을 개선하기 위해 'BaseUserManager'를 사용하겠습니다.

'AbstractBaseUser'를 상속하여 사용자 모델을 정의하면, 사용자명, 이메일 등과 같은 고유한 식별자를 사용하여 인증할 수 있습니다.
'BaseUserManager'를 통해 필요한 메서드를 추가하여 사용자를 생성하고 비밀번호 설정 및 변경, 사용자 그룹 및 권한 관리 등의 작업을 수행할 수 있습니다.

참고 : https://docs.djangoproject.com/en/4.1/topics/auth/customizing/ ' (참조 : 'A full example')
"""

from django.db import models
from django.contrib.auth.models import AbstractBaseUser, BaseUserManager

import random

class UserManager(BaseUserManager):

    """사용자 모델을 생성하고 관리하는 역할을 하는 클래스입니다."""
    
    def create_user(self, email, password):
        # 일반 사용자를 생성하는 메서드입니다.
        if not email:
            raise ValueError('유효하지 않은 이메일 형식입니다.')

        user = self.model(
            email=self.normalize_email(email),                                              # 'normalize_email' : Django의 'django.contrib.auth.models' 모듈에 있는 'UserManager' 클래스에 포함된 메서드로 'AbstractBaseUser' 또는 'BaseUserManager'와 같은 사용자 모델(User 모델)에서 사용됩니다.
                                                                                            # 이메일 주소를 일관된 형식으로 변환하는 역할을 합니다. 예를 들어, 사용자가 "UsEr@ExAmPle.CoM" 이렇게 입력해도 "user@example.com" 이렇게 변환시켜줍니다.
            password=password,
            nickname=f"user!@#${random.randint(1000000000,999999999999999)}!@#$",           # createsuperuser로 사용자 계정을 생성할 때, nickname값을 받지 않기 때문에 데이터베이스에 nickname값이 빈 상태로 들어가는데, 두 번째 createsuperuser로 사용자 계정을 생성할 때부터 빈 값이 또 들어가게 되면 'unique=True'의 속성 때문에 오류가 발생합니다. 'null=True', 'blank=True'로 속성을 지정해도 되지만, 요구 조건과 맞지 않기 때문에 입력을 안해줬을 시에 랜덤한 값으로 저장되도록 설정해줍니다. 
        )                                                  
        user.set_password(password)                                                         # 'set_password' : 사용자의 비밀번호를 설정하는 메서드로 사용자가 제공한 비밀번호를 안전하게 저장하기 위해 해싱(hash)된 형태로 저장합니다.
        user.save(using=self._db)                                                           # 'using=self._db' 옵션 : 저장할 데이터베이스를 지정하는 역할을 합니다. / save 메서드 : 사용자 모델 객체를 데이터베이스에 저장하는 메서드입니다.
        return user

    
    def create_superuser(self, email, password):
        # 관리자를 생성하는 메서드입니다.
        if not email:
            raise ValueError('유효하지 않은 이메일 형식입니다.')

        user = self.create_user(
             email=self.normalize_email(email), 
             password=password, 
             )
        user.is_admin = True                                                                # createsuperuser로 생성된 계정에 관리자 권한을 부여합니다.
        user.save(using=self._db)
        return user
    
"""
위의 (email, password=password,)에서 각 인자 전달 방식이 달라서 정리해봤습니다.

< 함수 호출 시 인자 전달 방식 >

1. 키워드 인수 ('인자이름=값' in python)
키워드 인수는 인자를 함수에 전달할 때 인자의 이름을 함께 지정하는 방식
인자의 순서와 상관없이 명시적으로 어떤 인자에 어떤 값을 전달하는지 명확하게 지정할 수 있습니다.
(email=email, password=password,)

2. 위치 인수
위치 인수는 인자를 함수에 전달할 때 인자의 순서에 따라 전달하는 방식
함수 정의 시에 정의된 매개변수의 순서대로 값을 전달해야 합니다.
( email, password)
"""

""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     

class User(AbstractBaseUser):
    """
    커스텀 사용자 모델을 정의하는 클래스입니다.
    
    - email(필수) : 로그인 시 사용할 사용자의 이메일 주소입니다.
    - password(필수) : 로그인 시 사용할 비밀번호입니다.
    - fullname(필수) : 사용자의 이름입니다.
    - nickname(필수) : 사용자의 닉네임입니다.
        - 다른 사람의 닉네임과 중복되지 않도록 설정합니다.
    - image : 사용자의 프로필 사진입니다.
    - birthday : 사용자의 생년월일입니다.
    - join_date : 회원가입 일자 및 시간입니다.
        - 회원가입 한 시간을 자동으로 저장하도록 설정합니다.
    - is_active : 계정 활성화 여부입니다.
        - True 혹은 False를 저장할 수 있으며, 기본값으로 True를 저장하도록 설정합니다.
    """
    
    email = models.EmailField( 
        verbose_name="이메일",                                                      # 'verbose_name' : 필드의 label입니다. [ 1. 데이터베이스 테이블에 표시되는 필드 이름 지정 2. 관리자페이지에 표시되는 필드 이름 지정 3. 에러메시지에 표시되는 필드 이름 지정 4. 시리얼라이저에 표시되는 필드 이름 지정]
        max_length=255,
        unique=True,                                                                # 'unique=True' : 같은 모델 클래스의 여러 인스턴스에서 동일한 값을 가질 수 없다는 것을 의미합니다.
    )
    password = models.CharField(verbose_name="비밀번호", max_length=255)            # 비밀번호는 해싱되어 저장되기 때문에 최대 길이를 길게 설정합니다.
    fullname = models.CharField("이름", max_length=50)
    nickname = models.CharField("닉네임", unique=True, max_length=50)
    profile_img = models.ImageField("프로필 이미지", null=True, blank=True)
    birthday = models.DateField("생년월일", null=True, blank=True)                  # 'blank=True', 'null=True' 속성을 부여하여 'birthday'값을 선택적으로 받을 수 있습니다.
    join_date = models.DateTimeField("가입일", auto_now_add=True)
    is_admin = models.BooleanField("관리자 권한 여부", default=True)
    is_active = models.BooleanField("계정 활성화 여부", default=True)

    objects = UserManager()                                                         # 기본 사용자 지정 매니저(objects 속성에 정의)가 아닌 커스텀 된 사용자에 대한 매니저를 지정합니다. 괄호 ()는 UserManager 클래스의 인스턴스를 생성하고, 이를 objects라는 속성에 할당하는 작업 실행을 의미합니다.

    USERNAME_FIELD = 'email'                                                        # 'USERNAME_FIELD' : 로그인 시 사용자 식별(인증)에 사용할 필드를 지정합니다.
    REQUIRED_FIELDS = []                                                            # 'REQUIRED_FIELDS' : 사용자 생성 및 슈퍼유저 생성 시에 필수로 입력해야 하는 필드 이름을 리스트 형태로 지정합니다. 
    
    def __str__(self):
        return self.email
    
    def has_perm(self, perm, obj=None):                                             # 사용자 객체의 특정 권한 여부를 판단하는 메서드입니다. 액세스 제어 및 권한 관리에 사용됩니다. 예를 들어, 관리자 페이지에서 관리자의 등급을 나눌 때, 로직을 추가하여 정의합니다.
            return True
    
    def has_module_perms(self, app_label):                                          # 사용자 객체가 특정 앱(App) 또는 모듈(Module)에 대한 권한을 가지고 있는지 여부를 판단하는 메서드입니다.
        return True
    
    @property                                                                       # @property : 메서드를 속성처럼 접근할 수 있게 만들어주는 데코레이터 입니다.
    def is_staff(self):                                                             # 사용자가 관리자인지 아닌지를 나타내는 메서드입니다. '@property' 데코레이터를 사용하여 해당 메서드를 통해 is_staff 속성(필드)를 가상적으로 생성할 수 있습니다.
        return self.is_admin

🐓 Django 내장 사용자 모델 VS AbstractUser VS AbstractBaseUser

1. 내장 사용자 모델

장점
- 사용자 모델을 빠르고 간단하게 설정할 수 있습니다.
- 기본 필드를 제공하여 일반적인 사용자 모델을 정의하기 적합합니다.
- 기본적인 사용자 관리 및 인증 기능을 제공합니다.
단점
- 기본 필드 이외의 원하는 커스텀 필드 추가나 필드 수정이 어렵습니다.
- 기본 필드가 필요 없는 경우 적합하지 않은 사용자 모델입니다.