DRF Tutorial 3: Class-based Views

함수 기반 뷰가 아닌 클래스 기반 뷰를 사용하여 API 뷰를 작성할 수도 있다. 이는 공통 기능을 재사용할 수 있고 코드를 깔끔하게 유지하는 데 도움이 되는 강력한 패턴이다.

클래스 기반 뷰를 사용하여 API 다시 작성하기

루트 뷰를 클래스 기반 뷰로 다시 작성하자. views.py를 약간 리팩터링 할 것이다.

# snippets/views.py

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from django.http import Http404
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status


class SnippetList(APIView):
    """
    List all snippets, or create a new snippet.
    """
    def get(self, request, format=None):
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    def post(self, request, format=None):
        serializer = SnippetSerializer(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)

 

함수기반 뷰와 비슷해 보이지만, 서로 다른 HTTP 메서드가 더 잘 분리되었다. 이제는 인스턴스 뷰를 업데이트하자.

# snippets/views.py

class SnippetDetail(APIView):
    """
    Retrieve, update or delete a snippet instance.
    """
    def get_object(self, pk):
        try:
            return Snippet.objects.get(pk=pk)
        except Snippet.DoesNotExist:
            raise Http404

    def get(self, request, pk, format=None):
        snippet = self.get_object(pk)
        serializer = SnippetSerializer(snippet)
        return Response(serializer.data)

    def put(self, request, pk, format=None):
        snippet = self.get_object(pk)
        serializer = SnippetSerializer(snippet, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk, format=None):
        snippet = self.get_object(pk)
        snippet.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

여전히 함수 기반 뷰와 매우 유사하다

 

클래스 기반 뷰를 사용하므로 snippets/urls.py를 약간 리팩터링해야 한다.

# snippets/urls.py

from django.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views

urlpatterns = [
    path('snippets/', views.SnippetList.as_view()),
    path('snippets/<int:pk>/', views.SnippetDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

개발 서버를 실행하면 모든 것이 이전과 똑같이 작동한다.

# 셸에 아래와 같이 입력하여 서버 실행하기

python3 manage.py runserver

 

mixins 사용

클래스 기반 뷰를 사용할 때의 큰 장점 중 하나는 쉽게 재사용이 가능하다는 것이다.

지금까지 사용했던 생성/조회/업데이트/삭제(CRUD:  create/retrieve/update/delete)작업은 모든 모델 기반 API 뷰에서 매우 유사할 것이다. 이러한 공통된 동작은 REST 프레임워크의 믹스인 클래스에서 구현된다.

믹스인 클래스를 사용하여 뷰를 구성하는 방법을 알아보자.

# snippets/views.py

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework import mixins
from rest_framework import generics

class SnippetList(mixins.ListModelMixin,
                  mixins.CreateModelMixin,
                  generics.GenericAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

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

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

여기서 정확히 무슨 일이 일어나고 있는지 살펴보자. GenericAPIView를 사용해 뷰를 빌드하고 ListModelMixin과 CreateModelMixin을 추가하였다. 베이스 클래스는 핵심 기능을 제공하고, 믹스인 클래스는 .list() 및 .create()를 제공한다. 그 다음 get 메서드와 post 메서드를 적절하게 바인딩한다.

 

class SnippetDetail(mixins.RetrieveModelMixin,
                    mixins.UpdateModelMixin,
                    mixins.DestroyModelMixin,
                    generics.GenericAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

    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)

여기에서도 핵심 기능을 제공하기 위해 GenericAPIView 클래스를 사용하고 .retrieve(), .update(), .destroy() 액션을 제공하기 위해 믹스인을 추가했다.

generic class-based views 사용

믹스인 클래스를 사용하여 전보다 적은 코드를 사용하도록 뷰를 재작성했지만 여기서 더 줄일 수 있다. REST 프레임워크는 이미 믹스인된 generic views 세트를 제공하므로 이를 사용하여 views.py 모듈을 훨씬 더 줄일 수 있다.

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework import generics


class SnippetList(generics.ListCreateAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer


class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

첫 클래스 뷰와 비교할 때 아주 짧고 간결한 코드만을 작성하였다.