Django - REST framework - 001 - 序列化

参考资料：官方文档

介绍

该教程将为你演示如何构建一个相似于pastebin的代码高亮的web API。
在这个过程当中，咱们将会向你介绍构成REST framework的各类组件，并帮助你更深入的理解它是怎样工做的。

构造一个新的环境

首先，咱们使用virtualenv构建一个新的虚拟环境。它可使咱们的包配置与其余正在使用的项目很好的隔离。

virtualenv env
source env/bin/activate
复制代码

如今咱们在virtualenv环境中，能够安装咱们的包需求了。

pip install django
pip install djangorestframework
pip install pygments  # We'll be using this for the code highlighting
复制代码

开始

Okay，如今咱们能够开始了 首先，新建一个项目。

cd ~
django-admin startproject tutorial
cd tutorial
复制代码

而后新建一个app。咱们将基于这个app构建Web api。

python manage.py startapp snippets
复制代码

将新的app snippets 和 rest_framework app 添加到 INSTALLED_APPS中。 编辑tutorial/settings.py 文件，添加如下内容:

INSTALLED_APPS = (
    ...
    'rest_framework',
    'snippets.apps.SnippetsConfig',
)
复制代码

建立一个model

接下来，咱们将建立一个简单的 Snippet 模型，用来存储code片断。编辑 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',)
复制代码

咱们还须要为snippet model建立一个初始化的migration，而后与数据库关联并同步。

python manage.py makemigrations snippets
python manage.py migrate
复制代码

新建一个Serializer class

构造Web API，第一件事情就是提供一个为snippet 实例序列化和反序列化的方法，好比将它序列化为json。
咱们能够经过声明一个serializers来达成目的，这种方式和Django's forms很相似。
在snippets 路径下，建立文件 serializers.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
复制代码

SnippetSerializer class中的第一部分定义了有哪些字段须要被序列化/反序列化。
方法 create() 和 update() 定义了当调用**serializer.save()**方法时，serializer应该怎样构造实例。
一个serializer class 和Django 的Form class是很类似的。这其中包括一些校验标志也是很类似的，好比：required, max_length 和 default等。
这些字段标志能够控制特定情形下serializer的表现，好比应该在何时渲染HTML。
配置 {'base_template': 'textarea.html'} 字段和在Django Form class上使用 widget=widgets.Textarea 是等价的。
这对于控制 browsable API 应该怎样表现是很是有用的，这一点在后面的教程中也能够看到。
咱们也能够直接使用 Model Serializer class来节省咱们的时间，它的具体用法，在教程后面的部分将会有介绍。如今咱们先使用定制化的serializer。

使用 serializer

在更近一步以前，咱们先来熟悉一下Serializer class。键入命令，进入Django shell环境：

python manage.py shell
复制代码

导入一些必要的依赖，而后构建两个snippet实例。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser

snippet = Snippet(code='foo = "bar"\n')
snippet.save()

snippet = Snippet(code='print("hello, world")\n')
snippet.save()
复制代码

如今，咱们得到了两个snippet的实例对象，能够操做。让咱们先来把其中一个实例化。

serializer = SnippetSerializer(snippet)
serializer.data
# {'id': 2, 'title': '', 'code': 'print("hello, world")\n', 'linenos': False, 'language': 'python', 'style': 'friendly'}
复制代码

以看到，咱们已经将snippet实例转化成了Python原生数据类型。进一步将数据转化成 json。

content = JSONRenderer().render(serializer.data)
content
# b'{"id": 2, "title": "", "code": "print(\\"hello, world\\")\\n", "linenos": false, "language": "python", "style": "friendly"}'
复制代码

反序列化的过程和序列化过程是类似的。首先咱们将一个流解析成Python原始数据类型...

import io
stream = io.BytesIO(content)
data = JSONParser().parse(stream)
复制代码

而后将数据存储成一个对象实例。

serializer = SnippetSerializer(data=data)
serializer.is_valid()
# True
serializer.validated_data
# OrderedDict([('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])
serializer.save()
# <Snippet: Snippet object>
复制代码

注意这些API的工做方式和Django forms是很是类似的。当咱们开始编写视图代码的时候，会更加体会到这种类似性。
咱们也能够将一个查询集合进行序列化。只须要添加many=True 字段做为serializer的参数。

serializer = SnippetSerializer(Snippet.objects.all(), many=True)
serializer.data
# [OrderedDict([('id', 1), ('title', ''), ('code', 'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 2), ('title', ''), ('code', 'print("hello, world")\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title', ''), ('code', 'print("hello, world")'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])]
复制代码

使用 ModelSerializer

SnippetSerializer class 复制了大量的信息，这些信息一样存在于Snippet模型中。若是可让咱们的代码再简洁一点，就更好了。
与Django 提供了Form classes 和 ModelForm classes同样， REST framework 也提供了Serializer classes, 和 ModelSerializer classes。
让咱们使用ModelSerializer class 重构序列化的过程。 编辑文件snippets/serializers.py，使用如下内容代替原来的SnippetSerializer class：

class SnippetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Snippet
        fields = ('id', 'title', 'code', 'linenos', 'language', 'style')
复制代码

序列化的一个很大的好处就在于，可让你经过打印它来查看这个对象实例的全部字段。打开 Django shell， python manage.py shell，尝试如下操做：

from snippets.serializers import SnippetSerializer
serializer = SnippetSerializer()
print(repr(serializer))
# SnippetSerializer():
# id = IntegerField(label='ID', read_only=True)
# title = CharField(allow_blank=True, max_length=100, required=False)
# code = CharField(style={'base_template': 'textarea.html'})
# linenos = BooleanField(required=False)
# language = ChoiceField(choices=[('Clipper', 'FoxPro'), ('Cucumber', 'Gherkin'), ('RobotFramework', 'RobotFramework'), ('abap', 'ABAP'), ('ada', 'Ada')...
# style = ChoiceField(choices=[('autumn', 'autumn'), ('borland', 'borland'), ('bw', 'bw'), ('colorful', 'colorful')...
复制代码

其实，ModelSerializer classes 并无作什么特殊的事情，它只是提供了建立一个序列化类的替代和简写方式：

• 自动肯定的字段集。
• 简单的默认的create() and update() 方法实现。

使用Serializer编写常规的 Django视图

下面，咱们将使用新的Serializer class来编写一些API。 咱们暂时不会使用REST framework 的任何其余特性，只是编写一个常规的Django 视图。
编辑文件 snippets/views.py ，并添加下列内容：

from django.http import HttpResponse, 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
复制代码

API的目的是构造一个视图，能够支持列举和新建snippet对象。

@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)
复制代码

注意到若是在用户端没有CSRF token的状况下，使用POST方法，须要将咱们的视图添加一个装饰器 csrf_exempt。
这并非正确和常规的作法，这里只是为了提供演示。事实上，REST framework 视图提供了灵敏的安全校验功能供使用。
咱们还须要建立一个视图用户对单个snippet对象的检索、更新和删除操做。

@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)
复制代码

最后咱们须要配置路由，新建文件snippets/urls.py：

from django.urls import path
from snippets import views

urlpatterns = [
    path('snippets/', views.snippet_list),
    path('snippets/<int:pk>/', views.snippet_detail),
]
复制代码

同时，咱们须要在项目根域目录下配置文件tutorial/urls.py，引入snippet app的URL配置。

from django.urls import path, include

urlpatterns = [
    path('', include('snippets.urls')),
]
复制代码

上面的示例中，有许多边界状况并无处理，这并不影响咱们将基本面展现给你。
若是咱们发送一个非预期的json字符串，或者接收到了一个并不支持的请求，将会返回一个500 "server error" 的响应。

测试 Web API

如今咱们将启动一个简单的server，
首先退出shell...

quit()
复制代码

而后启动一个 Django server

python manage.py runserver

Validating models...

0 errors found
Django version 1.11, using settings 'tutorial.settings'
Development server is running at http://127.0.0.1:8000/
Quit the server with CONTROL-C.
复制代码

在另外一个终端窗口中，咱们来测试咱们的服务。
测试工具，能够选用curl 或者 httpie。Httpie 是一个用Python编写的用户友好的http库。执行命令安装：

pip install httpie
复制代码

最后，咱们能够得到snippets的列表：

http http://127.0.0.1:8000/snippets/

HTTP/1.1 200 OK
...
[
  {
    "id": 1,
    "title": "",
    "code": "foo = \"bar\"\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  },
  {
    "id": 2,
    "title": "",
    "code": "print(\"hello, world\")\n",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  }
]
复制代码

或者咱们能够经过指定id来检测特定的snippet实例详情：

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"
}
复制代码

你将会看到一个json格式的响应数据，像你在浏览器里直接访问接口看到的同样。

小结

到目前为止，咱们进展的一切顺利。咱们已经体验了相似于 Django's Forms API的序列化和反序列化的方法，还有视图的基本状况。 咱们的API views并无作什么特殊的事情，只是提供了一个json响应，而且还有一些对临界的错误和异常并无处理，但它已经具有了一个接口的基本功能了。