DRF--シリアライズデモ

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

virtualenv env
source env/bin/activate
Now that we're inside a virtualenv environment, we can install our package requirements.

pip install django
pip install djangorestframework
pip install pygments  # We'll be using this for the code highlighting
注意: 想要退出虚拟环境，只需要键入 deactivate命令即可。更多信息可以参考 virtualenv documentation.

开始
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 文件，注意: 好的编码应该及时添加注释，关于这一点，你在我们的Github仓库上也可以看到。这里为了更好的关注代码本身，我们将注释先省略掉了。

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 应该怎样表现是非常有用的，这一点在后面的教程中也可以看到。

我们也可以直接使用 ModelSerializer 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格式的响应数据，像你在浏览器里直接访问接口看到的一样。