はじめに

Reactチュートリアルを終えたので初学者レベルから少しステップアップしたポートフォリオを作るために、React+Djangoでアプリを作ろうと思いそのためにDjango Rest Frameworkが必要だと感じたものの、いきなり使うにはやや危なそうだったので一旦仕組みを押さえておこうとチュートリアルを始めたのでその時にとったメモです。

シリアライズ

なぜ必要なのか？

フロント部分とサーバー部分でやり取りするにはAjaxなどを始めとした仕組みがあるが、結局の所JSONデータでのやり取りになる。
フロントからサーバーへデータを渡す際にはJSONデータが渡されるのでこれをサーバーで読めるように変換しなければならない。
逆にサーバーからフロント側に渡すにはクエリセットからJSONへと変換してやらないといけない。
そのための作業がシリアライズである。
実際にはシリアライズしたものやシリアライズ前のJSONデータをJsonResponseやJSONParserを使って変換してやり取りを行う。

仕組み

話としては難しいわけではなく、要はあるModelに対してそれをシリアライズしたModelを作るようなイメージである。
そのために用いるのがSerializerクラス及びその派生クラスであるModelSerializerクラスである。
例えば以下のようなSnippetモデルに対して、SnippetSerializerクラスを作ればいいということ。

Snippet


class Snippet(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    title = models.CharField(max_length=100, blank=True, default='')
    code = models.TextField()
    linenos = models.BooleanField(default=False)
    language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)
    style = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)

    class Meta:
        ordering = ['created']

SnippetSerializer


class SnippetSerializer(serializers.Serializer):
    id = serializers.IntegerField(read_only=True)
    title = serializers.CharField(required=False, allow_blank=True, max_length=100)
    code = serializers.CharField(style={'base_template': 'textarea.html'})
    linenos = serializers.BooleanField(required=False)
    language = serializers.ChoiceField(choices=LANGUAGE_CHOICES, default='python')
    style = serializers.ChoiceField(choices=STYLE_CHOICES, default='friendly')

    def create(self, validated_data):
        """
        Create and return a new `Snippet` instance, given the validated data.
        """
        return Snippet.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """
        Update and return an existing `Snippet` instance, given the validated data.
        """
        instance.title = validated_data.get('title', instance.title)
        instance.code = validated_data.get('code', instance.code)
        instance.linenos = validated_data.get('linenos', instance.linenos)
        instance.language = validated_data.get('language', instance.language)
        instance.style = validated_data.get('style', instance.style)
        instance.save()
        return instance

SnippetSerializerクラスを見ればわかるが、Modelのどのフィールドをシリアライズの対象とするのかというのを明示するように定義している。
フィールドに対する属性値の指定はレンダリング時にシリアライズされたものがどのように表示されるのかということを表している。(ex. code = serializers.CharField(style={'base_template': 'textarea.html'}))
また、create()およびupdate()はserializer.save()が呼び出されたときのようにモデルのインスタンスが作成、及び更新されるときに呼び出されるメソッドである。
そして、これらを以下のようにより簡素に書けるようにしたのがModelSerializerクラスである。

ModelSerializer


class SnippetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Snippet
        fields = ['id', 'title', 'code', 'linenos', 'language', 'style']

これだけで先程のSnippetSerializerと同じ働きができる。

Viewを作る

あとはここまで作ったものをフロントにどう渡すかを書けば簡素ではあるが一応完了となる。
引き続きチュートリアルから一例を見てみる。


@csrf_exempt
def snippet_list(request):
    """
    List all code snippets, or create a new snippet.
    """
    if request.method == 'GET':
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return JsonResponse(serializer.data, safe=False)

    elif request.method == 'POST':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data, status=201)
        return JsonResponse(serializer.errors, status=400)

例えばこれは一覧表示をするためのViewである。
リクエストがGETなのかPOSTなのかで処理を分けているのがわかる。
GETの場合はデータを取得するだけなので、DBから取得したものをシリアライズし、JsonResponseでフロントへ渡している。
POSTの場合はデータの更新が入る可能性まずリクエストをJSONで扱えるようにパースをし、それをシリアライズしJsonResponseをreturnする。
あとはreturnされてきたのをサーバー側でクエリセットなどに変換してDBへアクセスするということになる。

次は詳細表示のViewも見てみる。


@csrf_exempt
def snippet_detail(request, pk):
    """
    Retrieve, update or delete a code snippet.
    """
    try:
        snippet = Snippet.objects.get(pk=pk)
    except Snippet.DoesNotExist:
        return HttpResponse(status=404)

    if request.method == 'GET':
        serializer = SnippetSerializer(snippet)
        return JsonResponse(serializer.data)

    elif request.method == 'PUT':
        data = JSONParser().parse(request)
        serializer = SnippetSerializer(snippet, data=data)
        if serializer.is_valid():
            serializer.save()
            return JsonResponse(serializer.data)
        return JsonResponse(serializer.errors, status=400)

    elif request.method == 'DELETE':
        snippet.delete()
        return HttpResponse(status=204)

ここでも同様にGETかPUT(データが存在すれば更新、なければ新規作成)かDELETEとでリクエストを判定し、処理を分けている。