[TIL]KDT_20230426

📚 KDT WEEK 4 DAY 2 TIL

• Serializer
  • ModelSerializer
• HTTP Methods
  • GET
  • POST
  • PUT, DELETE
• APIView

 

---

 

🟥 Serializer

다음의 두 기능을 수행하는 기능

Serialize : 모델 인스턴스나 QuerySet 데이터를 JSON 형식의 파일로 변환하는 작업

Deserialize : JSON 형식의 데이터를 모델 인스턴스로 변환하는 작업

 

다시말해, Serializer는 우리가 Django에서 사용하는 파이썬 객체나 쿼리셋 같이 복잡한 객체들을 Rest API에서 사용할 간단한 JSON 형태로 변환해주는 기능이다!

Rest API : 자원을 이름으로 구분하여 해당 자원의 상태를 주고 받는 모든 것(CRUD)

DRF : Django REST Framework

 

 

Question 모델 Serializer 구현하기

polls_api/serializer.py

from rest_framework import serializers
from polls.models import Question

class QuestionSerializer(serializers.Serializer):
    id = serializers.IntegerField(read_only=True) # read_only를 넣어 자동으로 생성되는 속성은 읽기 전용으로 만듦
    question_text = serializers.CharField(max_length=200)
    pub_date = serializers.DateTimeField(read_only=True)

    def create(self, validated_data): # validated인 이유는 serializer가 is_valid()를 먼저 수행해야 하기 때문
        return Question.objects.create(**validated_data)

	# id와 pub_date는 자동으로 생성되므로 question_text만 작성하면 된다.
    def update(self, instance, validated_data):
        instance.question_text = validated_data.get('question_text', instance.question_text)
        instance.save()
        return instance

• 모델에서 속성을 정의했던 것처럼 타입에 맞는 필드와 제한 조건을 적어야 한다.
• serializer는 넘어온 data가 제한 조건 등을 만족했는지를 항상 먼저 체크하기 위해 .is_valid()를 동작해야한다.
  
  • 이 부분은 밑에서 더 설명하겠다.
• 자동으로 생성되는 속성은 제한 조건에 read_only 조건을 꼭 명시해야 한다.

 

이걸 Shell에서 실제로 Serializer가 동작하는지 체크해봤다.

 

먼저 데이터 하나를 Serialize 해보는 실습이다.

# 관련 함수를 모두 import했고, q는 Question의 한 오브젝트라고 가정한다.
>>> q
<Question: 제목: 휴가를 어디서 보내고 싶으세요?, 날짜: 2023-04-24 08:15:31+00:00>

>>> serializer = QuestionSerializer(q)
>>> serializer.data
{'id': 1, 'question_text': '휴가를 어디서 보내고 싶으세요?', 'pub_date': '2023-04-24T08:15:31Z'}

>>> json_str = JSONRenderer().render(serializer.data)
>>> json_str
b'{"id":1,"question_text":"\xed\x9c\xb4\xea\xb0\x80\xeb\xa5\xbc \xec\x96\xb4\xeb\x94\x94\xec\x84\x9c \xeb\xb3\xb4\xeb\x82\xb4\xea\xb3\xa0 \xec\x8b\xb6\xec\x9c\xbc\xec\x84\xb8\xec\x9a\x94?","pub_date":"2023-04-24T08:15:31Z"}'

아까 작성했던 QuestionSerializer를 통해 오브젝트 q를 출력해보면, Dict 타입의 데이터가 나온다. >  JSON 타입

JSONRenderer로 이 serializer 데이터를 렌더링하면, 컴퓨터에 저장할 수 있는 타입인 string 형태로 바뀌어진다.

 

여기까지가 Serialize 수행이다!

 

다음으로 Deserialize을 수행해보면..

>>> import json
>>> data = json.loads(json_str)
>>> data
{'id': 1, 'question_text': '휴가를 어디서 보내고 싶으세요?', 'pub_date': '2023-04-24T08:15:31Z'}

>>> serializer = QuestionSerializer(data=data)
>>> serializer.is_valid()  
True

>>> serializer.validated_data 
OrderedDict([('question_text', '휴가를 어디서 보내고 싶으세요?')])

>>> new_question = serializer.save() # Create
>>> new_question
<Question: 제목: 휴가를 어디서 보내고 싶으세요?, 날짜: 2023-04-24 08:15:31+00:00>

>>> data={'question_text': '제목수정'}
>>> serializer = QuestionSerializer(new_question, data=data) 
>>> serializer.is_valid()  
True

>>> serializer.save() # Update
<Question: 제목: 제목수정, 날짜: 2023-04-26 15:23:55+00:00>

 

• json.loads()를 사용하여 string 타입을 다시 json으로 바꿔 줄 수 있다.
• QuestionSerializer에 데이터 인자를 하나 넣고, is_valid()한지 꼭 체크해줘야한다. (그래야 다음 동작이 가능하다)
• serializer는 특이하게 일반 Dict 형태가 아닌, 입력한 순서대로 저장하는 OrderedDict를 사용한다.
• .save()의 경우, QuestionSerializer의 인자로 무엇을 받았는지에 따라 Create와 Update을 구분한다!
• is_valid()에서 False를 받았을 경우, serializer.errors를 입력하여 어떤 에러인지 알 수 있다.

 

---

 

ModelSerializer

 

위에서 구현한 Serializer를 간단하게 구현할 수 있는 기능이다.

from rest_framework import serializers
from polls.models import Question

class QuestionSerializer(serializers.ModelSerializer):
    class Meta:
        model = Question
        fields = ['id', 'question_text', 'pub_date'] # ModelSerializer를 통해 자동으로 생성

아까 구현했던 코드보다 훨~씬 간단하고 쉽다.

ModelSerializer를 상속받고, Meta 클래스에 구현할 Model과 속성들을 입력해주기만 하면 된다.

물론 아까 Shell에서의 명령어를 모두 똑같이 수행한다.

 

---

🟦 HTTP Methods

주어진 리소스에 대해 수행하길 원하는 행동을 골라 보내야한다. 여기서 리소스는 Question, Choice 등을 말한다.

이 방법은 사용자의 입장에서 선택해야 한다!

• GET : 정보의 획득 ,특정 리소스를 요청할 때 > READ
• POST : 어떤 정보를 서버에 넘김, 무언가 새로운 데이터를 만들 때 쓰일 때 > CREATE
• PUT : 내용의 수정 요청 > UPDATE
• DELETE : 특정 리소스의 삭제

더 많은 Methods는 https://developer.mozilla.org/ko/docs/Web/HTTP/Methods 를 참고

 

---

GET

먼저, views.py에 GET을 구현해본다.

 

polls_api/views.py

from rest_framework.decorators import api_view
from polls.models import Question
from polls_api.serializers import QuestionSerializer
from rest_framework.response import Response

@api_view() # 괄호안이 비어있으면 GET
def question_list(request):
    questions = Question.objects.all()
    serializer = QuestionSerializer(questions, many=True) # many 옵션을 주면, questions처럼 여러개의 오브젝트를 줄수있음
    return Response(serializer.data)

@api_view 데코레이터를 사용하면 구현은 쉬운편이다. 기본적인 웹 인터페이스도 가지고있다.(DRF api)

 

views.py를 구현했으니 url을 연결해주어야 한다.

 

polls_api/urls.py에

path('question/',question_detail, name='question_detail'),

를 추가하고,

 

가장 상위 urls.py에

path('rest/', include('polls_api.urls')),

도 추가해준다.

 

이렇게 정의해주면, http://127.0.0.1:8000/rest/question/ 로 연결될 수 있을 것이다!

 

간단한 코드에도, 이렇게 편하게 기본 웹 인터페이스를 지원해준다.

 

---

POST

아까 GET의 views.py 코드에서 POST 부분만 추가해주었다.

from rest_framework.decorators import api_view
from polls.models import Question
from polls_api.serializers import QuestionSerializer
from rest_framework.response import Response
from rest_framework import status # HTTP status

@api_view(['GET','POST']) # 이번엔 POST도 필요하니, 필요한 방식을 모두 적어준다.
def question_list(request):
    if request.method == 'GET': # 사용한 방식에 따라 코드를 구분한다.
        questions = Question.objects.all()
        serializer = QuestionSerializer(questions, many = True)
        return Response(serializer.data)
    
    if request.method == 'POST':
        serializer = QuestionSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        else:
            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

크게 변한 점은 없다.

api_view에 POST를 사용할 것이라고 명시하고, 사용한 방식에 따라 코드를 나누었다.

POST 방식에서는 request를 통해 데이터를 받았을테니, 그 데이터를 통해 save 작업을 한다.

추가로 Response를 통해 HTTP status도 결과에 따라 처리해주었다.

 

같은 페이지 하단에 POST할 수 있는 부분이 생겼다! POST 버튼을 누르면, 새로운 질문이 생성된다.

 

---

 

PUT, DELETE

 

이번엔 아까 question/ 페이지에서 해당 id의 번호로 해당하는 detail 페이지까지 구현한다.

from django.shortcuts import get_object_or_404

@api_view(['GET', 'PUT', 'DELETE']) # 정보의 조회, 편집, 삭제 기능
def question_detail(request, id):
    question = get_object_or_404(Question, pk=id) # primary key 가 id인~

    if request.method == 'GET':
        serializer = QuestionSerializer(question)
        return Response(serializer.data) # question id로 요청받으면 데이터 뱉기
    if request.method == 'PUT':
        serializer = QuestionSerializer(question, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_200_OK)
        else:
            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
        
    if request.method == 'DELETE':
        question.delete()
        return Response(status=status.HTTP_204_NO_CONTENT) # 데이터가 잘 지워짐 204

GET, POST에서 구현한 views.py에 추가한 코드만 작성하였다.

새로운 페이지를 위해 새로운 함수를 만들었을 뿐, POST와 방식은 동일하다.

단, 각각의 HTTP Methods의 동작을 고려해서 QuestionSerializer에 넣을 인자 등을 생각하고 구현해야 한다.

+ 추가로 해당 id가 없을 때를 대비한 get_object_or_404 함수로 question을 가져오도록 변경하였다.

 

새로운 페이지를 위한 함수를 만들었으므로, urls.py에 새로운 path를 설정해주어야 한다.

    path('question/<int:id>/',question_detail, name='question_detail'),

 

Detail 페이지에 접속한 모습. PUT과 DELETE 버튼이 보인다!

 

---

 

🟨 APIView

방금 구현했던 HTTP Methods를 더욱 간단하게 구현하도록 지원하는 기능이다!

 

from rest_framework.views import APIView

# 각 HTTP Methods을 함수로 구별하여 구현한다.
class QuestionList(APIView):
    def get(self, request):
        questions = Question.objects.all()
        serializer = QuestionSerializer(questions, many=True)
        return Response(serializer.data)

    def post(self, request):
        serializer = QuestionSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

class QuestionDetail(APIView):
    def get(self, request, id):
        question = get_object_or_404(Question, pk=id) # primary key 가 id인~
        serializer = QuestionSerializer(question)
        return Response(serializer.data) # question id로 요청받으면 데이터 뱉기    
    
    def put(self, request, id):
        question = get_object_or_404(Question, pk=id)  
        serializer = QuestionSerializer(question, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_200_OK)
        else:
            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)   

    def delete(self, request, id):
        question = get_object_or_404(Question, pk=id) 
        question.delete()
        return Response(status=status.HTTP_204_NO_CONTENT) # 데이터가 잘 지워짐 204

아까와는 다르게 클래스로 구분하여 각 Methods를 함수로 구분하는 방법이다.

If 문으로 나누어 구분했던 것보다 훨씬 보기에 편한 것 같다!

두 코드를 비교해보면 알겠지만, 방식이 다를 뿐이지 코드 자체는 거의 비슷하다.

 

하지만 함수가 아니라 클래스로 구현했기 때문에, urls.py의 path를 수정해주어야 한다.

 

urlpatterns = [
    path('question/', QuestionList.as_view(), name='question-list'),
    path('question/<int:id>/', QuestionDetail.as_view(), name='question-detail'),
]

클래스의 경우, <클래스이름>.as_view() 의 방식을 사용해야한다!

 

---

Generics, mixins

 

방금 것보다 더 쉬운 구현 방법이 있다.

이제는 APIView가 아닌, generics와 mixins라는 프레임워크를 사용한다.

 

from polls.models import Question
from polls_api.serializers import QuestionSerializer
from rest_framework import mixins, generics

class QuestionList(mixins.ListModelMixin,mixins.CreateModelMixin,generics.GenericAPIView):
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

class QuestionDetail(mixins.RetrieveModelMixin, mixins.UpdateModelMixin, mixins.DestroyModelMixin,generics.GenericAPIView):
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer

    def get(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

    def put(self, request, *args, **kwargs):
        return self.update(request, *args, **kwargs)

    def delete(self, request, *args, **kwargs):
        return self.destroy(request, *args, **kwargs)

아까보다 더 간결해진게 눈에 보인다!

이 부분은 상속과 각 methods의 인자만 주의해주면 된다.

• .ListModelMixin : Queryset을 Listing하는 믹스인, 데이터를 목록 리턴한다.
• .CreateModelMixin : 모델 인스턴스를 생성하고 저장한다.
• .RetrieveModelMixin : 존재하는 모델 인스턴스를 리턴한다(하나)
• .UpdateModelMixin : 모델 인스턴스를 수정한다.
• .DestroyModelMixin : 모델 인스턴스를 삭제한다.

하지만 이걸 기억안해도 될만큼 더 간단한 방법이 있다..

 

---

 

Generic API View

from polls.models import Question
from polls_api.serializers import QuestionSerializer
from rest_framework import generics

class QuestionList(generics.ListCreateAPIView):
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer

class QuestionDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer

generics가 지원하는 API view를 상속받아 사용하면, 함수고 뭐고 구현할 필요가 없다.

queryset에 필요한 모델의 객체들과 Serializer만 잘 구현하여 입력해주면 된다.

 

얘네들도 상속받은 APIView에 따라 지원해주는 기능이 다른데, 이건 이름을 잘 확인하면 기능을 구별할 수 있다.

Ctrl + 클릭으로 해당 클래스를 누르면 generics.py를 확인할 수 있다.

여기서 필요한 클래스를 찾아 상속시켜주면 된다!

 

---

🤔 공부하면서 어려웠던 내용

솔직히 Serializer가 어떤 기능을 하는지 정말 알기 어려웠다.

여러 블로그를 찾아보며 대충 이해한 것 같긴한데.. 누가 물어보면 자신있게 대답은 못할 것 같다ㅋㅋㅋ😂