教程1--序列化

教程1：序列化

引言

这部分内容，如果以前使用过Django的同学应该好理解，如果没有也没关系。
我建议大家在阅读时同步的去看API文档关于序列化器的部分，结合起来，就很容易理解了。
在操作中我也遇到了一些问题，会列出在下面，供大家参考。

设置环境

virtualenv env
source env/bin/activate
pip install django
pip install djangorestframework
pip install pygments  # We'll be using this for the code highlighting

创建项目

cd ~
django-admin.py startproject tutorial
cd tutorial

python manage.py startapp snippets

在settings.py中设置安装APP:

INSTALLED_APPS = (
    ...
    'rest_framework',
    'snippets.apps.SnippetsConfig',
)

创建Model

编辑snippets/models.py文件。

from django.db import models
from pygments.lexers import get_all_lexers
from pygments.styles import get_all_styles

LEXERS = [item for item in get_all_lexers() if item[1]]
LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS])
STYLE_CHOICES = sorted((item, item) for item in get_all_styles())


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',)

然后我们需要执行下列语句来同步数据库：

python manage.py makemigrations snippets
python manage.py migrate

注意：
这里遇到了一个问题：
我在虚拟环境中已经安装好所有所需的库。但是在makemigrations时，死活都说我没有安装pygments，很纳闷。我是这样输入的：

manage makemigrations

后来我发现如果在pycharm里操作，貌似就没问题。于是就想是不是和环境变量有关的问题，试着在终端输入了：

python manage.py makemigrations

果然问题解决~！看来直接输入manage读取到的应该不是当前目录的manage.py，而是不属于虚拟环境的环境变量。

创建序列化器

from rest_framework import serializers
from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES


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

看着代码很多，实际上设置其实都很眼熟。
当调用序列化器的save()方法时，REST框架会根据实例是否存在来判断调用create()还是调用update()。

使用序列化器创建常规的Django视图

# coding=utf-8
from django.http import HttpResponse
from django.http import JsonResponse
from django.views.decorators.csrf import csrf_exempt
from rest_framework.parsers import JSONParser

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


@csrf_exempt
def snippet_list(request):
    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)


@csrf_exempt
def snippet_detail(request, pk):
    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)
        # 如果需要更新（调用update方法），则需要传入一个已经存在的模型实例！
        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)

记得要配置urls.py：

from django.conf.urls import url

from snippets import views

urlpatterns = [
    url(r'^snippets/$', views.snippet_list),
    url(r'^snippet/(?P<pk>[0-9]+)/$', views.snippet_detail)
]

测试

测试用什么工具都行，postman，浏览器都很方便，这里介绍一个python写的http客户端——httpie。

pip install httpie

使用很简单：

http http://127.0.0.1:8000/snippets/2/

HTTP/1.1 200 OK
...
{
  "id": 2,
  "title": "",
  "code": "print \"hello, world\"\n",
  "linenos": false,
  "language": "python",
  "style": "friendly"
}

结语

我们使用序列化器创建了视图，运行的也挺好，没啥问题。但是我们花了很多代码去处理错误，这些通常都是相同的逻辑，我们能不能简化这一部分代码呢？
后面的章节会讲解。