Django REST framework-教程01-Serialization原创翻译

python技术交流群332680349，资源分享，技术交流。

01-简介

本教程将介绍代码共享web API，通过这个实例，我们将了解REST框架的各种组件，并且从整体架构上了解每一个部分是是如何组合到一起的。
- 教程代码：https://github.com/encode/rest-framework-tutorial
- 演示地址：http://restframework.herokuapp.com/

02-配置一个新环境

在我们开始新项目前，我们需要设置一个虚拟环境，安装一些必要的包，为的是不影响其他现有项目的运行环境。

virtualenv env
env\Scripts\activate

在虚拟环境中安装必要的框架

pip install django
pip install djangorestframework
pip install pygments #代码高亮作用

用deactivate退出虚拟环境

03-开始操作

没错，现在就可以开始编程了，我们先创建一个新项目。

cd ~
django-admin.py startproject tutorial
cd tutorial

接下来我们将创建一个app实现简单的web-API

python manage.py startapp snippets

在tutorial/settings.py中添加REST框架和app名字

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

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

04-创建一个模型

为了完成需求，我们创建一个Snippet表用来存储代码片段所需要的字段。
注意及时添加注释有利于你形成好的编码习惯。
本教程已经添加注释了可以我们可以更专注代码的编写。

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

05-创建一个串行器类

编写API的第一件事情就是提供一个能将代码序列化和反序列化的方法，比如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

这个类的第一个部分就是创建一些字段，用于序列化和反序列化。
- eate()：这个方法在创建类的时候调用
- date()：这个方法用于更新，注意要保存。instance.save()
串行器类和form表单类似，提供一些对字段的默认参数置例如required，max_length和default。
字段参数设置还可以控制在某些情况下，如渲染到HTML时如何显示串行器。
这对于控制如何在API中展示特别有用。
我们可以使用ModelSerializer来优化代码，稍后将看到。

06-使用串行器

在进一步操作之前，我们先熟悉一下我们新创建的串行器类

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': u'', 'code': u'print "hello, world"\n', 'linenos': False, 'language': u'python', 'style': u'friendly'}

此时，我们将模型实例转换为Python类型数据。为了完成序列化，我们将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 BytesIO

stream = BytesIO(content)
data = JSONParser().parse(stream)

然后把python类型的数据，填充到一个实例对象中。

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参数添加一个标志。

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

07-使用串行器模型

我们的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')

一个新特性就是这个serializers可以查看serializers实例的所有字段，通过打印方式 打开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()方法。

08-使用串行器编写普通的Django视图

让我们看看如何用编写API的视图用我们新的串行器类。我们现在不会用REST的其他功能，我们只需将视图编写为常规的Django视图。在 snippets/views.py中编辑。

from django.http import HttpResponse, JsonResponse
from django.views.decorators.csrf import csrf_exempt
from rest_framework.renderers import JSONRenderer
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令牌的客户端对此视图进行POST，因此我们需要将视图标记为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.conf.urls import url
from snippets import views

urlpatterns = [
    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, include

urlpatterns = [
    url(r'^', include('snippets.urls')),
]

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

09-测试web API

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

退出外壳…

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。