序列化

我们的项目名称叫 tutorial ，包含一个 app 名为 myApp。首先我们编辑 tutorial/settings.py 文件，在 INSTALLED_APPS 部分添加以下内容：

INSTALLED_APPS = (
    ...
    'rest_framework',
    'myApp',
)

编辑 myApp/models.py 文件：

from django.db import models

class Book(models.Model):
    title = models.CharField(null=True, blank=True, max_length=50)
    author = models.CharField(null=True, blank=True, max_length=50)
    amount = models.IntegerField()

    def __str__(self):
        return self.title

---

创建一个序列化类

要实现一个 Web API ，我们需要将代码片段实例 序列化 和 反序列化 为诸如 json 之类的形式的方式。

该需求可以通过 序列化器（serializers）来实现，序列化器的使用与 Django forms 非常相似。

我们新建一个 myApp/serializers.py 文件，编写一个序列化器：

from rest_framework import serializers

class BookSerializer(serializers.Serializer):
    title = serializers.CharField(max_length=50)
    author = serializers.CharField(max_length=50)
    amount = serializers.IntegerField()

序列化器类与 Django Form 类非常相似，并在各种字段中包含类似的验证标志，例如 required，max_length 和 default。

我们实际上也可以通过使用 ModelSerializer 类来节省时间，就像我们后面会用到的那样。但是现在我们还继续使用我们明确定义的 serializer。

现在在 shell 中看看序列化器的用法：

>>> from myApp.models import Book
>>> from myApp.serializers import BookSerializer

>>> book = Book.objects.get(id=1)
>>> bs = BookSerializer(book)  # 序列化 book 的一个实例

>>> bs.data  # 查看序列化的信息
{'author': 'author1', 'title': 'book1', 'amount': 1}

此时，我们将序列化对象转换为比特流（bytes）：

>>> from rest_framework.renderers import JSONRenderer

>>> content = JSONRenderer().render(bs.data)
>>> content
b'{"title":"book1","author":"author1","amount":1}'

>>> type(content)

反序列化是类似的。首先我们将一个流（stream）解析为字典（dict）：

>>> from django.utils.six import BytesIO
>>> from rest_framework.parsers import JSONParser

>>> stream = BytesIO(content)
>>> data = JSONParser().parse(stream)

>>> data
{'author': 'author1', 'title': 'book1', 'amount': 1}

>>> type(data)

我们也可以序列化一个 查询集（querysets）而不仅仅是模型实例，我们只需要为 serializer 添加一个 many=True 语句：

>>> books = Book.objects.all()
>>> bs = BookSerializer(books, many=True)
>>> bs.data
[OrderedDict([('id', 1), ('title', 'book1'), ('author', 'author1'), ('amount', 1)]), 
OrderedDict([('id', 2), ('title', 'book2'), ('author', 'author2'), ('amount', 3)])]

---

使用 ModelSerializers

像 Django 的 Form 和 ModelForm 一样，REST framework 也包括 Serializer 和 ModelSerializer 。

使用 ModelSerializer 可以直接通过 Model 创建序列化器：

from rest_framework import serializers
from myApp.models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = ('id', 'title', 'author', 'amount')

---

简单 API 实例

我们先自定义一个 JSONResponse 类：

from django.http import HttpResponse
from rest_framework.renderers import JSONRenderer

class JSONResponse(HttpResponse):
    """
    自定义一个 JSONResponse 继承自 HttpResponse
    让数据渲染成 json 后再返回 Response
    并把 Response 的 content_type 属性改为 application/json
    """
    def __init__(self, data, **kwargs):
        content = JSONRenderer().render(data)
        kwargs['content_type'] = 'application/json'
        super(JSONResponse, self).__init__(content, **kwargs)

然后在 views.py 中编写试图函数（完整版）：

from django.shortcuts import render
from django.http import HttpResponse

from rest_framework.renderers import JSONRenderer
from rest_framework.parsers import JSONParser

from myapp.models import Book
from myapp.serializers import BookSerializer


class JSONResponse(HttpResponse):
    """
    自定义一个 JSONResponse 继承自 HttpResponse
    让数据渲染成 json 后再返回 Response
    并把 Response 的 content_type 属性改为 application/json
    """
    def __init__(self, data, **kwargs):
        content = JSONRenderer().render(data)
        kwargs['content_type'] = 'application/json'
        super(JSONResponse, self).__init__(content, **kwargs)


def all_books(request):
    all_books = Book.objects.all()
    all_books_json = BookSerializer(all_books, many=True)

    return JSONResponse(all_books_json.data)

编辑 tutorial/urls.py：

from myapp.views import all_books

urlpatterns = [
    ......
    url(r'^api/all', all_books, name="all_books"),
]

一个包含了全部 Book 实例的 API 就在这里：http://127.0.0.1:8000/api/all