zoukankan      html  css  js  c++  java
  • DRF框架之视图基类APIView和GenericAPIView简介

    Django REST framwork 提供的视图的主要作用:

    • 控制序列化器的执行(检验、保存、转换数据)
    • 控制数据库查询的执行

    1. DRF框架中的Request和Response

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

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

    1.1 Resquest常用属性

    1.1.1 data属性

    我们可以通过data属性获取到前端传递过来的请求体的数据。

    1.1.2 query_params属性

    我们可以通过query_params属性获取到前端传递过来的查询字符串数据。

    1.2 Response

    1.2.1 Response对象

    在DRF框架的视图中,我们通过Response对象来返回JSON数据。

    Response(data, status=None, template_name=None, headers=None, content_type=None)
    参数
        data
            序列化器序列化后的数据
        status
            状态码,默认200
        template_name
            模板名称(几乎不用)
        headers
            用于存放响应头信息的字典
        content_type
            响应数据的Content-Type

    案例代码:

    class BookInfoAPIView(APIView):
        '''定义APIView
        DRF的视图核心任务就是操作数据库和序列化器
        '''
    
        def get(self, request):
    
            # 对数据库进行操作
            books = BookInfo.objects.all()
    
            # 对序列化器进行操作
            s = BookInfoModelSerializer(instance=books, many=True)
    
            # 响应JSON
            return Response(s.data)

    这里因为,我们是查询数据,根据RESTful设计风格需要返回状态码为200,但是status默认值就是200,所以不用传递参数。

    1.2.2 Response常用属性

    1.2.2.1 data属性

    通过data属性,我们可以获取到传递给Response的字典数据

    1.2.2.2 status_code属性

    通过status_code属性,我们可以获取到传递给Response的status参数的值。

    1.2.2.3 content属性

    通过content属性,我们可以获取到经过Response处理过的JSON数据

    2. 视图

    在DRF框架中,视图分为两大类,一个是通用视图,一个是视图集。

    2.1 通用视图

    在通用视图中,又分为两个视图基类、五个试图扩展类、视图子类。

    2.1.1 视图基类

    2.1.1.1 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 BookInfoAPIView(APIView):
        '''定义APIView
        DRF的视图核心任务就是操作数据库和序列化器
        '''
    
        def get(self, request):
    
            # 对数据库进行操作
            books = BookInfo.objects.all()
    
            # 对序列化器进行操作
            s = BookInfoModelSerializer(instance=books, many=True)
    
            # 响应JSON
            return Response(s.data)

     2.1.1.2 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方法检查当前对象是否有权限被访问。

    案例代码:

    class BookInfoAPIView(GenericAPIView):
        '''使用GenericAPIView定义API'''
    
        # 1. 设置查询集
        queryset = BookInfo.objects.all()
    
        # 2. 设置序列化器
        serializer_class = BookInfoModelSerializer
    
        def get(self, request):
    
            # 3. 获取模型对象
            qs = self.get_queryset()
    
            # 4. 获取序列化器对象
            s = self.get_serializer(qs, many=True)
    
            return Response(s.data)

    经过以上的讲解,我们对DRF框架中的两个视图基类已经有了初步的了解了。

    该花的钱要花,该吃的饭要吃。
  • 相关阅读:
    中国移动 使用Linux、OpenStack
    【 【henuacm2016级暑期训练】动态规划专题 K】 Really Big Numbers
    【【henuacm2016级暑期训练】动态规划专题 J】Red-Green Towers
    【【henuacm2016级暑期训练】动态规划专题 I】Gargari and Permutations
    【【henuacm2016级暑期训练】动态规划专题 H】Greenhouse Effect
    【 【henuacm2016级暑期训练】动态规划专题 G】 Palindrome pairs
    【【henuacm2016级暑期训练】动态规划专题 F】Physics Practical
    【【henuacm2016级暑期训练】动态规划专题 E】Destroying Roads
    【【henuacm2016级暑期训练】动态规划专题 D】Writing Code
    【henuacm2016级暑期训练-动态规划专题 C】Little Girl and Maximum XOR
  • 原文地址:https://www.cnblogs.com/chao666/p/12274191.html
Copyright © 2011-2022 走看看