zoukankan      html  css  js  c++  java
  • django 视图

    1.Request 与 Response

    1. Request

    REST framework 传入视图的request对象不再是Django默认的HttpRequest对象,而是REST framework提供的扩展了HttpRequest类的Request类的对象。

    REST framework 提供了Parser解析器,在接收到请求后会自动根据Content-Type指明的请求数据类型(如JSON、表单等)将请求数据进行parse解析,解析为类字典对象保存到Request对象中。

    Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。

    无论前端发送的哪种格式的数据,我们都可以以统一的方式读取数据。

    常用属性

    1).data

    request.data 返回解析之后的请求体数据。类似于Django中标准的request.POST和 request.FILES属性,但提供如下特性:

    • 包含了解析之后的文件和非文件数据
    • 包含了对POST、PUT、PATCH请求方式解析后的数据
    • 利用了REST framework的parsers解析器,不仅支持表单类型数据,也支持JSON数据

    2).query_params

    request.query_params与Django标准的request.GET相同,只是更换了更正确的名称而已。

    2. Response

    rest_framework.response.Response

    REST framework提供了一个响应类Response,使用该类构造响应对象时,响应的具体数据内容会被转换(render渲染)成符合前端需求的类型。

    构造方式

    Response(data, status=None, template_name=None, headers=None, content_type=None)
    

    data数据不要是render处理之后的数据,只需传递python的内建类型数据即可,REST framework会使用renderer渲染器处理data

    data不能是复杂结构的数据,如Django的模型类对象,对于这样的数据我们可以使用Serializer序列化器序列化处理后(转为了Python字典类型)再传递给data参数。

    参数说明:

    • data: 为响应准备的序列化处理后的数据;
    • status: 状态码,默认200;
    • template_name: 模板名称,如果使用HTMLRenderer 时需指明;
    • headers: 用于存放响应头信息的字典;
    • content_type: 响应数据的Content-Type,通常此参数无需传递,REST framework会根据前端所需类型数据来设置该参数。

    3. 状态码

    为了方便设置状态码,REST framewrok在rest_framework.status模块中提供了常用状态码常量。

    1)信息告知 - 1xx
    HTTP_100_CONTINUE
    HTTP_101_SWITCHING_PROTOCOLS
    
    2)成功 - 2xx
    HTTP_200_OK
    HTTP_201_CREATED
    HTTP_202_ACCEPTED
    HTTP_203_NON_AUTHORITATIVE_INFORMATION
    HTTP_204_NO_CONTENT
    HTTP_205_RESET_CONTENT
    HTTP_206_PARTIAL_CONTENT
    HTTP_207_MULTI_STATUS
    
    3)重定向 - 3xx
    HTTP_300_MULTIPLE_CHOICES
    HTTP_301_MOVED_PERMANENTLY
    HTTP_302_FOUND
    HTTP_303_SEE_OTHER
    HTTP_304_NOT_MODIFIED
    HTTP_305_USE_PROXY
    HTTP_306_RESERVED
    HTTP_307_TEMPORARY_REDIRECT
    
    4)客户端错误 - 4xx
    HTTP_400_BAD_REQUEST
    HTTP_401_UNAUTHORIZED
    HTTP_402_PAYMENT_REQUIRED
    HTTP_403_FORBIDDEN
    HTTP_404_NOT_FOUND
    HTTP_405_METHOD_NOT_ALLOWED
    HTTP_406_NOT_ACCEPTABLE
    HTTP_407_PROXY_AUTHENTICATION_REQUIRED
    HTTP_408_REQUEST_TIMEOUT
    HTTP_409_CONFLICT
    HTTP_410_GONE
    HTTP_411_LENGTH_REQUIRED
    HTTP_412_PRECONDITION_FAILED
    HTTP_413_REQUEST_ENTITY_TOO_LARGE
    HTTP_414_REQUEST_URI_TOO_LONG
    HTTP_415_UNSUPPORTED_MEDIA_TYPE
    HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
    HTTP_417_EXPECTATION_FAILED
    HTTP_422_UNPROCESSABLE_ENTITY
    HTTP_423_LOCKED
    HTTP_424_FAILED_DEPENDENCY
    HTTP_428_PRECONDITION_REQUIRED
    HTTP_429_TOO_MANY_REQUESTS
    HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
    HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS
    
    5)服务器错误 - 5xx
    HTTP_500_INTERNAL_SERVER_ERROR
    HTTP_501_NOT_IMPLEMENTED
    HTTP_502_BAD_GATEWAY
    HTTP_503_SERVICE_UNAVAILABLE
    HTTP_504_GATEWAY_TIMEOUT
    HTTP_505_HTTP_VERSION_NOT_SUPPORTED
    HTTP_507_INSUFFICIENT_STORAGE
    HTTP_511_NETWORK_AUTHENTICATION_REQUIRED
    

     

    2.视图概览

    REST framework 提供了众多的通用视图基类与扩展类,以简化视图的编写。

    视图的继承关系:

    视图的方法与属性:

     

    3.视图说明

    1. django原生View及DRF两个基类APIView  /  GenericAPIView

    1)View


    from django.http import JsonResponse
    from django.shortcuts import render
    from django.views import View
    # Create your views here.
    from book_drf.serializer import BookSerialzier
    from books.models import BookInfo
    from rest_framework.generics import ListAPIView,CreateAPIView,UpdateAPIView


    class Books(View):

    def get(self,request):
    # 1、查询所有图书对象
    books = BookInfo.objects.all()

    ser= BookSerialzier(books,many=True)

    return JsonResponse(ser.data, safe=False)

    def post(self, request):
    # 1、获取前端数据
    data = request.body.decode()
    data_dict = json.loads(data)
    # 2、验证数据
    ser= BookSerialzier(data=data_dict)
    ser.is_valid() # 验证方法

    # 3、保存数据
    ser.save()
    # 4、返回结果
    return JsonResponse(ser.data)


    class Book(View):

    def get(self,request):
    book=BookInfo.objects.get(id=1)
    ser = BookSerialzier(book)

    return JsonResponse(ser.data)


    class BookDRFView(View):
    """
    获取单一和更新和删除
    """

    def put(self, request, pk):
    # 1、获取前端数据
    data = request.body.decode()
    data_dict = json.loads(data)
    # 2、验证数据
    try:
    book = BookInfo.objects.get(id=pk)
    except:
    return JsonResponse({'error': '错误信息'}, status=400)
    ser=BookSerialzier(book,data=data_dict)
    ser.is_valid()
    # 3、更新数据
    ser.save()
    # 4、返回结果
    return JsonResponse(ser.data)

    def delete(self, request, pk):
    # 1、查询数据对象
    try:
    book = BookInfo.objects.get(id=pk)

    except:
    return JsonResponse({'error': '错误信息'}, status=400)

    book.is_delete=True
    book.save()
    return JsonResponse({})

    复制代码
    from django.http import JsonResponse
    from django.shortcuts import render
    from django.views import View
    # Create your views here.
    from book_drf.serializer import BookSerialzier
    from books.models import BookInfo
    from rest_framework.generics import ListAPIView,CreateAPIView,UpdateAPIView
    
    
    class Books(View):
        
        def get(self,request):
            # 1、查询所有图书对象
            books = BookInfo.objects.all()
    
            ser= BookSerialzier(books,many=True)
    
            return JsonResponse(ser.data, safe=False)
    
        def post(self, request):
            # 1、获取前端数据
            data = request.body.decode()
            data_dict = json.loads(data)
            # 2、验证数据
            ser= BookSerialzier(data=data_dict)
            ser.is_valid() # 验证方法
    
            # 3、保存数据
            ser.save()
            # 4、返回结果
            return JsonResponse(ser.data)
    
    
    
    
    class Book(View):
    
        def get(self,request):
            book=BookInfo.objects.get(id=1)
            ser = BookSerialzier(book)
    
            return JsonResponse(ser.data)
    
    
    class BookDRFView(View):
        """
            获取单一和更新和删除
        """
    
        def put(self, request, pk):
            # 1、获取前端数据
            data = request.body.decode()
            data_dict = json.loads(data)
            # 2、验证数据
            try:
                book = BookInfo.objects.get(id=pk)
            except:
                return JsonResponse({'error': '错误信息'}, status=400)
            ser=BookSerialzier(book,data=data_dict)
            ser.is_valid()
            # 3、更新数据
            ser.save()
            # 4、返回结果
            return JsonResponse(ser.data)
    
        def delete(self, request, pk):
            # 1、查询数据对象
            try:
                book = BookInfo.objects.get(id=pk)
    
            except:
                return JsonResponse({'error': '错误信息'}, status=400)
    
            book.is_delete=True
            book.save()
            return JsonResponse({})
    复制代码

    2)APIView

    rest_framework.views.APIView

    APIView是REST framework提供的所有视图的基类,继承自Django的View父类。

    APIViewView的不同之处在于:

    • 传入到视图方法中的是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
    class Books(APIView):
    def get(self, request):
    print(request.query_params)
    # 1、查询所有图书对象
    books = BookInfo.objects.all()

    ser = BookSerialzier(books, many=True)

    return Response(ser.data)

    def post(self, request):
    # 1、获取前端数据
    # data = request.body.decode()
    # data_dict = json.loads(data)
    data=request.data
    # 2、验证数据
    ser = BookSerialzier(data=data)
    ser.is_valid() # 验证方法

    # 3、保存数据
    ser.save()
    # 4、返回结果
    return Response(ser.data)


    class Book(APIView):
    def get(self, request):
    book = BookInfo.objects.get(id=1)
    ser = BookSerialzier(book)

    return Response(ser.data)


    class BookDRFView(APIView):
    """
    获取单一和更新和删除
    """

    def put(self, request, pk):
    # 1、获取前端数据
    # data = request.body.decode()
    # data_dict = json.loads(data)
    data=request.data
    # 2、验证数据
    try:
    book = BookInfo.objects.get(id=pk)
    except:
    return JsonResponse({'error': '错误信息'}, status=400)
    ser = BookSerialzier(book, data=data)
    ser.is_valid()
    # 3、更新数据
    ser.save()
    # 4、返回结果
    return Response(ser.data)

    def delete(self, request, pk):
    # 1、查询数据对象
    try:
    book = BookInfo.objects.get(id=pk)

    except:
    return Response({'error': '错误信息'}, status=400)

    book.is_delete = True
    book.save()
    return Response({})

    复制代码
    from rest_framework.views import APIView
    from rest_framework.response import Response
    class Books(APIView):
        def get(self, request):
            print(request.query_params)
            # 1、查询所有图书对象
            books = BookInfo.objects.all()
    
            ser = BookSerialzier(books, many=True)
    
            return Response(ser.data)
    
        def post(self, request):
            # 1、获取前端数据
            # data = request.body.decode()
            # data_dict = json.loads(data)
            data=request.data
            # 2、验证数据
            ser = BookSerialzier(data=data)
            ser.is_valid()  # 验证方法
    
            # 3、保存数据
            ser.save()
            # 4、返回结果
            return Response(ser.data)
    
    
    class Book(APIView):
        def get(self, request):
            book = BookInfo.objects.get(id=1)
            ser = BookSerialzier(book)
    
            return Response(ser.data)
    
    
    class BookDRFView(APIView):
        """
            获取单一和更新和删除
        """
    
        def put(self, request, pk):
            # 1、获取前端数据
            # data = request.body.decode()
            # data_dict = json.loads(data)
            data=request.data
            # 2、验证数据
            try:
                book = BookInfo.objects.get(id=pk)
            except:
                return JsonResponse({'error': '错误信息'}, status=400)
            ser = BookSerialzier(book, data=data)
            ser.is_valid()
            # 3、更新数据
            ser.save()
            # 4、返回结果
            return Response(ser.data)
    
        def delete(self, request, pk):
            # 1、查询数据对象
            try:
                book = BookInfo.objects.get(id=pk)
    
            except:
                return Response({'error': '错误信息'}, status=400)
    
            book.is_delete = True
            book.save()
            return Response({})
    复制代码

    2)GenericAPIView

    rest_framework.generics.GenericAPIView

    继承自APIVIew,增加了对于列表视图和详情视图可能用到的通用支持方法。通常使用时,可搭配一个或多个Mixin扩展类。

    支持定义的属性:
    • 列表视图与详情视图通用:
      • queryset 列表视图的查询集
      • serializer_class 视图使用的序列化器
    • 列表视图使用:
      • pagination_class 分页控制类
      • filter_backends 过滤控制后端
    • 详情页视图使用:
      • lookup_field 查询单一数据库对象时使用的条件字段,默认为'pk'
      • lookup_url_kwarg 查询单一数据时URL中的参数关键字名称,默认与look_field相同
    提供的方法:
    • 列表视图与详情视图通用:

      • get_queryset(self)

        返回视图使用的查询集,是列表视图与详情视图获取数据的基础,默认返回queryset属性,可以重写,例如:

        def get_queryset(self):
            user = self.request.user
            return user.accounts.all()
      • 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)

        返回序列化器对象,被其他视图或扩展类使用,如果我们在视图中想要获取序列化器对象,可以直接调用此方法。

        注意,在提供序列化器对象的时候,REST framework会向对象的context属性补充三个数据:request、format、view,这三个数据对象可以在定义序列化器时使用。

    • 详情视图使用:

      • get_object(self) 返回详情视图所需的模型类数据对象,默认使用lookup_field参数来过滤queryset。 在视图中可以调用该方法获取详情信息的模型类对象。

        若详情访问的模型类对象不存在,会返回404。

        该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。

        源代码:

        

    复制代码
        def get_object(self):
            """
            Returns the object the view is displaying.
    
            You may want to override this if you need to provide non-standard
            queryset lookups.  Eg if objects are referenced using multiple
            keyword arguments in the url conf.
            """
            queryset = self.filter_queryset(self.get_queryset())
    
            # Perform the lookup filtering.
            lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
    
            assert lookup_url_kwarg in self.kwargs, (
                'Expected view %s to be called with a URL keyword argument '
                'named "%s". Fix your URL conf, or set the `.lookup_field` '
                'attribute on the view correctly.' %
                (self.__class__.__name__, lookup_url_kwarg)
            )
    
            filter_kwargs = {self.lookup_field: self.kwargs[lookup_url_kwarg]}
            obj = get_object_or_404(queryset, **filter_kwargs)
    
            # May raise a permission denied
            self.check_object_permissions(self.request, obj)
    
            return obj
    复制代码

    举例:

    from django.http import JsonResponse,HttpRequest
    from django.shortcuts import render
    from rest_framework.generics import GenericAPIView
    from rest_framework.request import Request
    from rest_framework.response import Response

    # Create your views here.
    from book_drf.serializer import BookSerialzier
    from books.models import BookInfo

    class Books(GenericAPIView):

    queryset = BookInfo.objects.all() # 指定当前类视图使用的查询集数据
    serializer_class = BookSerialzier # 指定当前类视图使用的序列化器


    def get(self, request):
    # 1、查询所有图书对象
    books = self.get_queryset() # 获取查询集中的所有数据

    ser = self.get_serializer(books,many=True) # 使用指定序列化器,获取序列化器对象

    return Response(ser.data)

    def post(self, request):
    # 1、获取前端数据
    # data = request.body.decode()
    # data_dict = json.loads(data)
    data=request.data
    # 2、验证数据
    ser = self.get_serializer(data=data)
    ser.is_valid() # 验证方法

    # 3、保存数据
    ser.save()
    # 4、返回结果
    return Response(ser.data)


    class Book(GenericAPIView):
    def get(self, request):
    book = BookInfo.objects.get(id=1)
    ser = BookSerialzier(book)

    return Response(ser.data)


    class BookDRFView(GenericAPIView):
    """
    获取单一和更新和删除
    """

    queryset = BookInfo.objects.all() # 指定当前类视图使用的查询集数据
    serializer_class = BookSerialzier # 指定当前类视图使用的序列化器

    def put(self, request, pk):
    # 1、获取前端数据
    # data = request.body.decode()
    # data_dict = json.loads(data)
    data=request.data
    # 2、验证数据
    try:
    book = self.get_object() # 从查询集中获取指定的单一数据对象
    except:
    return JsonResponse({'error': '错误信息'}, status=400)
    ser = BookSerialzier(book, data=data)
    ser.is_valid()
    # 3、更新数据
    ser.save()
    # 4、返回结果
    return Response(ser.data)

    def delete(self, request, pk):
    # 1、查询数据对象
    try:
    book = BookInfo.objects.get(id=pk)

    except:
    return Response({'error': '错误信息'}, status=400)

    book.is_delete = True
    book.save()
    return Response({})

    复制代码
    from django.http import JsonResponse,HttpRequest
    from django.shortcuts import render
    from rest_framework.generics import GenericAPIView
    from rest_framework.request import Request
    from rest_framework.response import Response
    
    # Create your views here.
    from book_drf.serializer import BookSerialzier
    from books.models import BookInfo
    
    
    
    class Books(GenericAPIView):
    
        queryset = BookInfo.objects.all() # 指定当前类视图使用的查询集数据
        serializer_class = BookSerialzier  # 指定当前类视图使用的序列化器
    
    
        def get(self, request):
            # 1、查询所有图书对象
            books = self.get_queryset() # 获取查询集中的所有数据
    
            ser = self.get_serializer(books,many=True) # 使用指定序列化器,获取序列化器对象
    
            return Response(ser.data)
    
        def post(self, request):
            # 1、获取前端数据
            # data = request.body.decode()
            # data_dict = json.loads(data)
            data=request.data
            # 2、验证数据
            ser = self.get_serializer(data=data)
            ser.is_valid()  # 验证方法
    
            # 3、保存数据
            ser.save()
            # 4、返回结果
            return Response(ser.data)
    
    
    class Book(GenericAPIView):
        def get(self, request):
            book = BookInfo.objects.get(id=1)
            ser = BookSerialzier(book)
    
            return Response(ser.data)
    
    
    class BookDRFView(GenericAPIView):
        """
            获取单一和更新和删除
        """
    
        queryset = BookInfo.objects.all()  # 指定当前类视图使用的查询集数据
        serializer_class = BookSerialzier  # 指定当前类视图使用的序列化器
    
        def put(self, request, pk):
            # 1、获取前端数据
            # data = request.body.decode()
            # data_dict = json.loads(data)
            data=request.data
            # 2、验证数据
            try:
                book = self.get_object() # 从查询集中获取指定的单一数据对象
            except:
                return JsonResponse({'error': '错误信息'}, status=400)
            ser = BookSerialzier(book, data=data)
            ser.is_valid()
            # 3、更新数据
            ser.save()
            # 4、返回结果
            return Response(ser.data)
    
        def delete(self, request, pk):
            # 1、查询数据对象
            try:
                book = BookInfo.objects.get(id=pk)
    
            except:
                return Response({'error': '错误信息'}, status=400)
    
            book.is_delete = True
            book.save()
            return Response({})
    复制代码

    2. 五个扩展类

    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 {}
     

    举例:

    class Books(CreateModelMixin, GenericAPIView):
        queryset = BookInfo.objects.all()  # 指定当前类视图使用的查询集数据
        serializer_class = BookSerialzier  # 指定当前类视图使用的序列化器
    
        def post(self, request):
            return self.create(request)

    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)
    复制代码

    举例:

    class BookDRFView(GenericAPIView,UpdateModelMixin):
        """
            获取单一和更新
        """
    
        queryset = BookInfo.objects.all()  # 指定当前类视图使用的查询集数据
        serializer_class = BookSerialzier  # 指定当前类视图使用的序列化器
    
        def put(self, request, pk):
           return self.update(request, pk)
    复制代码

    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()
    复制代码

    举例:

    class BookDRFView(GenericAPIView,DestroyModelMixin):
        """
            单一删除
        """
    
        queryset = BookInfo.objects.all()  # 指定当前类视图使用的查询集数据
        serializer_class = BookSerialzier  # 指定当前类视图使用的序列化器
    
    
        def delete(self, request, pk):
            return self.destroy(request, pk)
    复制代码

    3. 几个可用子类视图

    1) CreateAPIView

    提供 post 方法

    继承自: GenericAPIView、CreateModelMixin

    2)ListAPIView

    提供 get 方法

    继承自:GenericAPIView、ListModelMixin

    3)RetireveAPIView

    提供 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

    举例:

    from rest_framework.generics import ListCreateAPIView,RetrieveUpdateDestroyAPIView
    
    # Create your views here.
    from book_drf.serializer import BookSerialzier
    from books.models import BookInfo
    
    
    class BooksChild(ListCreateAPIView):
    
        """
        get:
        返回所有图书信息.
    
        post:
        新建图书.
        """
    
        throttle_scope = 'contacts'
        queryset = BookInfo.objects.all()  # 指定当前类视图使用的查询集数据
        serializer_class = BookSerialzier  # 指定当前类视图使用的序列化器
    
    class BooksChildView(RetrieveUpdateDestroyAPIView):
        """
            获取单一和更新和删除
        """
        queryset = BookInfo.objects.all()  # 指定当前类视图使用的查询集数据
        serializer_class = BookSerialzier  # 指定当前类视图使用的序列化器
    复制代码

    4.视图集ViewSet

    使用视图集ViewSet,可以将一系列逻辑相关的动作放到一个类中:

    • list() 提供一组数据
    • retrieve() 提供单个数据
    • create() 创建数据
    • update() 保存数据
    • destory() 删除数据

    ViewSet视图集类不再实现get()、post()等方法,而是实现动作 action 如 list() 、create() 等。

    视图集只在使用as_view()方法的时候,才会将action动作与具体请求方式对应上。如:

    class BookInfoViewSet(viewsets.ViewSet):
    
        def list(self, request):
            ...
    
        def retrieve(self, request, pk=None):
            ...
    复制代码

    在设置路由时,我们可以如下操作

    urlpatterns = [
        url(r'^books/$', BookInfoViewSet.as_view({'get':'list'}),
        url(r'^books/(?P<pk>d+)/$', BookInfoViewSet.as_view({'get': 'retrieve'})
    ]

    action属性

    在视图集中,我们可以通过action对象属性来获取当前请求视图集时的action动作是哪个。

    例如:

    def get_serializer_class(self):
        if self.action == 'create':
            return OrderCommitSerializer
        else:
            return OrderDataSerializer

    常用视图集父类

    1) ViewSet

    继承自APIView,作用也与APIView基本类似,提供了身份认证、权限校验、流量管理等。

    在ViewSet中,没有提供任何动作action方法,需要我们自己实现action方法。

    举例:

    # ViewSet路由使用
    # url(r'^books_drf/$', viewset_view.Books.as_view({'get':'list','post':'create'})),
    # url(r'^books_drf/(?P<pk>d+)/$', viewset_view.BookDRFView.as_view({'put':'update'})),
    # url(r'^books_drf/(?P<pk>d+)/lastdata/$', viewset_view.BookDRFView.as_view({'get':'lastdata'})),


    from rest_framework.viewsets import ViewSet
    from rest_framework.response import Response

    # Create your views here.
    from book_drf.serializer import BookSerialzier
    from books.models import BookInfo


    class Books(ViewSet):
    def list(self, request):
    # 1、查询所有图书对象
    books = BookInfo.objects.all()

    ser = BookSerialzier(books, many=True)

    return Response(ser.data)

    def create(self, request):
    # 1、获取前端数据
    # data = request.body.decode()
    # data_dict = json.loads(data)
    data = request.data
    # 2、验证数据
    ser = BookSerialzier(data=data)
    ser.is_valid() # 验证方法

    # 3、保存数据
    ser.save()
    # 4、返回结果
    return Response(ser.data)


    class BookDRFView(ViewSet):
    """
    获取单一和更新和删除
    """

    def update(self, request, pk):
    # 1、获取前端数据
    # data = request.body.decode()
    # data_dict = json.loads(data)
    data = request.data
    # 2、验证数据
    try:
    book = BookInfo.objects.get(id=pk)
    except:
    return JsonResponse({'error': '错误信息'}, status=400)
    ser = BookSerialzier(book, data=data)
    ser.is_valid()
    # 3、更新数据
    ser.save()
    # 4、返回结果
    return Response(ser.data)


    def lastdata(self,request,pk):
    book=BookInfo.objects.get(id=pk)

    ser=BookSerialzier(book)

    return Response(ser.data)


    class Book(ViewSet):
    def get(self, request):
    book = BookInfo.objects.get(id=1)
    ser = BookSerialzier(book)

    return Response(ser.data)

    复制代码
    # ViewSet路由使用
        # url(r'^books_drf/$', viewset_view.Books.as_view({'get':'list','post':'create'})),
        # url(r'^books_drf/(?P<pk>d+)/$', viewset_view.BookDRFView.as_view({'put':'update'})),
        # url(r'^books_drf/(?P<pk>d+)/lastdata/$', viewset_view.BookDRFView.as_view({'get':'lastdata'})),
    
    
    from rest_framework.viewsets import ViewSet
    from rest_framework.response import Response
    
    # Create your views here.
    from book_drf.serializer import BookSerialzier
    from books.models import BookInfo
    
    
    class Books(ViewSet):
        def list(self, request):
            # 1、查询所有图书对象
            books = BookInfo.objects.all()
    
            ser = BookSerialzier(books, many=True)
    
            return Response(ser.data)
    
        def create(self, request):
            # 1、获取前端数据
            # data = request.body.decode()
            # data_dict = json.loads(data)
            data = request.data
            # 2、验证数据
            ser = BookSerialzier(data=data)
            ser.is_valid()  # 验证方法
    
            # 3、保存数据
            ser.save()
            # 4、返回结果
            return Response(ser.data)
    
    
    class BookDRFView(ViewSet):
        """
            获取单一和更新和删除
        """
    
        def update(self, request, pk):
            # 1、获取前端数据
            # data = request.body.decode()
            # data_dict = json.loads(data)
            data = request.data
            # 2、验证数据
            try:
                book = BookInfo.objects.get(id=pk)
            except:
                return JsonResponse({'error': '错误信息'}, status=400)
            ser = BookSerialzier(book, data=data)
            ser.is_valid()
            # 3、更新数据
            ser.save()
            # 4、返回结果
            return Response(ser.data)
    
    
        def lastdata(self,request,pk):
            book=BookInfo.objects.get(id=pk)
    
            ser=BookSerialzier(book)
    
            return Response(ser.data)
    
    
    class Book(ViewSet):
        def get(self, request):
            book = BookInfo.objects.get(id=1)
            ser = BookSerialzier(book)
    
            return Response(ser.data)
    复制代码

    2)GenericViewSet

    继承自GenericAPIView,作用也与GenericAPIVIew类似,提供了get_object、get_queryset等方法便于列表视图与详情信息视图的开发。

    # GenericViewSet路由使用
    # url(r'^books_drf/$', genericviewset_view.Books.as_view({'get': 'list', 'post': 'create'})),
    # url(r'^books_drf/(?P<pk>d+)/$', genericviewset_view.BookDRFView.as_view({'put': 'update'})),
    # url(r'^books_drf/(?P<pk>d+)/lastdata/$', viewset_view.BookDRFView.as_view({'get': 'lastdata'})),


    from rest_framework.viewsets import GenericViewSet
    from rest_framework.response import Response

    # Create your views here.
    from book_drf.serializer import BookSerialzier
    from books.models import BookInfo


    class Books(GenericViewSet):
    queryset = BookInfo.objects.all() # 指定当前类视图使用的查询集数据
    serializer_class = BookSerialzier # 指定当前类视图使用的序列化器

    def list(self, request):
    # 1、查询所有图书对象
    books =self.get_queryset()

    ser = self.get_serializer(books,many=True)

    return Response(ser.data)

    def create(self, request):
    # 1、获取前端数据
    # data = request.body.decode()
    # data_dict = json.loads(data)
    data = request.data
    # 2、验证数据
    ser = self.get_serializer(data=data)
    ser.is_valid() # 验证方法

    # 3、保存数据
    ser.save()
    # 4、返回结果
    return Response(ser.data)


    class BookDRFView(GenericViewSet):
    """
    获取单一和更新和删除
    """

    def update(self, request, pk):
    # 1、获取前端数据
    # data = request.body.decode()
    # data_dict = json.loads(data)
    data = request.data
    # 2、验证数据
    try:
    book = BookInfo.objects.get(id=pk)
    except:
    return JsonResponse({'error': '错误信息'}, status=400)
    ser = BookSerialzier(book, data=data)
    ser.is_valid()
    # 3、更新数据
    ser.save()
    # 4、返回结果
    return Response(ser.data)


    def lastdata(self,request,pk):
    book=BookInfo.objects.get(id=pk)

    ser=BookSerialzier(book)

    return Response(ser.data)


    class Book(GenericViewSet):
    def get(self, request):
    book = BookInfo.objects.get(id=1)
    ser = BookSerialzier(book)

    return Response(ser.data)

    复制代码
    # GenericViewSet路由使用
        # url(r'^books_drf/$', genericviewset_view.Books.as_view({'get': 'list', 'post': 'create'})),
        # url(r'^books_drf/(?P<pk>d+)/$', genericviewset_view.BookDRFView.as_view({'put': 'update'})),
        # url(r'^books_drf/(?P<pk>d+)/lastdata/$', viewset_view.BookDRFView.as_view({'get': 'lastdata'})),
    
    
    from rest_framework.viewsets import GenericViewSet
    from rest_framework.response import Response
    
    # Create your views here.
    from book_drf.serializer import BookSerialzier
    from books.models import BookInfo
    
    
    class Books(GenericViewSet):
        queryset = BookInfo.objects.all()  # 指定当前类视图使用的查询集数据
        serializer_class = BookSerialzier  # 指定当前类视图使用的序列化器
    
        def list(self, request):
            # 1、查询所有图书对象
            books =self.get_queryset()
    
            ser = self.get_serializer(books,many=True)
    
            return Response(ser.data)
    
        def create(self, request):
            # 1、获取前端数据
            # data = request.body.decode()
            # data_dict = json.loads(data)
            data = request.data
            # 2、验证数据
            ser = self.get_serializer(data=data)
            ser.is_valid()  # 验证方法
    
            # 3、保存数据
            ser.save()
            # 4、返回结果
            return Response(ser.data)
    
    
    class BookDRFView(GenericViewSet):
        """
            获取单一和更新和删除
        """
    
        def update(self, request, pk):
            # 1、获取前端数据
            # data = request.body.decode()
            # data_dict = json.loads(data)
            data = request.data
            # 2、验证数据
            try:
                book = BookInfo.objects.get(id=pk)
            except:
                return JsonResponse({'error': '错误信息'}, status=400)
            ser = BookSerialzier(book, data=data)
            ser.is_valid()
            # 3、更新数据
            ser.save()
            # 4、返回结果
            return Response(ser.data)
    
    
        def lastdata(self,request,pk):
            book=BookInfo.objects.get(id=pk)
    
            ser=BookSerialzier(book)
    
            return Response(ser.data)
    
    
    class Book(GenericViewSet):
        def get(self, request):
            book = BookInfo.objects.get(id=1)
            ser = BookSerialzier(book)
    
            return Response(ser.data)
    复制代码

    3)ModelViewSet

    继承自GenericAPIVIew,同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

    # url(r'^books_drf/$', modelviewset_view.Books.as_view({'get': 'list', 'post': 'create'})),
    # url(r'^books_drf/(?P<pk>d+)/$', modelviewset_view.Books.as_view({'put': 'update','get':'retrieve','delete':'destroy'})),

    class Books(ModelViewSet):
    queryset = BookInfo.objects.all() # 指定当前类视图使用的查询集数据

    def get_serializer_class(self):
    if self.action =='lastdata':
    return BookSerialzier
    elif self.action=='create':
    return BookSerialzier
    else:
    return BookSerialzier

    @action(methods=['get'],detail=True)
    def lastdata(self,request,pk):
    raise DatabaseError
    print(self.action)
    book=BookInfo.objects.get(id=pk)
    ser=self.get_serializer(book)
    return Response(ser.data)

    复制代码
    # url(r'^books_drf/$', modelviewset_view.Books.as_view({'get': 'list', 'post': 'create'})),
        # url(r'^books_drf/(?P<pk>d+)/$', modelviewset_view.Books.as_view({'put': 'update','get':'retrieve','delete':'destroy'})),
    
    class Books(ModelViewSet):
        queryset = BookInfo.objects.all()  # 指定当前类视图使用的查询集数据
    
        def get_serializer_class(self):
            if self.action =='lastdata':
                return BookSerialzier
            elif self.action=='create':
                return BookSerialzier
            else:
                return BookSerialzier
    
        @action(methods=['get'],detail=True)
        def lastdata(self,request,pk):
            raise DatabaseError
            print(self.action)
            book=BookInfo.objects.get(id=pk)
            ser=self.get_serializer(book)
            return Response(ser.data)
    复制代码

    4)ReadOnlyModelViewSet

    继承自GenericAPIVIew,同时包括了ListModelMixin、RetrieveModelMixin。

    # url(r'^books/$', modelviewset_view.BooksView.as_view({'get': 'listbook'})),
    # url(r'^heros/$', modelviewset_view.BooksView.as_view({'get': 'listhero'})),


    from rest_framework import viewsets
    from rest_framework.decorators import action
    # Create your views here.
    from book.models import BookInfo, HeroInfo
    from book_MS.serializer import BookInfoSerializer, HeroInfoSerializer

    class BooksView(viewsets.ReadOnlyModelViewSet):

    def get_queryset(self):
    if self.action == 'listbook':
    return BookInfo.objects.all()
    else:
    return HeroInfo.objects.all()

    def get_serializer_class(self):
    if self.action == 'listbook':
    return BookInfoSerializer
    else:
    return HeroInfoSerializer

    @action(methods='get', detail=False)
    def receive(self, request):

    instance = self.get_queryset()
    serializer = self.get_serializer(instance, many=True)

    return Response(serializer.data)

    def listbook(self, request):

    return self.receive(request)

    def listhero(self, request):

    return self.receive(request)

    复制代码
    # url(r'^books/$', modelviewset_view.BooksView.as_view({'get': 'listbook'})),
        # url(r'^heros/$', modelviewset_view.BooksView.as_view({'get': 'listhero'})),
    
    
    from rest_framework import viewsets
    from rest_framework.decorators import action
    # Create your views here.
    from book.models import BookInfo, HeroInfo
    from book_MS.serializer import BookInfoSerializer, HeroInfoSerializer
    
    class BooksView(viewsets.ReadOnlyModelViewSet):
    
        def get_queryset(self):
            if self.action == 'listbook':
                return BookInfo.objects.all()
            else:
                return HeroInfo.objects.all()
    
        def get_serializer_class(self):
            if self.action == 'listbook':
                return BookInfoSerializer
            else:
                return HeroInfoSerializer
    
        @action(methods='get', detail=False)
        def receive(self, request):
    
            instance = self.get_queryset()
            serializer = self.get_serializer(instance, many=True)
    
            return Response(serializer.data)
    
        def listbook(self, request):
    
            return self.receive(request)
    
        def listhero(self, request):
    
            return self.receive(request)
    复制代码

    视图集中定义附加action动作

    在视图集中,除了上述默认的方法动作外,还可以添加自定义动作。

    添加自定义动作需要使用rest_framework.decorators.action装饰器。

    以action装饰器装饰的方法名会作为action动作名,与list、retrieve等同。

    action装饰器可以接收两个参数:

    • methods: 该action支持的请求方式,列表传递
    • detail: 表示是action中要处理的是否是视图资源的对象(即是否通过url路径获取主键)
      • True 表示使用通过URL获取的主键对应的数据对象
      • False 表示不使用URL获取主键

    举例:

    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

    # detail为False 表示不需要处理具体的BookInfo对象
    @action(methods=['get'], detail=False)
    def latest(self, request):
    """
    返回最新的图书信息
    """
    book = BookInfo.objects.latest('id')
    serializer = self.get_serializer(book)
    return Response(serializer.data)

    # detail为True,表示要处理具体与pk主键对应的BookInfo对象
    @action(methods=['put'], detail=True)
    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)

    复制代码
    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
    
        # detail为False 表示不需要处理具体的BookInfo对象
        @action(methods=['get'], detail=False)
        def latest(self, request):
            """
            返回最新的图书信息
            """
            book = BookInfo.objects.latest('id')
            serializer = self.get_serializer(book)
            return Response(serializer.data)
    
        # detail为True,表示要处理具体与pk主键对应的BookInfo对象
        @action(methods=['put'], detail=True)
        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'})),
    ]
    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'})),
    ]

    视图集的继承关系

    5.路由Routers

    对于视图集ViewSet,我们除了可以自己手动指明请求方式与动作action之间的对应关系外,还可以使用Routers来帮助我们快速实现路由信息。

    REST framework提供了两个router

    • SimpleRouter
    • DefaultRouter

    1. 使用方法

    1) 创建router对象,并注册视图集,例如

    from rest_framework import routers
    
    router = routers.SimpleRouter()
    router.register(r'books', BookInfoViewSet, base_name='book')

    register(prefix, viewset, base_name)

    • prefix 该视图集的路由前缀
    • viewset 视图集
    • base_name 路由名称的前缀

    如上述代码会形成的路由如下:

    ^books/$    name: book-list
    ^books/{pk}/$   name: book-detail

    2)添加路由数据

    可以有两种方式:

    urlpatterns = [
        ...
    ]
    urlpatterns += router.urls
    或
    
    urlpatterns = [
        ...
        url(r'^', include(router.urls))
    ]
    复制代码

    2. 视图集中包含附加action的

    class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
        queryset = BookInfo.objects.all()
        serializer_class = BookInfoSerializer
    
        @action(methods=['get'], detail=False)
        def latest(self, request):
            ...
    
        @action(methods=['put'], detail=True)
        def read(self, request, pk):
            ...
    复制代码

    此视图集会形成的路由:

    ^books/latest/$    name: book-latest
    ^books/{pk}/read/$  name: book-read

    3. 路由router形成URL的方式

    1) SimpleRouter

    2)DefaultRouter

    DefaultRouter与SimpleRouter的区别是,DefaultRouter会多附带一个默认的API根视图,返回一个包含所有列表视图的超链接响应数据。

     

    壬戌之秋,七月既望,苏子与客泛舟游于赤壁之下。清风徐来,水波不兴。举酒属客,诵明月之诗,歌窈窕之章。少焉,月出于东山之上,徘徊于斗牛之间。白露横江,水光接天。纵一苇之所如,凌万顷之茫然。浩浩乎如冯虚御风,而不知其所止;飘飘乎如遗世独立,羽化而登仙。 于是饮酒乐甚,扣舷而歌之。歌曰:“桂棹兮兰桨,击空明兮溯流光。渺渺兮予怀,望美人兮天一方。”客有吹洞箫者,倚歌而和之。其声呜呜然,如怨如慕,如泣如诉,余音袅袅,不绝如缕。舞幽壑之潜蛟,泣孤舟之嫠妇。 苏子愀然,正襟危坐而问客曰:“何为其然也?”客曰:“月明星稀,乌鹊南飞,此非曹孟德之诗乎?西望夏口,东望武昌,山川相缪,郁乎苍苍,此非孟德之困于周郎者乎?方其破荆州,下江陵,顺流而东也,舳舻千里,旌旗蔽空,酾酒临江,横槊赋诗,固一世之雄也,而今安在哉?况吾与子渔樵于江渚之上,侣鱼虾而友麋鹿,驾一叶之扁舟,举匏樽以相属。寄蜉蝣于天地,渺沧海之一粟。哀吾生之须臾,羡长江之无穷。挟飞仙以遨游,抱明月而长终。知不可乎骤得,托遗响于悲风。” 苏子曰:“客亦知夫水与月乎?逝者如斯,而未尝往也;盈虚者如彼,而卒莫消长也。盖将自其变者而观之,则天地曾不能以一瞬;自其不变者而观之,则物与我皆无尽也,而又何羡乎!且夫天地之间,物各有主,苟非吾之所有,虽一毫而莫取。惟江上之清风,与山间之明月,耳得之而为声,目遇之而成色,取之无禁,用之不竭,是造物者之无尽藏也,而吾与子之所共适。” 客喜而笑,洗盏更酌。肴核既尽,杯盘狼籍。相与枕藉乎舟中,不知东方之既白。
  • 相关阅读:
    【SqlServer系列】表达式(expression)
    【SqlServer系列】语法定义符号解析
    Docker常用命令<转>
    VMware下的Centos7联网并设置固定IP
    redis的setbit命令
    Java并发编程:并发容器之CopyOnWriteArrayList<转>
    Java并发编程:volatile关键字解析<转>
    Java并发编程:阻塞队列 <转>
    Java并发编程:Lock和Synchronized <转>
    Jackson学习笔记(三)<转>
  • 原文地址:https://www.cnblogs.com/huangjiangyong/p/14534387.html
Copyright © 2011-2022 走看看