美文网首页软件测试
10、Rest Framework视图类GenericAPIVi

10、Rest Framework视图类GenericAPIVi

作者: 小啊小狼 | 来源:发表于2020-09-21 14:29 被阅读0次

    一、继承关系

    APIView是REST framework提供的所有视图的基类,继承自Django的View父类。
    GenericAPIView(rest_framework.generics.GenericAPIView)
    继承自APIVIew,增加了对于列表视图和详情视图可能用到的通用支持方法(对列表数据进行过滤、排序、分页操作)。通常使用时,可搭配一个或多个Mixin扩展类。

    二、GenericAPIView

    支持定义的属性:

    列表视图与详情视图通用:
    • queryset 列表视图的查询集
    • serializer_class 视图使用的序列化器
    class ProjectsView(GenericAPIView):
    
        queryset = Projects.objects.all()
        serializer_class = ProjectsModelSerializer
    
    列表视图使用:
    • pagination_class 分页控制类
    • filter_backends 过滤控制后端
    class InterfacesViewSet(GenericAPIView):
        queryset = Interfaces.objects.all()
        serializer_class = InterfacesModelSerializer
    
        pagination_class = MyPagination
        filter_backends = [DjangoFilterBackend, OrderingFilter]
        filterset_fields = ['name','tester', 'id']
        ordering_fields = ['id', 'name']
    

    详情页视图使用:

    • lookup_field 查询单一数据库对象时使用的条件字段,默认为'pk'
    • lookup_url_kwarg 查询单一数据时URL中的参数关键字名称,默认与look_field相同
    # lookup_field与lookup_url_kwarg的使用举例
    url(r"^config/(?P<id>/$", views.TestView.as_view()),
    
    class TestView(GenericAPIView):
        queryset = Config.objects.all()
        lookup_field = ('uuid')
        lookup_url_kwarg = ('id')
    
        def put(self, request, *args, **kwargs):     
                instance = self.get_object()
        # get_object会根据lookup_field 和lookup_url_kwarg 的值来过滤获取单个对象,过滤方法相当于:filter(uuid=id参数的值)。
        # uuid为数据库表里的字段,id为参数中的关键字,即获取的是字段uuid=id参数的值的对象。通常lookup_url_kwarg 默认就是lookup_field 的值,代码中只需要设置lookup_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.action == 'names':
                return ProjectsNamesModelSerializer
            elif self.action == 'interfaces':
                return InterfacesByProjectIdModelSerializer
            else:
                return self.serializer_class
    
    • get_serializer(self, args, *kwargs)
      返回序列化器对象,被其他视图或扩展类使用,如果我们在视图中想要获取序列化器对象,可以直接调用此方法。

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

    详情视图使用:

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

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

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

    举例:

    url(r"^config/(?P<id>/$", views.TestView.as_view()),
    
    class TestView(GenericAPIView):
        queryset = Config.objects.all()
        lookup_field = ('uuid')
        lookup_url_kwarg = ('id')
    
        def put(self, request, *args, **kwargs):     
                instance = self.get_object()
    

    相关文章

      网友评论

        本文标题:10、Rest Framework视图类GenericAPIVi

        本文链接:https://www.haomeiwen.com/subject/xskvyktx.html