Django REST framework 中文教程1:序列化

建议直接去http://www.chenxm.cc/post/289... 该网址阅读，本文内容以后于该网页

创建环境

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

virtualenv
envsource env/bin/activate

如今咱们在一个virtualenv环境中，咱们能够安装咱们的包的要求。

pip install django
pip install djangorestframework
pip install pygments  # 咱们将使用这个让代码突出显示

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

入门

好的，咱们准备好得到编码。要开始，咱们来建立一个新的项目来处理。

cd ~
django-admin.py startproject tutorial
cd 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 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

建立一个Serializer类

咱们须要开始使用Web 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

使用Serializer

在咱们进一步了解以前，咱们将熟悉使用咱们的新的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"\n')
snippet.save()

snippet = Snippet(code='print "hello, world"\n')
snippet.save()

咱们如今有几个片断实例能够尝试。咱们来看看序列化这些实例之一。

###
 该代码是把刚刚保存的数据snippet对象，通过序列化保存成一个字典
     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。

# 将字典转换成json格式
content = JSONRenderer().render(serializer.data)
content
# '{"id": 2, "title": "", "code": "print \\"hello, world\\"\\n", "linenos": false, "language": "python", "style": "friendly"}'
反序列化是相似的。首先咱们将一个流解析成Python支持数据类型。

# 将json转换成字典格式
from django.utils.six import BytesIO

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

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

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类不会作任何特别神奇的事情，它们只是建立序列化器类的快捷方式：

一组自动肯定的字段。
简单的默认实现create()和update()方法。
使用咱们的Serializer编写正常的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.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()
            # serializer.data 数据建立成功后全部数据
            return JsonResponse(serializer.data, status=201)
        # serializer.errors 错误信息
        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 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“服务器错误”响应。

测试咱们在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\"\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。

咱们如今在哪

咱们到目前为止还行，咱们有一个相似于Django的Forms API和一些常规Django视图的序列化API。

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

咱们将在本教程的第2部分中看到咱们如何开始改进事情。
Django REST FrameWork中文文档目录：

Django REST FrameWork 中文教程1:序列化

Django REST FrameWork 中文教程2:请求和响应

Django REST FrameWork 中文教程3:基于类的视图

Django REST FrameWork 中文教程4：验证和权限

Django REST FrameWork 中文教程5：关系和超连接API

Django REST FrameWork 中文教程6: ViewSets＆Routers

Django REST FrameWork 中文教程7：模式和客户端库