DRF Tutorial 3 Class-based Views

시작

이번 포스트에서는 DRF(Django Rest Framework) 튜토리얼을 따라 Class-based Views을 다루는 방법을 알아보겠습니다. 본 포스트는 macOS와 VS Code 환경에서 진행됩니다.

본문

Class-based Views를 사용하여 API 재작성

Function-based Views에서 if request.method == 'GET'와 같은 분기 처리를 메서드로 분리하여 코드를 더욱 간결하고 효율적으로 만들 수 있습니다.

 

snippets/views.py를 Class-based Views를 활용하여 리팩터링 합니다.

from django.http import Http404
from rest_framework import status
from rest_framework.response import Response
from rest_framework.views import APIView  

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


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)

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)

 

Function-based Views와 달리 Class-based Views에서는 as_views()메서드를 사용하여 URL과 뷰를 연결해야 합니다.

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)

Mixins 사용하여 API 리팩토링

DRF에서는 기본적인 CRUD (생성, 검색, 업데이트, 삭제) 작업을 수행하기 위해 mixin 클래스를 제공합니다. 이 믹스인 클래스를 사용하면 반복되는 코드 작성 없이 뷰를 효율적으로 구성할 수 있습니다.

 

mixin클래스를 사용하여 snippets/views.py를 다시 리팩터링 합니다.

from rest_framework import generics, mixins

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


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)


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)

• ListModelMixin: .list() 메서드를 제공하여 객체 목록을 반환합니다.
• CreateModelMixin: .create() 메서드를 제공하여 새 객체를 생성합니다.
• RetrieveModelMixin: .retrieve() 메서드를 제공하여 단일 객체를 조회합니다.
• UpdateModelMixin: .update() 메서드를 제공하여 객체를 업데이트합니다.
• DestroyModelMixin: .destroy() 메서드를 제공하여 객체를 삭제합니다.

Generic class-based views 사용하여 API 리팩토링

Generic class-based views를 사용하면 더 간결하게 코드를 작성할 수 있습니다. 이 방법은 믹스인을 사용한 방법보다 코드가 더 간결해지고 가독성이 향상됩니다.

 

Generic class-based views를 사용하여 snippets/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

• ListCreateAPIView: ListModelMixin과 CreateModelMixin을 결합하여 목록 조회와 객체 생성을 처리합니다.
• RetrieveUpdateDestroyAPIView: RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin을 결합하여 객체 조회, 업데이트 및 삭제를 처리합니다.

마무리

DRF의 Class-based Views, mixins 및 generic class-based views를 사용하여 기존 코드를 리팩터링 하였습니다. 이러한 접근 방법으로 코드의 효율성과 유지보수성을 크게 향상할 수 있으며 코드의 간결성과 명확성을 높일 수 있습니다. 앞으로 DRF의 다양한 기능을 활용하여 코드의 품질을 더욱 높이고 효율적인 API 설계를 할 수 있을 것 같습니다.

참고자료

• https://www.django-rest-framework.org/tutorial/3-class-based-views/