Python的Django REST框架中的序列化及请求和返回

2024-03-20 01:36:03 31

序列化Serialization
1.设置一个新的环境

在我们开始之前，我们首先使用virtualenv要创建一个新的虚拟环境，以使我们的配置和我们的其他项目配置彻底分开。

$mkdir~/env

$virtualenv~/env/tutorial

$source~/env/tutorial/bin/avtivate

现在我们处在一个虚拟的环境中，开始安装我们的依赖包

$pipinstalldjango

$pipinstalldjangorestframework

$pipinstallpygments////使用这个包，做代码高亮显示

需要退出虚拟环境时，运行deactivate。更多信息，irtualenvdocument

2.开始

环境准备好只好，我们开始创建我们的项目

$cd~

$django-admin.pystartprojecttutorial

$cdtutorial

项目创建好后，我们再创建一个简单的app

$pythonmanage.pystartappsnippets

我们使用sqlite3来运行我们的项目tutorial，编辑tutorial/settings.py,将数据库的默认引擎engine改为sqlite3,数据库的名字NAME改为tmp.db

DATABASES={
'default':{
'ENGINE':'django.db.backends.sqlite3',
'NAME':'tmp.db',
'USER':'',
'PASSWORD':'',
'HOST':'',
'PORT':'',
}
}

同时更改settings.py文件中的INSTALLD_APPS,添加我们的APPsnippets和rest_framework

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

在tutorial/urls.py中，将snippetsapp的url包含进来

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

3.创建Model
这里我们创建一个简单的nippetsmodel，目的是用来存储代码片段。

fromdjango.dbimportmodels
frompygments.lexersimportget_all_lexers
frompygments.stylesimportget_all_styles

LEXERS=[itemforiteminget_all_lexers()ifitem[1]]
LANGUAGE_CHOICES=sorted([(item[1][0],item[0])foriteminLEXERS])
STYLE_CHOICES=sorted((item,item)foriteminget_all_styles())

classSnippet(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)

classMeta:
ordering=('created',)

完成model时，记得sync下数据库

pythonmanage.pysyncdb

4.创建序列化类

我们要使用我们的webapi，要做的第一件事就是序列化和反序列化，以便snippets实例能转换为可表述的内容，例如json.我们声明一个可有效工作的串行器serializer。在snippets目录下面，该串行器与django的表单形式很类似。创建一个serializers.py，并将下面内容拷贝到文件中。

fromdjango.formsimportwidgets
fromrest_frameworkimportserializers
fromsnippets.modelsimportSnippet

classSnippetSerializer(serializers.Serializer):
pk=serializers.Field()#Note:`Field`isanuntypedread-onlyfield.
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')

defrestore_object(self,attrs,instance=None):
"""
Createorupdateanewsnippetinstance.
"""
ifinstance:
#Updateexistinginstance
instance.title=attrs['title']
instance.code=attrs['code']
instance.linenos=attrs['linenos']
instance.language=attrs['language']
instance.style=attrs['style']
returninstance

#Createnewinstance
returnSnippet(**attrs)

该序列化类的前面部分，定义了要序列化和反序列化的类型，restore_object方法定义了如何通过反序列化数据，生成正确的对象实例。

我们也可以使用ModelSerializer来快速生成，后面我们将节省如何使用它。
5.使用Serializers

在我们使用我们定义的SnippetsSerializers之前，我们先熟悉下Snippets.

$pythonmanage.pyshell

进入shell终端后，输入以下代码：

fromsnippets.modelsimportSnippet
fromsnippets.serializersimportSnippetSerializer
fromrest_framework.renderersimportJSONRenderer
fromrest_framework.parsersimportJSONParser

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

我们现在获得了一个Snippets的实例，现在我们对他进行以下序列化

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格式，以完成序列化：

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

反序列化也很简单，首先我们要将一个输入流（content），转换成python的原生数据类型

importStringIO

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

然后我们将该原生数据类型，转换成对象实例

serializer=SnippetSerializer(data=data)
serializer.is_valid()
#True
serializer.object
#<Snippet:Snippetobject>

注意这些API和django表单的相似处。这些相似点，在我们讲述在view中使用serializers时将更加明显。
6.使用ModelSerializers

SnippetSerializer使用了许多和Snippet中相同的代码。如果我们能把这部分代码去掉，看上去将更佳简洁。

类似与django提供Form类和ModelForm类，RestFramework也包含了Serializer类和ModelSerializer类。

打开snippets/serializers.py,修改SnippetSerializer类：

classSnippetSerializer(serializers.ModelSerializer):
classMeta:
model=Snippet
fields=('id','title','code','linenos','language','style')

7.通过Serializer编写DjangoView

让我们来看一下，如何通过我们创建的serializer类编写djangoview。这里我们不使用restframework的其他特性，仅编写正常的djangoview。

我们创建一个HttpResponse子类，这样我们可以将我们返回的任何数据转换成json。

在snippet/views.py中添加以下内容：

fromdjango.httpimportHttpResponse
fromdjango.views.decorators.csrfimportcsrf_exempt
fromrest_framework.renderersimportJSONRenderer
fromrest_framework.parsersimportJSONParser
fromsnippets.modelsimportSnippet
fromsnippets.serializersimportSnippetSerializer

classJSONResponse(HttpResponse):
"""
AnHttpResponsethatrendersit'scontentintoJSON.
"""
def__init__(self,data,**kwargs):
content=JSONRenderer().render(data)
kwargs['content_type']='application/json'
super(JSONResponse,self).__init__(content,**kwargs)

我们API的目的是，可以通过view来列举全部的Snippet的内容，或者创建一个新的snippet

@csrf_exempt
defsnippet_list(request):
"""
Listallcodesnippets,orcreateanewsnippet.
"""
ifrequest.method=='GET':
snippets=Snippet.objects.all()
serializer=SnippetSerializer(snippets)
returnJSONResponse(serializer.data)

elifrequest.method=='POST':
data=JSONParser().parse(request)
serializer=SnippetSerializer(data=data)
ifserializer.is_valid():
serializer.save()
returnJSONResponse(serializer.data,status=201)
else:
returnJSONResponse(serializer.errors,status=400)

注意，因为我们要通过client向该viewpost一个请求，所以我们要将该view标注为csrf_exempt,以说明不是一个CSRF事件。
NotethatbecausewewanttobeabletoPOSTtothisviewfromclientsthatwon'thaveaCSRFtokenweneedtomarktheviewascsrf_exempt.Thisisn'tsomethingthatyou'dnormallywanttodo,andRESTframeworkviewsactuallyusemoresensiblebehaviorthanthis,butit'lldoforourpurposesrightnow.
我们也需要一个view来操作一个单独的Snippet，以便能更新／删除该对象。

@csrf_exempt
defsnippet_detail(request,pk):
"""
Retrieve,updateordeleteacodesnippet.
"""
try:
snippet=Snippet.objects.get(pk=pk)
exceptSnippet.DoesNotExist:
returnHttpResponse(status=404)

ifrequest.method=='GET':
serializer=SnippetSerializer(snippet)
returnJSONResponse(serializer.data)

elifrequest.method=='PUT':
data=JSONParser().parse(request)
serializer=SnippetSerializer(snippet,data=data)
ifserializer.is_valid():
serializer.save()
returnJSONResponse(serializer.data)
else:
returnJSONResponse(serializer.errors,status=400)

elifrequest.method=='DELETE':
snippet.delete()
returnHttpResponse(status=204)

将views.py保存，在Snippets目录下面创建urls.py,添加以下内容：

urlpatterns=patterns('snippets.views',
url(r'^snippets/$','snippet_list'),
url(r'^snippets/(?P<pk>[0-9]+)/$','snippet_detail'),
)

注意我们有些边缘事件没有处理，服务器可能会抛出500异常。
8.测试

现在我们启动server来测试我们的Snippet。

在pythonmange.pyshell终端下执行（如果前面进入还没有退出）

>>quit()

执行下面的命令，运行我们的server：

pythonmanage.pyrunserver

Validatingmodels...

0errorsfound
Djangoversion1.4.3,usingsettings'tutorial.settings'
Developmentserverisrunningathttp://127.0.0.1:8000/
QuittheserverwithCONTROL-C.

新开一个terminal来测试我们的server

序列化：

urlhttp://127.0.0.1:8000/snippets/

[{"id":1,"title":"","code":"print\"hello,world\"\n","linenos":false,"language":"python","style":"friendly"}]
urlhttp://127.0.0.1:8000/snippets/1/

{"id":1,"title":"","code":"print\"hello,world\"\n","linenos":false,"language":"python","style":"friendly"}

RequestandResponse
1.RequestObject ——Request对象

restframework引入了一个继承自HttpRequest的Request对象，该对象提供了对请求的更灵活解析。request对象的核心部分是request.data属性，类似于request.post,但在使用WEBAPI时，request.data更有效。

（1）request.POST #Onlyhandlesformdata. Onlyworksfor'POST'method.
（2）request.DATA #Handlesarbitrarydata. WorksanyHTTPrequestwithcontent.
2.ResponseObject——Response对象
restframework引入了一个Response对象，它继承自TemplateResponse对象。它获得未渲染的内容并通过内容协商contentnegotiation来决定正确的contenttype返回给client。

returnResponse(data) #Renderstocontenttypeasrequestedbytheclient.
3.StatusCodes
在views当中使用数字化的HTTP状态码，会使你的代码不宜阅读，且不容易发现代码中的错误。restframework为每个状态码提供了更明确的标识。例如HTTP_400_BAD_REQUEST。相比于使用数字，在整个views中使用这类标识符将更好。
4.封装APIviews

在编写APIviews时，RESTFramework提供了两种wrappers：

1).@api_viwe装饰器——函数级别

2).APIView类——类级别

这两种封装器提供了许多功能，例如，确保在view当中能够接收到Request实例；往Response中增加内容以便内容协商contentnegotiation机制能够执行。

封装器也提供一些行为，例如在适当的时候返回405MethordNotAllowed响应；在访问多类型的输入request.DATA时，处理任何的ParseError异常。
5.汇总

我们开始用这些新的组件来写一些views。

我们不在需要JESONResponse类（在前一篇中创建），将它删除。删除后我们开始稍微重构下我们的view

fromrest_frameworkimportstatus
fromrest_framework.decoratorsimportapi_view
fromrest_framework.responseimportResponse
fromsnippets.modelsimportSnippet
fromsnippets.serializersimportSnippetSerializer

@api_view(['GET','POST'])
defsnippet_list(request):
"""
Listallsnippets,orcreateanewsnippet.
"""
ifrequest.method=='GET':
snippets=Snippet.objects.all()
serializer=SnippetSerializer(snippets)
returnResponse(serializer.data)

elifrequest.method=='POST':
serializer=SnippetSerializer(data=request.DATA)
ifserializer.is_valid():
serializer.save()
returnResponse(serializer.data,status=status.HTTP_201_CREATED)
else:
returnResponse(serializer.errors,status=status.HTTP_400_BAD_REQUEST)

上面的代码是对我们之前代码的改进。看上去更简洁，也更类似于django的formsapi形式。我们也采用了状态码，使返回值更加明确。
下面是对单个snippet操作的view更新：

@api_view(['GET','PUT','DELETE'])
defsnippet_detail(request,pk):
"""
Retrieve,updateordeleteasnippetinstance.
"""
try:
snippet=Snippet.objects.get(pk=pk)
exceptSnippet.DoesNotExist:
returnResponse(status=status.HTTP_404_NOT_FOUND)

ifrequest.method=='GET':
serializer=SnippetSerializer(snippet)
returnResponse(serializer.data)

elifrequest.method=='PUT':
serializer=SnippetSerializer(snippet,data=request.DATA)
ifserializer.is_valid():
serializer.save()
returnResponse(serializer.data)
else:
returnResponse(serializer.errors,status=status.HTTP_400_BAD_REQUEST)

elifrequest.method=='DELETE':
snippet.delete()
returnResponse(status=status.HTTP_204_NO_CONTENT)

注意，我们并没有明确的要求requests或者responses给出contenttype。request.DATA可以处理输入的json请求，也可以输入yaml和其他格式。类似的在response返回数据时，RESTFramework返回正确的contenttype给client。

6.给URLs增加可选的格式后缀

利用在response时不需要指定contenttype这一事实，我们在API端增加格式的后缀。使用格式后缀，可以明确的指出使用某种格式，意味着我们的API可以处理类似http://example.com/api/items/4.json.的URL。

增加format参数在views中，如：

defsnippet_list(request,format=None):
and

defsnippet_detail(request,pk,format=None):

现在稍微改动urls.py文件，在现有的URLs中添加一个格式后缀pattterns(format_suffix_patterns):

fromdjango.conf.urlsimportpatterns,url
fromrest_framework.urlpatternsimportformat_suffix_patterns

urlpatterns=patterns('snippets.views',
url(r'^snippets/$','snippet_list'),
url(r'^snippets/(?P<pk>[0-9]+)$','snippet_detail'),
)

urlpatterns=format_suffix_patterns(urlpatterns)

这些额外的urlpatterns并不是必须的。

Python的Django REST框架中的序列化及请求和返回

热门推荐

随机推荐