Django-REST之1:serializers序列器-翻译及自己的学习笔记（更新完善中...）

教程1：序列化

介绍

本教程将介绍如何创建一个简单的粘贴代码，突出显示Web API。一路上，将介绍组成REST框架的各种组件，并全面了解一切如何融合在一起。

该教程是相当深入的，所以你应该在开始之前获得一个cookie和一杯你最喜欢的酿造。如果您只想快速浏览，请改用快速入门文档。

---

注意：本教程的代码可在GitHub 的tomchristie / rest-framework-tutorial存储库中找到。完成的实施也是在线作为沙盒版本进行测试，这里可以看到。

---

建立一个新的环境

在我们做任何事情之前，我们将使用virtualenv创建一个新的虚拟环境。这将确保我们的包配置与我们正在开展的任何其他项目保持良好的隔离。

virtualenv envsource env/bin/activate

现在我们在一个virtualenv环境中，我们可以安装我们的包的要求。

pip install djangopip install djangorestframeworkpip install pygments  # We'll be using this for the code highlighting

注意：要随时退出virtualenv环境，只需键入deactivate。有关更多信息，请参阅virtualenv文档。

入门

好的，我们准备好获得编码。要开始，我们来创建一个新的项目来处理。

cd ~django-admin.py startproject tutorialcd tutorial

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

python manage.py startapp snippets

我们需要添加我们的新snippets应用和rest_framework应用INSTALLED_APPS。我们来编辑tutorial/settings.py文件：

INSTALLED_APPS = (    ...    'rest_framework',    'snippets.apps.SnippetsConfig',)

请注意，如果你使用的Django <1.9，则需要更换snippets.apps.SnippetsConfig有snippets。

好的，我们准备好了。

创建一个可以使用的模型

为了本教程的目的，我们将首先创建一个Snippet用于存储代码片段的简单模型。继续编辑snippets/models.py文件。注意：良好的编程实践包括评论。虽然您将在本教程代码的存储库版本中找到它们，但我们在此忽略了它们，专注于代码本身。

from django.db import modelsfrom 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 snippetspython manage.py migrate

创建一个Serializer类

我们需要开始使用Web API的第一件事是提供一种将代码片段实例序列化和反序列化为表示形式的方法json。我们可以通过声明与Django表单非常相似的序列化器来做到这一点。在snippets命名的目录中创建一个文件，serializers.py并添加以下内容。

from rest_framework import serializersfrom snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICESclass SnippetSerializer(serializers.Serializer):  #   这个类下面的字段，只能是models中有的字段    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课程来节省自己的时间，我们稍后会看到，但是现在我们将保持我们的序列化器定义。

使用串行器

在我们进一步了解之前，我们将熟悉使用我们新的Serializer类。我们进入Django shell。

python manage.py shell

好的，一旦我们有几个导入，我们来创建一些代码片段来处理。

from snippets.models import Snippetfrom snippets.serializers import SnippetSerializerfrom rest_framework.renderers import JSONRendererfrom rest_framework.parsers import JSONParsersnippet = Snippet(code='foo = "bar"\n')  #  传入model中，code的字段snippet.save()snippet = Snippet(code='print "hello, world"\n')snippet.save()

我们现在有几个片段实例可以玩。我们来看看序列化这些实例之一。

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

此时，我们将模型实例转换为Python本机数据类型。为了完成序列化过程，我们将数据转换成json。

content = JSONRenderer().render(serializer.data)content# '{"id": 2, "title": "", "code": "print \\"hello, world\\"\\n", "linenos": false, "language": "python", "style": "friendly"}'

反序列化是类似的。首先我们将一个流解析为Python本机数据类型...

from django.utils.six import BytesIOstream = BytesIO(content)data = JSONParser().parse(stream)

...然后我们将这些本机数据类型恢复到完全填充的对象实例中。

serializer = SnippetSerializer(data=data)serializer.is_valid()# Trueserializer.validated_data# OrderedDict([('title', ''), ('code', 'print "hello, world"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])serializer.save()# <Snippet: Snippet object>

请注意API与表单的使用情况。当我们开始编写使用我们的串行器的视图时，相似性将变得更加明显。

我们也可以序列化查询集而不是模型实例。为此，我们只many=True需要为serializer参数添加一个标志。

serializer = SnippetSerializer(Snippet.objects.all(), many=True)serializer.data# [OrderedDict([('id', 1), ('title', u''), ('code', u'foo = "bar"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 2), ('title', u''), ('code', u'print "hello, world"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')]), OrderedDict([('id', 3), ('title', u''), ('code', u'print "hello, world"'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])]

使用ModelSerializers

我们的SnippetSerializer课程正在复制Snippet模型中还包含的大量信息。如果我们可以保持我们的代码更简洁，那将是很好的。

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

我们来看看使用ModelSerializer类重构我们的serializer 。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 SnippetSerializerserializer = 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()方法。

使用我们的Serializer编写正常的Django视图

我们来看看我们如何使用我们的新的Serializer类编写一些API视图。目前我们不会使用任何REST框架的其他功能，我们只需将视图编写为常规的Django视图。

编辑snippets/views.py文件，并添加以下内容。

from django.http import HttpResponse, JsonResponsefrom django.views.decorators.csrf import csrf_exemptfrom rest_framework.renderers import JSONRendererfrom rest_framework.parsers import JSONParserfrom snippets.models import Snippetfrom snippets.serializers import SnippetSerializer

我们的API的根本将是一个视图，支持列出所有现有的片段，或创建一个新的片段。

@csrf_exemptdef 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令牌的客户端对此视图进行POST，因此我们需要将视图标记为csrf_exempt。这不是你通常想要做的事情，REST框架视图实际上比这更有明确的行为，但它现在将用于我们的目的。

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

@csrf_exemptdef 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.conf.urls import urlfrom snippets import viewsurlpatterns = [    url(r'^snippets/$', views.snippet_list),    url(r'^snippets/(?P<pk>[0-9]+)/$', views.snippet_detail),]

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

from django.conf.urls import url, includeurlpatterns = [    url(r'^', include('snippets.urls')),]

值得注意的是，我们目前还没有正确处理的几个边缘案例。如果我们发送格式错误json，或者如果请求是使用视图不处理的方法，那么我们最终会出现500个“服务器错误”响应。不过，现在这样做。

测试我们在Web API上的第一次尝试

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

退出外壳...

quit()

...并启动Django的开发服务器。

python manage.py runserverValidating models...0 errors foundDjango 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视图非常相似。

我们的API视图目前没有特别的特别之处，除了提供json响应外，还有一些错误处理我们仍然想要清理的边缘情况，但它是一个运行良好的Web API。