📒 [ TIL ] 2022.06.21_44일차 # Django Rest Framework (5)

[ 2022-06-21 (화) 오늘의 TIL ]

[ Today Learn ]

• validator
• custom validator

✏️ 내가 배운것, 얻은것

• serializer 심화
  serializer는 데이터 직렬화 외에도 data validation, create, update 기능을 사용할 수 있다.

• validator
  serializer에서는 기본적으로 Meta class 내부 field에 포함되어 있는 항목에 맞게 validate를 진행한다

🧩 적용 예시

# views.py
from user.serializers import UserSerializer

...

class UserView(APIView):
    def post(self, request):
        # serializer의 data 인자에는 model로 지정 된 테이블의 field:value를 dictionary로 넘겨준다.
        user_serializer = UserSerializer(data=request.data)
        # serializer validator를 통과하지 않을 경우 .is_valid()가 False로 return된다.
        if user_serializer.is_valid():
            # validator를 통과했을 경우 데이터 저장
            user_serializer.save()
            return Response({"message": "정상"}, status=status.HTTP_200_OK)
        
        # .errors에는 validator에 실패한 필드와 실패 사유가 담겨져 있다.
        return Response(user_serializer.errors, status=status.HTTP_400_BAD_REQUEST)

# sample request.data
"""
{
    "username": "new_user",
    "password": "MyL0ve1yP@ssw0rd",
    "fullname": "myname",
    "userprofile": {
        "introduction": "자기소개입니다.",
        "birthday": "2000-1-01",
        "age": 30
    },
    "trash": "zczxcvx"
}
"""

• serializer에서 사용 가능한 옵션들

🧩 적용 예시

class UserSerializer(serializers.ModelSerializer):
    # 외래 키 관계에 있는 필드의 required를 설정하고 싶을 경우 인자로 넘겨줘야 한다.
    userprofile = UserProfileSerializer(required=False) # default : True
    ...
    class Meta:
        ...
        # 각 필드에 해당하는 다양한 옵션 지정
        extra_kwargs = {
            # write_only : 해당 필드를 쓰기 전용으로 만들어 준다.
            # 쓰기 전용으로 설정 된 필드는 직렬화 된 데이터에서 보여지지 않는다.
            'password': {'write_only': True}, # default : False
            'email': {
                # error_messages : 에러 메세지를 자유롭게 설정 할 수 있다.
                'error_messages': {
                    # required : 값이 입력되지 않았을 때 보여지는 메세지
                    'required': '이메일을 입력해주세요.',
                    # invalid : 값의 포맷이 맞지 않을 때 보여지는 메세지
                    'invalid': '알맞은 형식의 이메일을 입력해주세요.'
                    },
                    # required : validator에서 해당 값의 필요 여부를 판단한다.
                    'required': False # default : True
                    },
            }

• view에서 사용 가능한 옵션들

🧩 적용 예시

# serializer의 인자에 object를 넣어 직렬화 된 데이터를 가져올 수 있다.
user = request.user
return Response(UserSerializer(user).data, status=status.HTTP_200_OK)

# object와 마찬가지로 queryset을 인자로 넣어 여러개의 직렬화 된 데이터를 가져올 수 있다.
hobbys = Hobby.objects.all()
# queryset을 인자로 넣을 경우 many=True 설정 필요하다.
return Response(HobbySerializer(hobbys, many=True).data, status=status.HTTP_200_OK)

# partial을 True로 설정할 경우 required field에 대한 validation을 수행하지 않는다.
# 주로 일부 필드를 update 할 때 사용된다.
user_serializer = UserSerializer(data=request.data, partial=True)

# raise_exception을 True로 설정할 경우 validation을 통과하지 못했을 때 exception을 발생시킨다.
user_serializer = UserSerializer(data=request.data, raise_exception=True)

• custom validator
  1) custom validator는 validator 이후에 동작한다.
  2) custom validator는 validator와 별개로 동작한다.
  3) validator는 데이터의 requierd, invalid 등을 판단하고 custom validator에서는 사용자가 원하는 validation을 추가로 검증 할 수 있다.

🧩 적용 예시

class UserSerializer(serializers.ModelSerializer):
    ...
    # validate 함수 선언 시 serializer에서 자동으로 해당 함수의 validation을 해줌
    def validate(self, data):
        # custom validation pattern
        if data.get("userprofile", {}).get("age", 0) < 12:
            # validation에 통과하지 못할 경우 ValidationError class 호출
            raise serializers.ValidationError(
                    # custom validation error message
                    detail={"error": "12세 이상만 가입할 수 있습니다."},
                )

        # validation에 문제가 없을 경우 data return
        return data

🌱 느낀 점

serializer를 배우면서 많은 기능들과 문법등을 살펴봤는데, 그동안 보지 못했던 기능 들이 많아서 한 번에 습득하는데에는 무리가 있는 것 같다. 앞으로 프로젝트를 진행하면서 필요한 부분마다 직접 찾아보면서 익숙해져야 할 것 같다. 그리고 계속 배우는 게 축적될때마다 소화해야 할 양이 많아지게 되면서 벅차기도 하지만, 계속 복습하고 많이 접해서 익숙해지는것만이 실력을 기를 수 있는 길이라고 생각한다.