[DRF] 커스텀 유저 사용하기

참고

가상환경은 poetry를 사용하였습니다.

Django 시작

poetry init
poetry add Django
poetry add djangorestframework
poetry run django-admin startproject 프로젝트명

패키지 설치

poetry add django-allauth

• 소셜 인증뿐 아니라 사용자 등록을 처리한다.(이메일 주소 확인, 비밀번호 재설정에 좋다.)

poetry add django-rest-auth

• 사용자 등록, 로그인/로그아웃, 비밀변호 변경/재설정, 소셜 인증 등을 위한 API 엔드 포인트를 편리하게 제공한다.

settings.py 파일 안에 INSTALLED_APPS 내용 추가

INSTALLED_APPS = [
    ...
    'rest_framework',
    'rest_framework.authtoken',
    'rest_auth',
    'django.contrib.sites',
    'allauth',
    'allauth.account',
    'rest_auth.registration',
    ...
]

User app

poetry run python manage.py startapp users

settings.py 파일 안에 INSTALLED_APPS 내용 추가

INSTALLED_APPS = [
    ...
    'users',
    ...
]

커스텀 유저 관리하기

• managers.py 파일에 커스텀 유저 클래스 만들기

from django.contrib.auth.base_user import BaseUserManager
from django.utils.translation import ugettext_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)

커스텀 유저 모델

커스텀 유저 모델을 만들 때 두 가지 옵션이 있다.

AbstractUser: 전체 사용자 모델로 추상 클래스와 같은 필드로 완성되어 상속을 받고 자신의 프로필 필드와 메소드를 추가할 수 있다.

AbstractBaseUser: 인증 기능만 포함하지만 실제 필드는 포함하지 않는다.

이번에는 AbstractUser를 사용해보자

• username 필드를 제거한다.
• email 필드 속성에 required와 unique를 추가한다.
• User 모델의 고유 식별자를 정의하는USERNAME_FIELD를 email로 설정한다.
• 클래스의 모든 객체가 이전에 생성한 CustomUserManager에서 오도록 지정한다.
• 측정을 위해 두 개의 필드를 추가한다.

from django.db import models
from django.contrib.auth.models import AbstractUser
from django.utils.translation import ugettext_lazy as _

from managers import CustomUserManager

class CustomUser(AbstractUser):
	username = None
    email = models.EmailField(_('email address'), unique=True)
    
    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = []
    
    objects = CustomUserManager()
    
    spouse_name = models.CharField(blank=True, max_length=100)
    data_of_birth = models.DateField(blank=True, null=True)
    
    def __str__(self):
    	return self.email

settings.py에 내용을 추가한다.

AUTH_USER_MODEL = 'users.CustomUser'

ACCOUNT_USER_MODEL_USERNAME_FIELD = None
ACCOUNT_EMAIL_REQUIRED = True
ACCOUNT_UNIQUE_EMAIL = True
ACCOUNT_USERNAME_REQUIRED = False
ACCOUNT_AUTHENTICATION_METHOD = 'email'
ACCOUNT_EMAIL_VERIFICATION = 'mandatory'
ACCOUNT_CONFIRM_EMAIL_ON_GET = True
ACCOUNT_EMAIL_CONFIRMATION_ANONYMOUS_REDIRECT_URL = '/?verification=1'
ACCOUNT_EMAIL_CONFIRMATION_AUTHENTICATED_REDIRECT_URL = '/?verification=1'

SITE_ID = 1
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'

위에서 설정한 내용

• 사용자 이름 대신 이메일 사용하기
• 인증 링크와 함께 사용자 등록 시 이메일 인증 메세지 전송
• 사용자가 링크를 클릭하면 이메일이 확인되고 /?verification=1로 리디렉션된다.
• 이메일 메세지를 콘솔로 출력(실제 이메일을 보내려면 Simple Mail Transfer Protocol을 설정해야한다. 이를 수행하는 가장 간단한 방법은 Amazon SES와 같은 SMTP 서비스 공급자 중 하나를 사용하는 것입니다.)

AUTH_USER_MODEL을 설정한 후 마침내 마이그레이션을 생성하고 적용할 수 있다.

API

마지막으로 할 일은 urls.py에서 사용자를 처리하기 위해 allauth 및 rest_auth 끝점을 포함하는 것이다.

from allauth.account.views import confirm_email
from django.conf.urls import url
from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    url(r'^rest-auth/', include('rest_auth.urls')),
    url(r'^rest-auth/registration/', include('rest_auth.registration.urls')),
    url(r'^account/', include('allauth.urls')),
    url(r'^accounts-rest/registration/account-confirm-email/(?P<key>.+)/$', confirm_email, name='account_confirm_email'),
]

위에 포함되는 내용은 아래와 같습니다.

user 등록

POST /rest-auth/registration/

{
  "email": "test@test.com",
  "password1": "ujmik,ol.",
  "password2": "ujmik,ol."
}

user 로그인

• 사용자가 이메일을 확인하기 전에 로그인이 거부되어있다.

POST /rest-auth/login/

{
  "email": "test@test.com",
  "password": "ujmik,ol."
}

user 로그아웃

POST /rest-auth/logout/

password 변경

POST /rest-auth/password/change/

{
  "new_password1": ".lo,kimju",
  "new_password2": ".lo,kimju"
}

로그인된 유저 정보

GET /rest-auth/user/

커스텀 유저 serializer

만약 현재 로그인한 사용자를 GET할 때 응답을 확인하려면 아래와 같이 한다.

{
  "pk": 1,
  "username": null,
  "email": "test@test.com",
  "first_name": "",
  "last_name": ""
}

위와 같이 사용자 이름 필드는 여전히 존재하고 추가 필드는 포함되어 있지 않다. 이는 기본 사용자 serializer가 사용되고 있기 때문이다. 해결하기 위한 방법은 rest_auth를 사용하는 것이다.

user 폴더에 serializers.py 를 만든다.

from rest_framework import serializers

from users.models import CustomUser


class UserSerializer(serializers.ModelSerializer):

    class Meta:
        model = CustomUser
        fields = ['id', 'email', 'first_name', 'last_name', 'spouse_name', 'date_of_birth']

settings.py에 내용을 추가한다.

REST_AUTH_SERIALIZERS = {
    'USER_DETAILS_SERIALIZER': 'users.serializers.UserSerializer',
}