django rest framework我的学习笔记（三）————Tutorial1.Serialization

Serialization——序列化

官网地址

前言

本教程将会介绍建立一个简单webAPI。在整个学习的过程当中，将会逐一介绍到REST framework的各类组件，让你全面的了解全部东西是若是组合在一块儿的。
这个教程将会至关的详细，因此在开始以前，你应该去来点饼干，再喝上一些你喜欢的饮料。若是你只是想快速概览，你应该查看Quickstart.
注意：本教程的代码能够在GitHub的 tomchristie/rest-framework-tutorial中找到。测试,这是一个测试连接。

建立一个新的虚拟环境

使用 virtualenv建立一个虚拟环境.

virtualenv env
source env/bin/activate

而后咱们在咱们建立的虚拟环境中安装须要的包。

pip install django
pip install djangorestframework
pip install pygments #使用它来代码高亮

注意：使用 deactivate来随时退出虚拟环境。更多的信息请查看Virtualenv documentation

准备

咱们这边开始编写代码了。先来建立一个项目吧~

cd ~
django-admin.py startproject tutorial
cd tutorial

接下来，咱们建立一个app。

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。
咱们能够继续上路了。

建立model

在本教程中，咱们将建立一个简单的model，这个model将用于储存代码片断。
编辑 snippets/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):
    created = models.DateTimeField(auto_now_add=True)
    title = models.CharField(max_length=100,blank=True,defalut='')
    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

建立Serializer

首先，咱们须要给咱们的web API 提供一种序列化和反序列化的呈现方式，如json。
咱们能够申明一个和django的forms差很少的serializers。建立一个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):
        return Snippet.objects.create(**validated_data)
       
    def update(self,instance,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

serializer的第一步是定义须要 序列化/反序列化 的字段。create()和update()方法定义当serializer.save()时，若是建立和更新。
serializer类很是相似于Django的Form类。包括各个字段的验证标记，例如 required,max_length,default。
字段标记也可以控制serializer在某些环境中如何显示，例如呈现为HTML.
以前的{'base_template': 'textarea.html'}标记至关于django Form中的widget=widgets.Textarea`。

其实咱们使用ModelSerializer类更可以节省咱们的时间，但如今，咱们仍是显示的定义咱们的字段。

开始工做

在咱们更进一步学习以前，咱们将经过django shell来熟悉serializer。

python manage.py shell

咱们须要导入咱们须要的东西，而后建立两个snippet。

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'}

在这里，咱们翻译这个model实例为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
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>

注意：这相似于forms.当咱们编写views使用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 framework也包含Serializer和ModelSerializer两个类。
让咱们来使用ModelSerializer来重构咱们的serializer类。打开snippets/serializers.py，替换SinppetSerializer类：

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

serializer拥有一个很好的属性，你可以经过打印查看一个serializer实例的全部字段。打开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不会作任何如魔法般的事情，它只是更快捷的建立serializer

• 自动的肯定字段的设置
• 简单的默认create()和update()方法

使用Serializer写一个常规的django views

让咱们使用咱们新的serializer来写一些API视图吧。在这里，咱们不会使用任何REST framework的其余特性，咱们就写一个常规的 django views。
来编写 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将会支持查看全部数据和建立一个新的snippet

@csrf_exempt
def snippet_list(request):
    """
    显示全部的代码片断，或者建立一个新的片断
    """
    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)

注意：由于咱们但愿post可以不经过CSRF token的验证，因此咱们使用了 csrf_exempt。事实上，这不会是你常常作的事情，而且REST framework views会更加明智的作这个事情。可是如今，他可使用。

咱们还须要这个视图可以检索，更新和删除。

@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)

最后，咱们须要建立url，在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),
]

咱们还须要在跟urls.py(tutorial/urls.py)上引入咱们的urls.py

from django.conf.urls import url, include

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

注意：咱们的视图有某些问题是尚未作妥善的处理，好比发送的json格式不正确，或是调用视图没有的方法，那么咱们就会返回一个500“服务器错误”的消息。