[Django REST framework] (2) Serializer, Viewset, Router

지난 글

[Django REST framework] (1) 프로젝트 생성과 설정

 

 

 

Django REST framework를 이용해 개발할 때 등장하는 주요 컴포넌트에 대해서 이해하고 사용법을 알아보자.

Serializer

Serializers allow complex data such as querysets and model instances to be converted to native Python datatypes that can then be easily rendered into JSON, XML or other content types. Serializers also provide deserialization, allowing parsed data to be converted back into complex types, after first validating the incoming data.
Django REST framework API Guide - Serializer

Serializer는 이름에서 짐작할 수 있듯이 특정한 구조의 데이터(객체, Queryset 등)를 Python의 dictionary로 변환하는 기능(직렬화, Serialization)을 제공한다. 역으로 Python의 dictionary를 원래 구조의 데이터로 역변환하는(역직렬화, Deserialization) 기능도 제공한다.

Serializer 정의와 직렬화(Serialization)

게시글의 정보를 표현하는 Post라는 이름의 클래스가 있다.

class Post
    def __init__(self, title, content):
        self.title = title
        self.content = content

이 post 객체의 필드 title과 content를 통해 게시글의 제목과 내용 값을 이용할 수 있다.

>>> post = Post(title='This is post', content='Hello world!')
>>> post.title
'This is post'
>>> post.content
'Hello world!'

이를 직렬화하는 Serializer를 다음과 같이 정의할 수 있다.

from rest_framework import serializers

class PostSerializer(serializers.Serializer):
    title = serializers.CharField()
    content = serializers.CharField()

Serializer를 이용해 객체의 구조와 유사한 dictionary 객체를 얻을 수 있다. Serializer의 필드를 정의할 때 별다른 옵션이 없다면 동일한 필드 이름을 이용해 생성 시 전달된 객체(post)의 필드 값을 이용한다.

>>> serializer = PostSerializer(post)
>>> serializer.data
{'title': 'This is post', 'content': 'Hello world!'}

원래의 post 객체와 비교해보자. 필드 이름을 통해 값을 이용하던 객체와 유사한 구조의 dictionary를 얻을 수 있음을 확인할 수 있다.

>>> # post 객체
>>> post.title
'This is post'
>>> post.content
'Hello world!'
>>> # 직렬화된 데이터 (dictionary)
>>> serializer.data['title']
'This is post'
>>> serializer.data['content']
'Hello world!'

title과 content라는 동일한 이름의 필드를 이용할 수 있는 다음 Model의 인스턴스도 Serializer를 이용해 직렬화를 할 수 있다.

from django.db import models

class Post(models.Model):
    title = models.CharField(max_length=1024)
    content = models.TextField()

>>> post = Post.objects.create(title='This is post', content='Hello world!')
>>> serializer = PostSerializer(post)
>>> serializer.data
{'title': 'This is post', 'content': 'Hello world!'}

역직렬화(Deserialization)와 객체 저장

Serializer는 직렬화와 반대로 dictionary 객체를 이용해 원래의 객체를 얻어내는 역직렬화의 기능도 제공한다. 직렬화 과정과 달리 역직렬화를 위해선 Serializer를 생성할 때 data 인자로 dictionary 객체를 반드시 전달해야 한다. Serializer를 생성 한 뒤에는 is_valid()함수를 호출해 각 필드와 전체 데이터의 유효성을 검증 해야한다. validated_data는 객체의 생성, 저장, 수정 등의 작업에 이용되며, is_valid()함수를 통해 유효성을 검증하지 않으면 해당 작업을 진행할 수 없다. 즉 객체의 생성, 저장, 수정에 앞서 반드시 is_valid()함수를 호출해야 한다.

>>> post_data
{'title': 'This is post', 'content': 'Hello world!'}
>>> serializer = PostSerializer(data=post_data)
>>> serializer.is_valid()
True
>>> serializer.validated_data
{'title': 'This is post', 'content': 'Hello world!'}

객체의 생성과 저장을 위해서 create(), update()를 오버라이드 해야한다. 두 함수는 인자로 validated_data를 전달받는다. 이는 is_valid()함수를 통해 유효성이 모두 검증된 값의 dictionary이다. create()는 validated_data를 이용해 생성한 객체를 반환하도록, 그리고 update()는 validated_data를 이용해 instance를 수정한 뒤 반환하도록 정의한다.

class PostSerializer(serializers.Serializer):
    title = serializers.CharField()
    content = serializers.CharField()

    def create(self, validated_data):
        return Post(
            title=validated_data['title'],
            content=validated_data['content']
        )

    def update(self, instance, validated_data):
        instance.title = validated_data.get('title', instance.title)
        instance.content = validated_data.get('content', instance.content)
        return instance

Serializer는 Model과 함께 사용되는 경우가 많다. 아래를 위의 코드와 비교하자면 model manager를 이용해 model instance를 생성해 반환하는 부분, 수정 이후 save()를 이용해 적용한 부분이 추가되었다.

class PostSerializer(serializers.Serializer):
    title = serializers.CharField()
    content = serializers.CharField()

    def create(self, validated_data):
        return Post.objects.create(
            title=validated_data['title'],
            content=validated_data['content']
        )

    def update(self, instance, validated_data):
        instance.title = validated_data.get('title', instance.title)
        instance.content = validated_data.get('content', instance.content)
        isinstance.save()
        return instance

앞서 말했던 유효성 검사를 필드별로, 또한 객체 전체 수준에서 오버라이드할 수 있다. 특정 필드에 대한 유효성 검사를 오버라이드 하고자 한다면, validate_${field_name}(self, value)를 오버라이드하면 된다. 만약 제목(title)의 길이가 100 이하인 경우에 대해서만 유효하다 판정하고 싶다면 다음처럼 구현한다. 유효하다면 해당 값을 반환하고 그렇지 않다면 예외를 던지도록 구현한다.

def validate_title(self, value):
    if len(value) <= 100:
        return value
    raise ValueError('제목의 길이는 100이하여야 합니다.')

ViewSet

Django REST framework allows you to combine the logic for a set of related views in a single class, called a ViewSet
Django REST framework API Guide - Viewsets

ViewSet 역시 class-based view이나 HTTP method 기반의 핸들러를 제공하는 APIView와 달리 자원에 대한 동작 기반의 핸들러인 list, create, retrieve 등을 제공한다.

위의 예제에서 이용했던 Post model을 계속 이용하자.

from django.db import models

class Post(models.Model):
    title = models.CharField(max_length=1024)
    content = models.TextField

Post model을 생성, 조회하는 ViewSet은 다음처럼 정의한다.

from rest_framework.viewsets import ViewSet

class PostViewset(ViewSet):
    def create(self, request):
        serializer = PostSerializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        serializer.save()
        return Response(serializer.data)

    def list(self, request):
        queryset = Post.objects.all()
        serializer = PostSerializer(queryset, many=True)
        return Response(serializer.data)

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

ViewSet에서 제공하는 동작은 다음과 같다.

from rest_framework.viewsets import ViewSet

class PostViewset(ViewSet):
    def list(self, request):
        pass

    def create(self, request):
        pass

    def retrieve(self, request, pk=None):
        pass

    def update(self, request, pk=None):
        pass

    def partial_update(self, request, pk=None):
        pass

    def destroy(self, request, pk=None):
        pass

ViewSet에서 as_view 함수를 이용해 특정 view를 추출할 수 있다. HTTP method와 동작의 이름이 매핑된 dictionary를 인자로 전달한다.

post_list = PostViewset.as_view({'get': 'list', 'post': 'create'})
post_detail = PostViewset.as_view({'get': 'retrieve'})

위에서 추출한 view를 이용해 URLConf를 설정할 수 있다.

urlpatterns = [
    ...

    path('posts/', post_list),
    path('posts/<int:pk>', post_detail),

    ...
]

Router

ViewSet을 이용해 view를 추출하는 과정을 생각해보자. 자원에 대한 CRUD를 제공하는 API에 자주 등장하는 URL 패턴과 동작이 있음을 유추할 수 있다. 그리고 이러한 패턴에 맞추어 view와 URL 패턴을 기본으로 매칭해주는 편의 기능을 Router가 제공한다. 다음 두 코드는 동일한 동작을 수행한다.

from posts.views import PostViewSet

post_list = PostViewSet.as_view({
    'get': 'list',
    'post': 'create'
})
post_detail = PostViewSet.as_view({
    'get': 'retrieve',
    'put': 'update',
    'patch': 'partial_update',
    'delete': 'destroy'
})

urlpatterns = [
    path('posts/', post_list),
    path('posts/<int:pk>', post_detail),
]

from django.urls import include, path
from rest_framework.routers import DefaultRouter
from posts.views import PostViewSet

router = DefaultRouter()
router.register(r'posts', PostViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

REST framework 만을 이용한 간단한 예제

위에서 설명한 컴포넌트들은 일반적으로 Model과 함께 사용되는 경우가 많으며, Model을 이용해 해당 컴포넌트들을 정의할 때 자주 등장하는 패턴들이 미리 정의되었있다. 이를 이용해 아주 짧은 코드만으로도 원하는 기능의 API를 금방 구현할 수 있다.

위에서 사용했던 Post model에 CRUD를 할 수 있는 API를 작성해보자.

from django.db import models

class Post(models.Model):
    title = models.CharField(max_length=1024)
    content = models.TextField()

from rest_framework import serializers
from models import Post

class PostSerializer(serializers.ModelSerializer):
    class Meta:
        model = Post
        fiedls = ['id', 'title', 'content']

from rest_framework.viewsets import ModelViewSet
from posts.serializers import PostSerializer
from models import Post

class PostViewSet(ModelViewSet):
    queryset = Post.objects.all()
    serializer_class = PostSerializer

from django.urls import include, path
from rest_framework.routers import DefaultRouter
from posts.views import PostViewSet

router = DefaultRouter()
router.register(r'posts', PostViewSet)

urlpatterns = [
    path('', include(router.urls)),
]