欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

RESTframework中的视图说明

程序员文章站 2024-03-26 09:53:11
...
1. APIView

-From rest_framework.views import APIView

  • APIView是REST框架提供的所有试图的基类,继承自Django的View父类
  • APIView和View的不同之处:
  • 传入到视图方法中的是REST框架的Request对象,而不是Django的HttpRequest对象
    任何的APIException异常都会被捕获到,并且处理成合适的相应信息(Json格式)
    在进行调度()分发前,会对请求进行身份认证,权限检查,流量控制
  • 相同之处:
    在APIView中仍以常规的类视图定义方法来实现get(),post()或是其他请求方式的方法
2. GenericAPIView

rest_framework.generics.GenericAPIView
继承自APIView,增加了对于列表视图和详情视图可能用到的通用支持方法。使用时,通常会搭配一个或者多个的Mixin扩展类
queryset=查询集
serializer_class=序列化器的类型
get_queryset 同queryset,是GenericAPIView中提供的方法
get_object可以根据逐渐查询对象
get_serializer同serializer_class,是GenericAPIView中提供的方法

3. 和GenericAPIView一同搭配使用的还有五个扩展类,他们分别是ListModelMixin, CreateModelMixin,UpdataModelMixin,RetrieveModelMixin,DestroyModelMixin

① ListModelMixin:(即查询所有)

提供了list(request,*args,**kwargs)方法快速实现列表视图,返回的是状态码是默认的200

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 GunsListView(ListModelMixin,GenericAPIView):
	# GunInfo.object.all() 即是查询集
	queryset = GunInfo.object.all()
	# 这里的GunInfoSerializer即是我们创建的与模型类对应的序列化器
	serializer_class = GunInfoSerializer

② CreateModelMixin(创建对象)
  • 创建视图的扩展类,提供类create(request,*args,**kwargs)方法快速实现创建资源的视图,成功后返回201状态码
  • 如果序列化器对前端发送的数据验证失败,则返回400的错误
    CreatModelMixin的源代码展示:
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 {}
③ RetrieveModelMixin
  • 详情视图扩展类(即查询单个对象),提供了类retrieve方法
retrieve(request,*args,**kwargs)

可以快速实现返回一个存在的数据对象
如果存在,返回200,否则就返回404
RertieveModelMixin源码展示:

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)
④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)
⑤DestoryModelMixin(删除)
  • 删除视图扩展类,提供destroy(request,*args,**kwargs)方法,可以快速实现删除一个存在的数据对象
源代码展示:
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()