教程1：序列化

导言

本教程将介绍如何创建出简单的WebAPI（restful），粘连性好的代码。在此过程中，它将介绍组成REST框架的各种组件，并让您全面了解每件事是如何组合在一起的。

讲解几个术语：

api: API（Application Programming Interface，应用程序接口）是一些预先定义的函数，或指软件系统不同组成部分衔接的约定 [1] 。目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问原码，或理解内部工作机制的细节。

Api端点：API 端点通常是指在同一个接口中提供特定功能子集的服务提供者。不同的端点可以有不同的协议和不同的格式。

序列化：将pytho实例对象或者数据对象转换成json格式数据或者xml等

反序列化：序列化的逆过程。

新建新虚拟环境virtualenv

在进行其他操作之前，我们将创建一个新的虚拟环境，使用venv…这将确保我们的包配置与我们正在进行的任何其他项目保持很好的隔离。

python3 -m venv env
source env/bin/activate

现在我们在虚拟环境中，我们可以安装我们的包需求。

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

注：若要随时退出虚拟环境，只需键入deactivate…有关更多信息，请搜索python虚拟环境的使用.

开始

好了，我们准备好coding。为了开始，让我们创建一个新的项目来处理。

cd ~
django-admin startproject tutorial
cd tutorial

完成之后，我们就可以创建一个应用程序来创建一个简单的WebAPI。

python manage.py startapp snippets

我们需要增加我们的新snippets应用程序和rest_framework应用程序INSTALLED_APPS…让我们编辑tutorial/settings.py档案：

INSTALLED_APPS = [
…
‘rest_framework’,
‘snippets.apps.SnippetsConfig’,
]
好了，我们准备好了。

创建要使用的模型

为了本教程的目的，我们将首先创建一个简单的Snippet模型，用于存储代码段。继续编辑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

创建序列化程序类

我们需要从WebAPI开始的第一件事是提供一种将代码片段实例序列化和反序列化为表示形式的方法，如json…我们可以通过声明与Django的表单非常相似的序列化程序来做到这一点。在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

序列化程序类的第一部分定义了序列化/反序列化的字段。这个create()和update()方法定义在调用时如何创建或修改完全成熟的实例。serializer.save()

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

字段标志还可以控制序列化程序在某些情况下的显示方式，例如当呈现为HTML时。这个{‘base_template’: ‘textarea.html’}上面的标志相当于使用widget=widgets.Textarea在Django上Form类。这对于控制如何显示可浏览的API特别有用，我们将在本教程的后面部分看到这一点。

实际上，我们也可以通过使用ModelSerializer类，我们将在后面看到，但现在我们将保持序列化程序定义的明确性。

使用序列化程序

在我们更进一步之前，我们将熟悉如何使用我们的新序列化器类。让我们进入Django shell。

python manage.py shell
好的，先我们导入必要的包，再让我们创建几个代码片段来使用。

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()
我们现在有几个片段实例可供使用。让我们来看看序列化其中一个实例。

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

至此，我们已经将模型实例转换为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与使用表单有很多相似的地方。当我们开始编写使用序列化程序的视图时，会更加理解这种相似。

我们也可以序列化查询集，而不是单个模型实例。要做到这一点，我们只需添加一个many=True将标志标记为序列化器参数。

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

使用模型序列化器

我们的SnippetSerializer类复制了许多信息，这些信息也包含在Snippet模特。如果我们能保持代码更简洁一点，那就更好了。

与Django提供的方式相同Form班级和ModelForm类，REST框架包括两个类，Serializer类，和ModelSerializer类。

让我们看看如何使用ModelSerializer类。打开文件snippets/serializers.py再次替换SnippetSerializer用以下方法初始化。

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类不会做任何特别神奇的事情，它们只是创建序列化类的快捷方式：

自动确定的一组字段。
类的简单默认实现。create()和update()方法。

使用序列化程序编写常规Django视图

让我们看看如何使用新的序列化类编写一些API视图。目前，我们将不使用REST框架的任何其他特性，只需将视图编写为普通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的根将是一个视图，它支持列出所有现有的片段，或者创建一个新的代码段。

@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令牌的客户端发送视图，所以需要将视图标记为csrf_exempt…这不是您通常想要做的事情，REST框架视图实际上使用了更合理的操作，但是现在这样做已经足够用了。

我们还需要一个与单个片段相对应的视图，该视图可用于检索、更新或删除代码段。

@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),
]

我们还需要连接根urlconf，在tutorial/urls.py文件，包括我们的片段应用程序的URL。

from django.urls import path, include

urlpatterns = [
    path('', include('snippets.urls')),
]

值得注意的是，我们目前还没有妥善处理一些边缘案件。如果我们送畸形的json或者使用视图无法处理的方法发出请求，那么我们将得到500“server error”响应。不过，目前我们无需考虑这个问题。

测试我们的第一个WebAPI

现在，我们可以启动一个为代码片段服务的示例服务器。

从shell里退出.。

quit()
.启动Django的开发服务器

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是一个用户友好的HTTP client，是用Python编写的。让我们安装它。或者使用postman
您可以使用pip安装httpie：

pip install httpie

最后，我们可以获得所有片段的列表：

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来获得一个特定的片段：

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"
}

类似地，您可以通过在Web浏览器中访问这些URL来显示相同的json。

我们做到哪一步了？

到目前为止，我们做得还不错，我们有一个与Django的FormsAPI非常相似的序列化API，以及一些普通的Django视图。

除了服务，我们的api视图目前并没有做什么特别的事情。响应json，尽管我们仍然希望清理一些处理边缘的错误情况，但它是一个功能良好的WebAPI。

我们将学习如何开始改进api以及响应DjangoRestFramework系列教程（2）：请求（request对象）和响应（response对象）.