[DRF] Serializers 개념

🧙  이번 포스팅은 DRF의 Serializers 개념에 대해 알아 보도록 하겠습니다.

 

참고로 모든 내용은 https://www.django-rest-framework.org/api-guide/serializers/ 페이지에 다 있습니다. 

 

✅ DRF의 처리 과정은 간략하게 다음과 같이 3단계로 이루어 집니다.

 

1. data를 DB로 부터 가져온다.

2. Serialize 합니다.

3. 클라이언트에게 response합니다.

 

그래서 우리는 2번 "Serialize 합니다."를 분석 파악을 해보는 시간을 가지겠습니다.

 

아래와 같이models와 Serializer이 있다고 가정하겠습니다.

✍ Comment / models.py

class Comment(models.Model):
    post = models.ForeignKey(Post, on_delete=models.CASCADE, blank=True, null=True)
    content = models.TextField('CONTENT')
    create_dt = models.DateTimeField('CREATE DT', auto_now_add=True)
    update_dt = models.DateTimeField('UPDATE DT', auto_now=True)

 여기  Country라는 모델이 있습니다.

 

✍ Comment  / serializers.py

class CommentSerializer(serializers.ModelSerializer):
    class Meta:
        model = Comment
        fields = '__all__'

그리고 CommentSerializer를 ModelSerializer로 선언합니다.

Comment.objects.all()
<QuerySet [<Comment: 첫번째 댓글 입니다>, <Comment: 두번째 댓글 입니다>,
    <Comment: 마스크 벗고 운동하>, <Comment: 댓글 생성 테스트 >, 
    <Comment: 오랜만에 나이키 운>, <Comment: CSRF Token>, <Comment: ensure_csr>,
    <Comment: API 를 보기 위>, <Comment: DRF 로 댓글 생>, <Comment: CreateAPIV>, 
    <Comment: Create for>,<Comment: comment te>, <Comment: ASD>, <Comment: SDF>]>

 

먼저 Comment를 DB로 부터 조회해 봅니다.

 

이후 하나의 데이터를 뽑아 와서 Serializer에 넣습니다.

 

🐇 직렬화

c0 = Comment.objects.all()[0]
sr = CommentSerializer(instance=c0)
sr.data
	{'id': 1, 'content': '첫번째 댓글 입니다.', 'create_dt': '2021-07-28T07:06:54.974180', 'update_dt': '2021-07-28T07:06:54.974180', 'post': 3}

 

위 코드의 c0은 QuerySet 입니다. -> Serializer(instance) 넣고 -> Serializer.data => Ditc 변환

꼭 Serializer는 🤜 Instance에다 넣어야 직렬화를 합니다. 

 

역직렬화를 할 때는 나중에 언급이 되지만 🤜 data에 Dict를 넣습니다.

 

data = sr.data

type(data)
	rest_framework.utils.serializer_helpers.ReturnDict

Serializer.data를 type 함수에 넣고 type을 알아 본다면 ReturnDict라고 나와 있습니다.

ReturnDict는 DRF에서 기능을 좀더 추가한 Dict라고 보시면 됩니다.

 

from rest_framework.renderers import JSONRenderer
JSONRenderer().render(data)
	b'{"id":1,"content":"\xec\xb2\xab\xeb\xb2\x88\xec\xa7\xb8 \xeb\x8c\x93\xea\xb8\x80 \xec\x9e\x85\xeb\x8b\x88\xeb\x8b\xa4.","create_dt":"2021-07-28T07:06:54.974180","update_dt":"2021-07-28T07:06:54.974180","post":3}'  

json0 = JSONRenderer().render(data)

type(json0)
	bytes

 

클라이언트에게 byte를 보내야 하므로 Renderer 클레스를 받아 Python Dict를 byte로 변환 합니다.

변환한 데이터를 json0이라는 변수에 담습니다.

🐢역 직렬화

 

반대로 클라이언트가 서버에게 byte를 주는 경우는 아래와 같이 Parser로 풀어서 JSON으로 변형 시켜야 합니다.

 

from rest_framework.parsers import JSONParser
from io import BytesIO
data0 = JSONParser().parse(BytesIO(json0)
print(data0)

    {'id': 1,
     'content': '첫번째 댓글 입니다.',
     'create_dt': '2021-07-28T07:06:54.974180',
     'update_dt': '2021-07-28T07:06:54.974180',
     'post': 3}

Byte 데이터를 읽을 때에는 BytesIO라는 클레스를 받아 읽어야 합니다.

 

마지막 단계인 Dict를 Serializer로 바꿔보는 실습을 해보겠습니다.

 

drs = CommentSerializer(data = data0)

drs.is_valid()
Out[26]: True

drs.errors
Out[27]: {}

drs.validated_data
Out[29]: 
OrderedDict([('content', '첫번째 댓글 입니다.'),
             ('post', <Post: 유럽 여행 중 파리 개선문 다녀 왔답니다.>)])
             
# 변환된 Dict를 Insert하기
instance = Comment(**drs.validated_data)
instance.save()

is_valid()를 꼭 하셔야 합니다. 이 함수는 Serializer에 유효성 검사를 해 주는 역확을 합니다.

errors 프로프티는 에러 내용을 리턴해 주는 함수 입니다.

 

유효성 검사가 끝난 데이터는 우리가 자주 봐왔던 OrderDict로 반환이 됩니다.

변환된 OrderDict를 Model.Comment로 받아 Insert를 해주면 

 

직렬화, 역직렬화 실습이 종료가 됩니다.