序列化Serialization
1. 设置一个新的环境
在我们开始之前， 我们首先使用virtualenv要创建一个新的虚拟环境，以使我们的配置和我们的其他项目配置彻底分开。
|
1
2
3
4
5
|
$mkdir ~/env$virtualenv ~/env/tutorial$source ~/env/tutorial/bin/avtivate |
现在我们处在一个虚拟的环境中，开始安装我们的依赖包
|
1
2
3
4
5
|
$pip install django$pip install djangorestframework$pip install pygments ////使用这个包，做代码高亮显示 |
需要退出虚拟环境时，运行deactivate。更多信息，irtualenv document
2. 开始
环境准备好只好，我们开始创建我们的项目
|
1
2
3
4
5
|
$ cd ~$ django-admin.py startproject tutorial$ cd tutorial |
项目创建好后，我们再创建一个简单的app
|
1
|
$python manage.py startapp snippets |
我们使用sqlite3来运行我们的项目tutorial，编辑tutorial/settings.py, 将数据库的默认引擎engine改为sqlite3, 数据库的名字NAME改为tmp.db
|
1
2
3
4
5
6
7
8
9
10
|
DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', 'NAME': 'tmp.db', 'USER': '', 'PASSWORD': '', 'HOST': '', 'PORT': '', }} |
同时更改settings.py文件中的INSTALLD_APPS,添加我们的APP snippets和rest_framework
|
1
2
3
4
5
|
INSTALLED_APPS = ( ... 'rest_framework', 'snippets',) |
在tutorial/urls.py中，将snippets app的url包含进来
|
1
2
3
|
urlpatterns = patterns('', url(r'^', include('snippets.urls')),) |
3. 创建Model
这里我们创建一个简单的nippets model，目的是用来存储代码片段。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
from django.db import modelsfrom pygments.lexers import get_all_lexersfrom pygments.styles import get_all_stylesLEXERS = [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, 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',) |
完成model时，记得sync下数据库
|
1
|
python manage.py syncdb |
4. 创建序列化类
我们要使用我们的web api，要做的第一件事就是序列化和反序列化， 以便snippets实例能转换为可表述的内容，例如json. 我们声明一个可有效工作的串行器serializer。在snippets目录下面，该串行器与django 的表单形式很类似。创建一个serializers.py ，并将下面内容拷贝到文件中。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
from django.forms import widgetsfrom rest_framework import serializersfrom snippets.models import Snippetclass SnippetSerializer(serializers.Serializer): pk = serializers.Field() # Note: `Field` is an untyped read-only field. title = serializers.CharField(required=False, max_length=100) code = serializers.CharField(widget=widgets.Textarea, max_length=100000) linenos = serializers.BooleanField(required=False) language = serializers.ChoiceField(choices=models.LANGUAGE_CHOICES, default='python') style = serializers.ChoiceField(choices=models.STYLE_CHOICES, default='friendly') def restore_object(self, attrs, instance=None): """ Create or update a new snippet instance. """ if instance: # Update existing instance instance.title = attrs['title'] instance.code = attrs['code'] instance.linenos = attrs['linenos'] instance.language = attrs['language'] instance.style = attrs['style'] return instance # Create new instance return Snippet(**attrs) |
该序列化类的前面部分，定义了要序列化和反序列化的类型，restore_object 方法定义了如何通过反序列化数据，生成正确的对象实例。
我们也可以使用ModelSerializer来快速生成，后面我们将节省如何使用它。
5. 使用 Serializers
在我们使用我们定义的SnippetsSerializers之前，我们先熟悉下Snippets.
|
1
|
$python manage.py shell |
进入shell终端后，输入以下代码：
|
1
2
3
4
5
6
7
|
from snippets.models import Snippetfrom snippets.serializers import SnippetSerializerfrom rest_framework.renderers import JSONRendererfrom rest_framework.parsers import JSONParsersnippet = Snippet(code='print "hello, world"\n')snippet.save() |
我们现在获得了一个Snippets的实例，现在我们对他进行以下序列化
|
1
2
3
|
serializer = SnippetSerializer(snippet)serializer.data# {'pk': 1, 'title': u'', 'code': u'print "hello, world"\n', 'linenos': False, 'language': u'python', 'style': u'friendly'} |
这时，我们将该实例转成了python原生的数据类型。下面我们将该数据转换成json格式，以完成序列化：
|
1
2
3
|
content = JSONRenderer().render(serializer.data)content# '{"pk": 1, "title": "", "code": "print \\"hello, world\\"\\n", "linenos": false, "language": "python", "style": "friendly"}' |
反序列化也很简单，首先我们要将一个输入流（content），转换成python的原生数据类型
|
1
2
3
4
|
import StringIOstream = StringIO.StringIO(content)data = JSONParser().parse(stream) |
然后我们将该原生数据类型，转换成对象实例
|
1
2
3
4
5
|
serializer = SnippetSerializer(data=data)serializer.is_valid()# Trueserializer.object# <Snippet: Snippet object> |
注意这些API和django表单的相似处。这些相似点， 在我们讲述在view中使用serializers时将更加明显。
6. 使用 ModelSerializers
SnippetSerializer使用了许多和Snippet中相同的代码。如果我们能把这部分代码去掉，看上去将更佳简洁。
类似与django提供Form类和ModelForm类，Rest Framework也包含了Serializer 类和 ModelSerializer类。
打开snippets/serializers.py ,修改SnippetSerializer类：
|
1
2
3
4
|
class SnippetSerializer(serializers.ModelSerializer): class Meta: model = Snippet fields = ('id', 'title', 'code', 'linenos', 'language', 'style') |
7. 通过Serializer编写Django View
让我们来看一下，如何通过我们创建的serializer类编写django view。这里我们不使用rest framework的其他特性，仅编写正常的django view。
我们创建一个HttpResponse 子类，这样我们可以将我们返回的任何数据转换成json。
在snippet/views.py中添加以下内容：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
from django.http import HttpResponsefrom django.views.decorators.csrf import csrf_exemptfrom rest_framework.renderers import JSONRendererfrom rest_framework.parsers import JSONParserfrom snippets.models import Snippetfrom snippets.serializers import SnippetSerializerclass JSONResponse(HttpResponse): """ An HttpResponse that renders it's content into JSON. """ def __init__(self, data, **kwargs): content = JSONRenderer().render(data) kwargs['content_type'] = 'application/json' super(JSONResponse, self).__init__(content, **kwargs) |
我们API的目的是，可以通过view来列举全部的Snippet的内容，或者创建一个新的snippet
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
@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) return JSONResponse(serializer.data) elif request.method == 'POST': data = JSONParser().parse(request) serializer = SnippetSerializer(data=data) if serializer.is_valid(): serializer.save() return JSONResponse(serializer.data, status=201) else: return JSONResponse(serializer.errors, status=400) |
注意，因为我们要通过client向该view post一个请求，所以我们要将该view 标注为csrf_exempt, 以说明不是一个CSRF事件。
Note that because we want to be able to POST to this view from clients that won't have a CSRF token we need to mark the view as csrf_exempt. This isn't something that you'd normally want to do, and REST framework views actually use more sensible behavior than this, but it'll do for our purposes right now.
我们也需要一个view来操作一个单独的Snippet，以便能更新／删除该对象。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
@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) else: return JSONResponse(serializer.errors, status=400) elif request.method == 'DELETE': snippet.delete() return HttpResponse(status=204) |
将views.py保存，在Snippets目录下面创建urls.py,添加以下内容：
|
1
2
3
4
|
urlpatterns = patterns('snippets.views', url(r'^snippets/$', 'snippet_list'), url(r'^snippets/(?P<pk>[0-9]+)/$', 'snippet_detail'),) |
注意我们有些边缘事件没有处理，服务器可能会抛出500异常。
8. 测试
现在我们启动server来测试我们的Snippet。
在python mange.py shell终端下执行（如果前面进入还没有退出）
|
1
|
>>quit() |
执行下面的命令， 运行我们的server：
|
1
2
3
4
5
6
7
8
|
python manage.py runserverValidating models...0 errors foundDjango version 1.4.3, using settings 'tutorial.settings'Development server is running at http://127.0.0.1:8000/Quit the server with CONTROL-C. |
新开一个terminal来测试我们的server
序列化：
|
1
2
3
4
5
6
|
url http://127.0.0.1:8000/snippets/[{"id": 1, "title": "", "code": "print \"hello, world\"\n", "linenos": false, "language": "python", "style": "friendly"}] url http://127.0.0.1:8000/snippets/1/{"id": 1, "title": "", "code": "print \"hello, world\"\n", "linenos": false, "language": "python", "style": "friendly"} |
Request and Response
1. Request Object ——Request对象
rest framework 引入了一个继承自HttpRequest的Request对象，该对象提供了对请求的更灵活解析。request对象的核心部分是request.data属性，类似于request.post, 但在使用WEB API时，request.data更有效。
（1）request.POST # Only handles form data. Only works for 'POST' method.
（2）request.DATA # Handles arbitrary data. Works any HTTP request with content.
2. Response Object ——Response对象
rest framework引入了一个Response 对象，它继承自TemplateResponse对象。它获得未渲染的内容并通过内容协商content negotiation 来决定正确的content type返回给client。
return Response(data) # Renders to content type as requested by the client.
3. Status Codes
在views当中使用数字化的HTTP状态码，会使你的代码不宜阅读，且不容易发现代码中的错误。rest framework为每个状态码提供了更明确的标识。例如HTTP_400_BAD_REQUEST。相比于使用数字，在整个views中使用这类标识符将更好。
4. 封装API views
在编写API views时，REST Framework提供了两种wrappers：
1). @api_viwe 装饰器 ——函数级别
2). APIView 类——类级别
这两种封装器提供了许多功能，例如，确保在view当中能够接收到Request实例；往Response中增加内容以便内容协商content negotiation 机制能够执行。
封装器也提供一些行为，例如在适当的时候返回405 Methord Not Allowed响应；在访问多类型的输入request.DATA时，处理任何的ParseError异常。
5. 汇总
我们开始用这些新的组件来写一些views。
我们不在需要JESONResponse 类（在前一篇中创建），将它删除。删除后我们开始稍微重构下我们的view
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
from rest_framework import statusfrom rest_framework.decorators import api_viewfrom rest_framework.response import Responsefrom snippets.models import Snippetfrom snippets.serializers import SnippetSerializer@api_view(['GET', 'POST'])def snippet_list(request): """ List all snippets, or create a new snippet. """ if request.method == 'GET': snippets = Snippet.objects.all() serializer = SnippetSerializer(snippets) return Response(serializer.data) elif request.method == 'POST': serializer = SnippetSerializer(data=request.DATA) if serializer.is_valid(): serializer.save() return Response(serializer.data, status=status.HTTP_201_CREATED) else: return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) |
上面的代码是对我们之前代码的改进。看上去更简洁，也更类似于django的forms api形式。我们也采用了状态码，使返回值更加明确。
下面是对单个snippet操作的view更新：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
@api_view(['GET', 'PUT', 'DELETE'])def snippet_detail(request, pk): """ Retrieve, update or delete a snippet instance. """ try: snippet = Snippet.objects.get(pk=pk) except Snippet.DoesNotExist: return Response(status=status.HTTP_404_NOT_FOUND) if request.method == 'GET': serializer = SnippetSerializer(snippet) return Response(serializer.data) elif request.method == 'PUT': serializer = SnippetSerializer(snippet, data=request.DATA) if serializer.is_valid(): serializer.save() return Response(serializer.data) else: return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST) elif request.method == 'DELETE': snippet.delete() return Response(status=status.HTTP_204_NO_CONTENT) |
注意，我们并没有明确的要求requests或者responses给出content type。request.DATA可以处理输入的json请求，也可以输入yaml和其他格式。类似的在response返回数据时，REST Framework返回正确的content type给client。
6. 给URLs增加可选的格式后缀
利用在response时不需要指定content type这一事实，我们在API端增加格式的后缀。使用格式后缀，可以明确的指出使用某种格式，意味着我们的API可以处理类似http://example.com/api/items/4.json.的URL。
增加format参数在views中，如：
|
1
2
3
4
|
def snippet_list(request, format=None):anddef snippet_detail(request, pk, format=None): |
现在稍微改动urls.py文件，在现有的URLs中添加一个格式后缀pattterns (format_suffix_patterns):
|
1
2
3
4
5
6
7
8
9
|
from django.conf.urls import patterns, urlfrom rest_framework.urlpatterns import format_suffix_patternsurlpatterns = patterns('snippets.views', url(r'^snippets/$', 'snippet_list'), url(r'^snippets/(?P<pk>[0-9]+)$', 'snippet_detail'),)urlpatterns = format_suffix_patterns(urlpatterns) |
这些额外的url patterns并不是必须的。
