视图说明
1. 两个基类
1）APIView
rest_framework.views.APIView
APIView是REST framework提供的所有视图的基类，继承自Django的View父类。
APIView与View的不同之处在于：
- 传入到视图方法中的是REST framework的
Request对象，而不是Django的HttpRequeset对象； - 视图方法可以返回REST framework的
Response对象，视图会为响应数据设置（render）符合前端要求的格式； - 任何
APIException异常都会被捕获到，并且处理成合适的响应信息； - 在进行dispatch()分发前，会对请求进行身份认证、权限检查、流量控制。
支持定义的属性：
- authentication_classes 列表或元祖，身份认证类
- permissoin_classes 列表或元祖，权限检查类
- throttle_classes 列表或元祖，流量控制类
在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。
举例：
-
from rest_framework.views import APIView -
from rest_framework.response import Response -
# url(r'^books/$', views.BookListView.as_view()), -
class BookListView(APIView): -
def get(self, request): -
books = BookInfo.objects.all() -
serializer = BookInfoSerializer(books, many=True) -
return Response(serializer.data)
2）GenericAPIView
rest_framework.generics.GenericAPIView
继承自APIVIew，主要增加了操作序列化器和数据库查询的方法，作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时，可搭配一个或多个Mixin扩展类。
提供的关于序列化器使用的属性与方法
-
属性：
- serializer_class 指明视图使用的序列化器
-
方法：
-
get_serializer_class(self)
返回序列化器类，默认返回
serializer_class，可以重写，例如：-
def get_serializer_class(self): -
if self.request.user.is_staff: -
return FullAccountSerializer -
return BasicAccountSerializer
-
-
get_serializer(self, args, *kwargs)
返回序列化器对象，主要用来提供给Mixin扩展类使用，如果我们在视图中想要获取序列化器对象，也可以直接调用此方法。
注意，该方法在提供序列化器对象的时候，会向序列化器对象的context属性补充三个数据：request、format、view，这三个数据对象可以在定义序列化器时使用。
-
request 当前视图的请求对象
-
view 当前请求的类视图对象
-
format 当前请求期望返回的数据格式
-
-
提供的关于数据库查询的属性与方法
-
属性：
- queryset 指明使用的数据查询集
-
方法：
-
get_queryset(self)
返回视图使用的查询集，主要用来提供给Mixin扩展类使用，是列表视图与详情视图获取数据的基础，默认返回
queryset属性，可以重写，例如：-
def get_queryset(self): -
user = self.request.user -
return user.accounts.all()
-
-
get_object(self)
返回详情视图所需的模型类数据对象，主要用来提供给Mixin扩展类使用。
在试图中可以调用该方法获取详情信息的模型类对象。
若详情访问的模型类对象不存在，会返回404。
该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。
举例：
-
# url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()), -
class BookDetailView(GenericAPIView): -
queryset = BookInfo.objects.all() -
serializer_class = BookInfoSerializer -
def get(self, request, pk): -
book = self.get_object() # get_object()方法根据pk参数查找queryset中的数据对象 -
serializer = self.get_serializer(book) -
return Response(serializer.data)
-
-
其他可以设置的属性
- pagination_class 指明分页控制类
- filter_backends 指明过滤控制后端
2. 五个扩展类
作用：
提供了几种后端视图（对数据资源进行曾删改查）处理流程的实现，如果需要编写的视图属于这五种，则视图可以通过继承相应的扩展类来复用代码，减少自己编写的代码量。
这五个扩展类需要搭配GenericAPIView父类，因为五个扩展类的实现需要调用GenericAPIView提供的序列化器与数据库查询的方法。
1）ListModelMixin
列表视图扩展类，提供list(request, *args, **kwargs)方法快速实现列表视图，返回200状态码。
该Mixin的list方法会对数据进行过滤和分页。
源代码：
-
class ListModelMixin(object): -
""" -
List a queryset. -
""" -
def list(self, request, *args, **kwargs): -
# 过滤 -
queryset = self.filter_queryset(self.get_queryset()) -
# 分页 -
page = self.paginate_queryset(queryset) -
if page is not None: -
serializer = self.get_serializer(page, many=True) -
return self.get_paginated_response(serializer.data) -
# 序列化 -
serializer = self.get_serializer(queryset, many=True) -
return Response(serializer.data)
举例：
-
from rest_framework.mixins import ListModelMixin -
class BookListView(ListModelMixin, GenericAPIView): -
queryset = BookInfo.objects.all() -
serializer_class = BookInfoSerializer -
def get(self, request): -
return self.list(request)
2）CreateModelMixin
创建视图扩展类，提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码。
如果序列化器对前端发送的数据验证失败，返回400错误。
源代码：
-
class CreateModelMixin(object): -
""" -
Create a model instance. -
""" -
def create(self, request, *args, **kwargs): -
# 获取序列化器 -
serializer = self.get_serializer(data=request.data) -
# 验证 -
serializer.is_valid(raise_exception=True) -
# 保存 -
self.perform_create(serializer) -
headers = self.get_success_headers(serializer.data) -
return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers) -
def perform_create(self, serializer): -
serializer.save() -
def get_success_headers(self, data): -
try: -
return {'Location': str(data[api_settings.URL_FIELD_NAME])} -
except (TypeError, KeyError): -
return {}
3） RetrieveModelMixin
详情视图扩展类，提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象。
如果存在，返回200， 否则返回404。
源代码：
-
class RetrieveModelMixin(object): -
""" -
Retrieve a model instance. -
""" -
def retrieve(self, request, *args, **kwargs): -
# 获取对象，会检查对象的权限 -
instance = self.get_object() -
# 序列化 -
serializer = self.get_serializer(instance) -
return Response(serializer.data)
举例：
-
class BookDetailView(RetrieveModelMixin, GenericAPIView): -
queryset = BookInfo.objects.all() -
serializer_class = BookInfoSerializer -
def get(self, request, pk): -
return self.retrieve(request)
4）UpdateModelMixin
更新视图扩展类，提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象。
同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新。
成功返回200，序列化器校验数据失败时，返回400错误。
源代码：
-
class UpdateModelMixin(object): -
""" -
Update a model instance. -
""" -
def update(self, request, *args, **kwargs): -
partial = kwargs.pop('partial', False) -
instance = self.get_object() -
serializer = self.get_serializer(instance, data=request.data, partial=partial) -
serializer.is_valid(raise_exception=True) -
self.perform_update(serializer) -
if getattr(instance, '_prefetched_objects_cache', None): -
# If 'prefetch_related' has been applied to a queryset, we need to -
# forcibly invalidate the prefetch cache on the instance. -
instance._prefetched_objects_cache = {} -
return Response(serializer.data) -
def perform_update(self, serializer): -
serializer.save() -
def partial_update(self, request, *args, **kwargs): -
kwargs['partial'] = True -
return self.update(request, *args, **kwargs)
5）DestroyModelMixin
删除视图扩展类，提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象。
成功返回204，不存在返回404。
源代码：
-
class DestroyModelMixin(object): -
""" -
Destroy a model instance. -
""" -
def destroy(self, request, *args, **kwargs): -
instance = self.get_object() -
self.perform_destroy(instance) -
return Response(status=status.HTTP_204_NO_CONTENT) -
def perform_destroy(self, instance): -
instance.delete()
3. 几个可用子类视图
1） CreateAPIView
提供 post 方法
继承自： GenericAPIView、CreateModelMixin
2）ListAPIView
提供 get 方法
继承自：GenericAPIView、ListModelMixin
3）RetrieveAPIView
提供 get 方法
继承自: GenericAPIView、RetrieveModelMixin
4）DestoryAPIView
提供 delete 方法
继承自：GenericAPIView、DestoryModelMixin
5）UpdateAPIView
提供 put 和 patch 方法
继承自：GenericAPIView、UpdateModelMixin
6）RetrieveUpdateAPIView
提供 get、put、patch方法
继承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin
7）RetrieveUpdateDestoryAPIView
提供 get、put、patch、delete方法
继承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin
视图集ViewSet
使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中：
- list() 提供一组数据
- retrieve() 提供单个数据
- create() 创建数据
- update() 保存数据
- destory() 删除数据
ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等。
视图集只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上。如：
-
class BookInfoViewSet(viewsets.ViewSet): -
def list(self, request): -
books = BookInfo.objects.all() -
serializer = BookInfoSerializer(books, many=True) -
return Response(serializer.data) -
def retrieve(self, request, pk=None): -
try: -
books = BookInfo.objects.get(id=pk) -
except BookInfo.DoesNotExist: -
return Response(status=status.HTTP_404_NOT_FOUND) -
serializer = BookInfoSerializer(books) -
return Response(serializer.data)
在设置路由时，我们可以如下操作
-
urlpatterns = [ -
url(r'^books/$', BookInfoViewSet.as_view({'get':'list'}), -
url(r'^books/(?P<pk>\d+)/$', BookInfoViewSet.as_view({'get': 'retrieve'}) -
]
1. 常用视图集父类
1） ViewSet
继承自APIView与ViewSetMixin，作用也与APIView基本类似，提供了身份认证、权限校验、流量管理等。
ViewSet主要通过继承ViewSetMixin来实现在调用as_view()时传入字典（如{'get':'list'}）的映射处理工作。
在ViewSet中，没有提供任何动作action方法，需要我们自己实现action方法。
2）GenericViewSet
使用ViewSet通常并不方便，因为list、retrieve、create、update、destory等方法都需要自己编写，而这些方法与前面讲过的Mixin扩展类提供的方法同名，所以我们可以通过继承Mixin扩展类来复用这些方法而无需自己编写。但是Mixin扩展类依赖与GenericAPIView，所以还需要继承GenericAPIView。
GenericViewSet就帮助我们完成了这样的继承工作，继承自GenericAPIView与ViewSetMixin，在实现了调用as_view()时传入字典（如{'get':'list'}）的映射处理工作的同时，还提供了GenericAPIView提供的基础方法，可以直接搭配Mixin扩展类使用。
举例：
-
from rest_framework import mixins -
from rest_framework.viewsets import GenericViewSet -
from rest_framework.decorators import action -
class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet): -
queryset = BookInfo.objects.all() -
serializer_class = BookInfoSerializer
url的定义
-
urlpatterns = [ -
url(r'^books/$', views.BookInfoViewSet.as_view({'get': 'list'})), -
url(r'^books/(?P<pk>\d+)/$', views.BookInfoViewSet.as_view({'get': 'retrieve'})), -
]
3）ModelViewSet
继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。
4）ReadOnlyModelViewSet
继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin。
2. 视图集中定义附加action动作
在视图集中，除了上述默认的方法动作外，还可以添加自定义动作。
举例：
-
from rest_framework import mixins -
from rest_framework.viewsets import GenericViewSet -
from rest_framework.decorators import action -
class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet): -
queryset = BookInfo.objects.all() -
serializer_class = BookInfoSerializer -
def latest(self, request): -
""" -
返回最新的图书信息 -
""" -
book = BookInfo.objects.latest('id') -
serializer = self.get_serializer(book) -
return Response(serializer.data) -
def read(self, request, pk): -
""" -
修改图书的阅读量数据 -
""" -
book = self.get_object() -
book.bread = request.data.get('read') -
book.save() -
serializer = self.get_serializer(book) -
return Response(serializer.data)
url的定义
-
urlpatterns = [ -
url(r'^books/$', views.BookInfoViewSet.as_view({'get': 'list'})), -
url(r'^books/latest/$', views.BookInfoViewSet.as_view({'get': 'latest'})), -
url(r'^books/(?P<pk>\d+)/$', views.BookInfoViewSet.as_view({'get': 'retrieve'})), -
url(r'^books/(?P<pk>\d+)/read/$', views.BookInfoViewSet.as_view({'put': 'read'})), -
]
3. action属性
在视图集中，我们可以通过action对象属性来获取当前请求视图集时的action动作是哪个。
例如：
-
def get_serializer_class(self): -
if self.action == 'create': -
return OrderCommitSerializer -
else: -
return OrderDataSerializer
4. 视图集的继承关系
2479
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
