[Django][DRF] ViewSets의 개념

현재 나는 장고와 리액트를 사용해 프로젝트를 개발 중이다.

백엔드를 장고로 구현하는 중, 여러 어려움들이 생겨 장고를 더 탄탄히 정리해 보고자 한다.

본 내용은 Django REST Framework 공식 문서를 번역한 글이다.

공식 문서를 번역하는 과정에서 문장이 매끄럽지 않을 수 있다. ^^;

---

Viewset

Django REST 프레임워크를 사용하면 ViewSet을 사용해 클래스 안에서 관련있는 뷰들에 대한 로직을 합칠 수 있다. 다른 프레임워크에서는 개념적으로 유사한 구현인 '리소스'나 '컨트롤러'와 유사한 개념이다.

ViewSet 클래스는 클래스 기반 View의 한 유형이고, .get()이나 .post() 같은 메서드 핸들러 대신 .list() 및 .create()를 제공한다.

ViewSet의 메서드 핸들러는 .as_view() 메서드를 사용하여 뷰를 끝내는 시점에만 해당하는 액션을 수행한다.

일반적으로, urlconf의 viewset에 뷰를 명시적으로 등록하는 대신, 자동으로 urlconf를 결정한 라우터 클래스에 viewset을 등록한다.

 

from django.contrib.auth.models import User
from django.shortcuts import get_object_or_404
from myapps.serializers import UserSerializer
from rest_framework import viewsets
from rest_framework.response import Response

class UserViewSet(viewsets.ViewSet):
    """
    A simple ViewSet for listing or retrieving users.
    """
    def list(self, request):
        queryset = User.objects.all()
        serializer = UserSerializer(queryset, many=True)
        return Response(serializer.data)

    def retrieve(self, request, pk=None):
        queryset = User.objects.all()
        user = get_object_or_404(queryset, pk=pk)
        serializer = UserSerializer(user)
        return Response(serializer.data)

 

 

user_list = UserViewSet.as_view({'get': 'list'})
user_detail = UserViewSet.as_view({'get': 'retrieve'})

 

필요하다면 클래스 선언 후 위 구문을 삽입하여 두 개의 뷰로 분리할 수 있다고 한다.

프로젝트 폴더 내의 urls.py 파일에

Viewset을 라우터와 함께 등록해, urlconf가 자동으로 생성될 수 있도록 해 준다.

 

 

from myapp.views import UserViewSet
from rest_framework.routers import DefaultRouter

router = DefaultRouter()
router.register(r'users', UserViewSet, basename='user')
urlpatterns = router.urls

 

 

 

class UserViewSet(viewsets.ModelViewSet):
    """
    A viewset for viewing and editing user instances.
    """
    serializer_class = UserSerializer
    queryset = User.objects.all()

 

위처럼 Viewset을 직접 만드는 대신에, 기본적으로 여러 메소드를 제공해 주는 클래스들을 사용할 수도 있다.

View 대신 Viewset을 사용하면......

1. 반복되는 로직을 하나의 클래스로 묶을 수 있다.
   위의 예시처럼, queryset을 한 번만 명시해 주면 되고 이후엔 다양한 뷰로 사용할 수 있다.
2. 라우터를 사용하면 URL을 수동으로 등록해 줄 필요가 없다.

참고: https://www.django-rest-framework.org/api-guide/viewsets/