教程1-序列化

序列化

目录

• 序列化
  • 介绍
  • 设置新环境
  • 入门
  • 创建一个序列化器类
  • 使用序列化器
  • 使用 ModelSerializers
  • 使用序列化器编写常规Django视图
  • 测试我们第一次尝试使用Web API
  • 我们现在在哪？

介绍

本教程将介绍如何创建一个简单的 pastebin 代码突出显示webapi。在此过程中，它将介绍组成REST框架的各种组件，并全面了解所有内容如何组合在一起。

本教程相当深入，因此，在开始之前，您可能应该先获得饼干和一杯自己喜欢的啤酒。如果您只想快速浏览一下，则应该转到快速入门文档。

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

设置新环境

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

python3 -m venv env
source env/bin/activate

现在我们处于虚拟环境中，我们可以安装软件包要求。

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

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

入门

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

完成后，我们可以创建一个应用程序，用它来创建一个简单的Web API。

python manage.py startapp snippets

我们需要将新的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"
')
snippet.save()

snippet = Snippet(code='print("hello, world")
')
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")
'), ('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"
",
    "linenos": false,
    "language": "python",
    "style": "friendly"
  },
  {
    "id": 2,
    "title": "",
    "code": "print("hello, world")
",
    "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")
",
  "linenos": false,
  "language": "python",
  "style": "friendly"
}

同样，通过在Web浏览器中访问这些URL，可以显示相同的json.

我们现在在哪？

到目前为止我们还好，我们有一个序列化API，感觉与Django的Forms API非常相似，以及一些常规的Django视图。

除了提供json响应外，我们的API视图目前并没有做任何特别的事情，并且我们仍然希望清理一些错误处理的极端情况，但这是一个正常运行的Web API。

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