教程1-序列化

时间 2020-08-18

标签教程序列繁體版

原文原文链接

序列化

序列化

介绍

本教程将介绍如何建立一个简单的 pastebin 代码突出显示webapi。在此过程当中，它将介绍组成REST框架的各类组件，并全面了解全部内容如何组合在一块儿。html

本教程至关深刻，所以，在开始以前，您可能应该先得到饼干和一杯本身喜欢的啤酒。若是您只想快速浏览一下，则应该转到快速入门文档。python

注意：该教程的代码可在GitHub上的encode/rest-framework-tutorial存储库中找到。完整的实施也能够做为沙箱版本在线进行测试，可在此处得到。web

设置新环境

在进行其余操做以前，咱们将使用 venv建立一个新的虚拟环境，这将确保咱们的程序包配置与咱们正在处理的任何其余项目保持良好的隔离。shell

python3 -m venv env
source env/bin/activate

如今咱们处于虚拟环境中，咱们能够安装软件包要求。数据库

pip install django
pip install djangorestframework
pip install pygments  # 咱们将用它来突出显示代码

注意：输入deactivate随时退出虚拟环境，有关更多信息，请参阅 venv文档。django

入门

好的，咱们已经准备好进行编码。首先，让咱们建立一个要使用的新项目。编程

完成后，咱们能够建立一个应用程序，用它来建立一个简单的Web API。json

python manage.py startapp snippetsapi

咱们须要将新的snippets应用和rest_framework应用添加到INSTALLED_APPS。让咱们编辑 tutorial/settings.py文件：浏览器

INSTALLED_APPS = [
    ...
    'rest_framework',
    'snippets.apps.SnippetsConfig',
]

好的，咱们准备开始了。

建立一个可使用的模型

在本教程中，咱们将从建立一个简单的Snippet模型开始，该模型用于存储代码片断.继续编辑snippits/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):
    """
    使用`pygments`库建立突出显示的HTML代码段的表示形式。
    """
    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

建立一个序列化器类

咱们须要开始使用Web API的第一件事是提供一种将片断实例序列化和反序列化为json等表示形式的方法。咱们能够经过声明与Django形式很是类似的序列化器来实现此目的。在snippets目录中建立一个名为seralizers.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):
        """
        给定通过验证的数据，建立并返回一个新的“片断”实例。
        """
        return Snippet.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """
        给定通过验证的数据，更新并返回一个现有的“ Snippet”实例。
        """
        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'}标志等效于在Django Form类上使用widget = widgets.Textarea。这对于控制应如何显示可浏览的API尤为有用，咱们将在本教程的后面部分看到。

实际上，咱们也能够经过使用ModelSerializer类节省一些时间，咱们将在后面看到，可是如今咱们将使序列化程序定义保持明确。

使用序列化器

在继续以前，咱们将熟悉使用新的Serializer类。让咱们进入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

至此，咱们已经将模型实例转换为Python本机数据类型。为了完成序列化过程，咱们将数据渲染到json中。

反序列化是类似的。首先，咱们将流解析为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

使用 ModelSerializers

咱们的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']

序列化程序有一个很好的特性，就是能够检查序列化程序实例中的全部字段，经过打印其表示。使用python manage.py shell打开Django 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视图

让咱们看看如何使用新的Serializer类编写一些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):
    """
    列出全部snippet，或建立一个新的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):
    """
    检索，更新，或删除代码段。
    """
    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, 在torial/urls.py文件中，包含咱们的代码片断应用程序的URL。

from django.urls import path, include

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

值得注意的是，咱们目前尚未妥善处理一些边缘状况。若是咱们发送格式错误的 json.，或者若是使用视图没法处理的方法发出请求，那么咱们将获得500 的 “服务器错误”响应。不过，如今这样就好了。

测试咱们第一次尝试使用Web API

如今，咱们能够启动一个示例服务器，以服务于咱们的片断，

先退出 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测试咱们的API。Httpie是使用Python编写的用户友好型HTTP客户端。让咱们安装它。

您可使用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.

咱们如今在哪？

到目前为止咱们还好，咱们有一个序列化API，感受与Django的Forms API很是类似，以及一些常规的Django视图。

除了提供json响应外，咱们的API视图目前并无作任何特别的事情，而且咱们仍然但愿清理一些错误处理的极端状况，但这是一个正常运行的Web API。

在本教程的第2部分中，咱们将看到如何开始改进。