相较于使用基于方法(function based)的视图,我们更加倾向使用基于类(class based)的视图。接
下来,你将看到这是一个强大的模式,是我们能够重用公共的功能,并且,帮我们减少重复的造轮子。
我们现在开始了。首先,重写根视图(root view),变成基于类的视图。所涉及的,只是对 views.py 文件的一点重构。
使用基于 APIView 类的视图
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
from
testapps.models
import
Testapp
from
testapps.serializers
import
TestappSerializer
from
django.http
import
Http404
from
rest_framework.views
import
APIView
from
rest_framework.response
import
Response
from
rest_framework
import
status
class
TestappList(APIView):
"""
列出所有代码片段(testapps), 或者新建一个代码片段(testapp).
"""
def
get(
self
, request,
format
=
None
):
testapps
=
Testapp.objects.
all
()
serializer
=
TestappSerializer(testapps, many
=
True
)
return
Response(serializer.data)
def
post(
self
, request,
format
=
None
):
serializer
=
TestappSerializer(data
=
request.data)
if
serializer.is_valid():
serializer.save()
return
Response(serializer.data, status
=
status.HTTP_201_CREATED)
return
Response(serializer.errors, status
=
status.HTTP_400_BAD_REQUEST)
|
至此为止,一切顺利。看起来,跟基于方法的差别不大,但我们将各个 HTTP 请求方法之间,做了更好的分离。接着,我们将同样的更改我们,处理片段详细的视图,继续我们的 views.py 文件:
class TestappDetail(APIView):
至此为止,一切顺利。看起来,跟基于方法的差别不大,但我们将各个 HTTP 请求方法之间,做了更
好的分离。接着,我们将同样的更改我们,处理片段详细的视图,继续我们的 views.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
|
class
TestappDetail(APIView):
"""
读取, 更新 or 删除一个代码片段(testapp)实例(instance).
"""
def
get_object(
self
, pk):
try
:
return
Testapp.objects.get(pk
=
pk)
except
Testapp.DoesNotExist:
raise
Http404
def
get(
self
, request, pk,
format
=
None
):
testapp
=
self
.get_object(pk)
serializer
=
TestappSerializer(testapp)
return
Response(serializer.data)
def
put(
self
, request, pk,
format
=
None
):
testapp
=
self
.get_object(pk)
serializer
=
TestappSerializer(testapp, data
=
request.data)
if
serializer.is_valid():
serializer.save()
return
Response(serializer.data)
return
Response(serializer.errors, status
=
status.HTTP_400_BAD_REQUEST)
def
delete(
self
, request, pk,
format
=
None
):
testapp
=
self
.get_object(pk)
testapp.delete()
return
Response(status
=
status.HTTP_204_NO_CONTENT)
|
看起来不错。但还是跟基于方法的视图,差别不多。
我们也需要重构 urls.py文件,因为我们现在使用的是基于类的视图。
1
2
3
4
5
6
7
8
9
10
|
from
django.conf.urls
import
url
from
rest_framework.urlpatterns
import
format_suffix_patterns
from
testapp
import
views
urlpatterns
=
[
url(r
'^testapp/$'
, views.TestappList.as_view()),
url(r
'^testapp/(?P<pk>[0-9]+)/$'
, views.TestappDetail.as_view()),
]
urlpatterns
=
format_suffix_patterns(urlpatterns)
|
好,搞定。如果你跑起开发者服务器,应该跟之前的效果是一样的。
使用 Mixins 类的视图
使用类视图的一大好处是,我们可以很容易地,组成可重复使用的行为。
目前为止,我们所用的增删改查操作,在我们创建的,任何支持模型的视图里,都没有太大区别。这些
通用的行为,在 REST framework的 Mixin类中,都已经实现了。
让我们看看,使用混合类,如何组建视图。下面同样是我们的 views.py 模块:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
from
testapp.models
import
Testapp
from
testapp.serializers
import
Testapperializer
from
rest_framework
import
mixins
from
rest_framework
import
generics
class
TestappList(mixins.ListModelMixin,
mixins.CreateModelMixin,
generics.GenericAPIView):
queryset
=
Testapp.objects.
all
()
serializer_class
=
Testapperializer
def
get(
self
, request,
*
args,
*
*
kwargs):
return
self
.
list
(request,
*
args,
*
*
kwargs)
def
post(
self
, request,
*
args,
*
*
kwargs):
return
self
.create(request,
*
args,
*
*
kwargs)
|
我们会花一些时间来审查一下,这里发生的事情。我们使用 GenericAPIView 创建了我们的视图,并且
加入了 ListModelMixin 和 CreateModelMixin 。
基本类提供了核心的功能,Mixin 类提供了 .list() 和 .create() 行为。然后,我们显式地在 get
和 post 方法里面,放入对应的行动。非常简单,但目前够用。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
class
TestappDetail(mixins.RetrieveModelMixin,
mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
generics.GenericAPIView):
queryset
=
Testapp.objects.
all
()
serializer_class
=
TestappSerializer
def
get(
self
, request,
*
args,
*
*
kwargs):
return
self
.retrieve(request,
*
args,
*
*
kwargs)
def
put(
self
, request,
*
args,
*
*
kwargs):
return
self
.update(request,
*
args,
*
*
kwargs)
def
delete(
self
, request,
*
args,
*
*
kwargs):
return
self
.destroy(request,
*
args,
*
*
kwargs)
|
非常的类似。我们使用了 GenericAPIView 类提供了核心功能,而 Mixin 类提供了 .retrieve()
,.update() 和 .destroy() 行为。
使用 Generic 类的视图
使用混 Mixin 类重新视图,相比之前,我们减少了一些代码,但我们还可以更进一步。REST framework
提供了一套已经实现了 Mixin 类的 Generic 视图,我们可以使我们的 views.py 模块,更加瘦身!
1
2
3
4
5
6
7
8
9
10
11
|
from
testapps.models
import
Testapp
from
testapps.serializers
import
TestappSerializer
from
rest_framework
import
generics
class
TestappList(generics.ListCreateAPIView):
queryset
=
Testapp.objects.
all
()
serializer_class
=
TestappSerializer
class
TestappDetail(generics.RetrieveUpdateDestroyAPIView):
queryset
=
Testapp.objects.
all
()
serializer_class
=
TestappSerializer
|
哇噻~这下够简洁了。代码看起来像是很厉害的,干净的,地道的 Django。