一、DRF框架之序列化器的使用

1.设置新环境

在我们做任何其他事情之前，我们将使用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

2.创建新项目

让我们创建一个要使用的新项目。

cd ~
django-admin startproject tutorial
cd tutorial

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

python manage.py startapp snippets

我们需要将新应用和应用添加到 .让我们编辑文件：settings.py

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

3.创建模型类

创建模型类

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 snippets

4.创建序列化程序类

在 Web API 上，我们需要开始做的第一件事是提供一种将代码段实例序列化和反序列化为表示形式（如 ） 的方法。我们可以通过声明与Django的形式非常相似的序列化程序来做到这一点。在名为的目录中创建一个文件，然后添加以下内容。

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

5.使用序列化程序

在我们进一步使用之前，我们将熟悉如何使用新的序列化程序类。让我们进入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')

6.使用模型序列化程序

序列化程序类

class SnippetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Snippet
        fields = ['id', 'title', 'code', 'linenos', 'language', 'style']

序列化程序具有的一个很好的属性是，您可以通过打印序列化程序实例的表示形式来检查序列化程序实例中的所有字段。使用 打开 Django 外壳程序，然后尝试以下操作：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')...

7.使用我们的序列化程序编写常规 Django 视图

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 令牌的客户端发布到此视图，因此需要将视图标记为 。这不是你通常想要做的事情，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)

最后，我们需要将这些视图连接起来。创建文件：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，以包含代码段应用的 URL。urls.py

from django.urls import path, include

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

值得注意的是，我们目前没有正确处理一些边缘情况。如果我们发送格式错误的 ，或者如果使用视图无法处理的方法发出请求，那么我们最终会得到500个“服务器错误”响应。