Django REST framwork 提供的视图的主要作用:
控制序列化器的执行(检验、保存、转换数据)控制数据库查询的执行DRF框架为了方便进行视图的编写,提供了2个视图基类,5个Mixin扩展类和9个子类视图。
APIView
GenericAPIView
ListModelMixin
CreateModelMixin
RetrieveModelMixin
UpdateModelMixin
DestroyModelMixin
CreateAPIView
ListAPIView
RetrieveAPIView
DestoryAPIView
UpdateAPIView
ListCreateAPIView
RetrieveUpdateAPIView
RetrieveDestroyAPIView
RetrieveUpdateDestoryAPIView
视图集:将操作同一组资源的处理方法放在同一个类中,这个类叫做视图集。如:
前面在实现图书管理的5个API时,需要两个类视图,而如果视图集,只需要一个即可。
APIView是REST framework提供的所有视图的基类,继承自Django的View类。
APIView与View的不同之处在于:
传入到视图中的request对象是REST framework的Request对象,而不再是Django原始的HttpRequest对象;视图可以直接返回REST framework的Response对象,响应数据会根据客户端请求头Accpet自动转换为对应的格式进行返回;任何APIException异常都会被捕获到,并且处理成合适的响应信息返回给客户端;在进行dispatch()分发前,会对请求进行身份认证、权限检查、流量控制。视图继承APIView之后,传入视图的request对象是DRF框架提供的Request类的对象,Request类的对象有两个属性:
属性名
说明
data
包含解析之后的请求体数据,已经解析为了字典或类字典,相当于Django原始request对象的body、POST、FILES属性。
query_params
包含解析之后的查询字符串数据,相当于Django原始request对象的GET属性
视图继承APIView之后,响应时可以统一返回Response对象,格式如下:
from rest_framework.response import Response response = Response(<原始响应数据>)
原始的响应数据,会根据客户端请求头的Accpet,自动转换为对应的格式并进行返回,如:
Accept请求头
说明
application/json
服务器会将原始响应数据转换为json数据进行返回,没指定Accept时,默认返回json
text/html
服务器会将原始响应数据转换为html网页进行返回;
使用APIView进一步改写序列化器改写之后的RestAPI。
# views.py from rest_framework.views import APIView from rest_framework import status from django.http import Http404 from booktest.serializers import BookInfoSerializer # /books/ class BookListView(APIView): """ 获取所有图书、增加图书 """ def get(self, request): """ 获取所有的图书数据 """ queryset = BookInfo.objects.all() # 序列化所有图书数据 serializer = BookInfoSerializer(queryset, many=True) return Response(serializer.data) def post(self, request): """ 新增一个图书数据 """ # 反序列化-数据校验 serializer = BookInfoSerializer(data=request.data) serializer.is_valid(raise_exception=True) # 反序列化-数据保存(save内部会调用序列化器类的create方法) serializer.save() return Response(serializer.data, status=status.HTTP_201_CREATED) # /books/(?P<pk>\d+)/ class BookDetailView(APIView): """ 获取、修改、删除指定图书 """ def get(self, request, pk): """ 获取指定图书 """ try: book = BookInfo.objects.get(pk=pk) except BookInfo.DoesNotExist: raise Http404 # 将图书数据进行序列化 serializer = BookInfoSerializer(book) return Response(serializer.data) def put(self, request, pk): """ 修改指定图书 """ try: book = BookInfo.objects.get(pk=pk) except BookInfo.DoesNotExist: raise Http404 # 反序列化-数据校验 serializer = BookInfoSerializer(book, data=request.data) serializer.is_valid(raise_exception=True) # 反序列化-数据保存(save内部会调用序列化器类的update方法) serializer.save() return Response(serializer.data) def delete(self, request, pk): """ 删除指定图书: """ try: book = BookInfo.objects.get(pk=pk) except BookInfo.DoesNotExist: raise Http404 book.delete() return Response(status=status.HTTP_204_NO_CONTENT)继承自APIVIew,在APIView功能基础上,主要增加了操作序列化器和数据库查询的方法,作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时,可搭配一个或多个Mixin扩展类。
返回序列化器类,默认返回serializer_class,可以重写。
get_serializer(self, args, **kwargs)返回创建序列化器类的对象,如果我们在视图中想要获取序列化器对象,可以直接调用此方法。
返回视图使用的查询集,默认返回queryset属性,可以重写。
get_object(self)返回从视图使用的查询集中查询指定的对象(默认根据pk进行查询),如查询不到,此方法会抛出Http404异常。
使用GenericAPIView进一步改写APIView改写之后的RestAPI。
# views.py from rest_framework.generics import GenericAPIView from rest_framework import status from booktest.serializers import BookInfoSerializer from booktest.models import BookInfo # /books/ class BookListView(GenericAPIView): """ 获取所有图书、增加图书 """ # 指定视图所使用的序列化器类 serializer_class = BookInfoSerializer # 指定视图所使用的查询集 queryset = BookInfo.objects.all() def get(self, request): """ 获取所有的图书数据 """ queryset = self.get_queryset() # 序列化所有图书数据 serializer = self.get_serializer(queryset, many=True) return Response(serializer.data) def post(self, request): """ 新增一个图书数据 """ # 反序列化-数据校验 serializer = self.get_serializer(data=request.data) serializer.is_valid(raise_exception=True) # 反序列化-数据保存(save内部会调用序列化器类的create方法) serializer.save() return Response(serializer.data, status=status.HTTP_201_CREATED) # /books/(?P<pk>\d+)/ class BookDetailView(GenericAPIView): """ 获取、修改、删除指定图书 """ # 指定视图所使用的序列化器类 serializer_class = BookInfoSerializer # 指定视图所使用的查询集 queryset = BookInfo.objects.all() def get(self, request, pk): """ 获取指定图书 """ instance = self.get_object() # 将图书数据进行序列化 serializer = BookInfoSerializer(instance) return Response(serializer.data) def put(self, request, pk): """ 修改指定图书 """ instance = self.get_object() # 反序列化-数据校验 serializer = BookInfoSerializer(instance, data=request.data) serializer.is_valid(raise_exception=True) # 反序列化-数据保存(save内部会调用序列化器类的update方法) serializer.save() return Response(serializer.data) def delete(self, request, pk): """ 删除指定图书: """ instance = self.get_object() instance.delete() return Response(status=status.HTTP_204_NO_CONTENT)使用GenericAPIView改写之后的RestAPI接口中,图书管理的各个代码已经变成了通用的代码,这些代码和视图所使用的序列化器类和查询集已经没有直接的关系,DRF已经将这些代码做了封装,就是5个Mixin扩展类。
列表视图扩展类,提供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)创建视图扩展类,提供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 {}详情视图扩展类,提供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)更新视图扩展类,提供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)删除视图扩展类,提供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()Django框架为了方便视图的编写,还提供了9个子类视图类,子类视图类同时继承了GenericAPIView和对应的Mixin扩展类,而且还提供了对应的请求处理方法。
提供 post 方法
继承自: GenericAPIView、CreateModelMixin
提供 get 方法
继承自:GenericAPIView、ListModelMixin
提供 get 方法
继承自: GenericAPIView、RetrieveModelMixin
提供 delete 方法
继承自:GenericAPIView、DestoryModelMixin
提供 put 和 patch 方法
继承自:GenericAPIView、UpdateModelMixin
提供 get 和 post 方法
继承自:GenericAPIView、ListModelMixin、CreateModelMixin
提供 get、put、patch方法
继承自: GenericAPIView、RetrieveModelMixin、UpdateModelMixin
提供 get 和 delete 方法
继承自: GenericAPIView、RetrieveModelMixin、UpdateModelMixin
提供 get、put、patch、delete方法
继承自:GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin