Python中的BaseFilterBackend()用法介绍

BaseFilterBackend是Django Rest Framework中的一个基础类，用于定义过滤器后端的基本结构。过滤器后端是用于对查询结果进行过滤的组件，它可以根据请求中传入的参数，对查询结果进行过滤和排序。

BaseFilterBackend类提供了以下几个方法：

1. filter_queryset(self, request, queryset, view)

这个方法接受三个参数：请求request、查询集queryset和视图view。它用于对查询集进行过滤，并返回过滤后的查询集。你可以在这个方法中根据请求中的参数对查询集进行过滤或排序。

2. get_schema_fields(self, view)

这个方法接受一个参数：视图view。它用于返回一个包含过滤器字段的列表，用于生成接口文档中的过滤器字段说明。

3. get_schema_operation_parameters(self, view)

这个方法接受一个参数：视图view。它用于返回一个包含过滤器参数的列表，用于生成接口文档中的过滤器参数说明。

下面是一个使用BaseFilterBackend的例子：

from rest_framework.filters import BaseFilterBackend

class CustomFilterBackend(BaseFilterBackend):
    def filter_queryset(self, request, queryset, view):
        # 获取请求参数
        keyword = request.query_params.get('keyword')
        if keyword:
            # 对查询集进行过滤
            queryset = queryset.filter(name__icontains=keyword)
        
        return queryset

    def get_schema_fields(self, view):
        # 返回过滤器字段的列表
        return [
            coreapi.Field(
                name='keyword',
                required=False,
                location='query',
                schema=coreschema.String(),
                description='关键字过滤'
            )
        ]

    def get_schema_operation_parameters(self, view):
        # 返回过滤器参数的列表
        return [
            {
                'name': 'keyword',
                'required': False,
                'in': 'query',
                'schema': {
                    'type': 'string'
                },
                'description': '关键字过滤'
            }
        ]

在这个例子中，我们自定义了一个CustomFilterBackend类，继承自BaseFilterBackend。在filter_queryset方法中，我们根据请求中的keyword参数对查询集进行了过滤，只返回名称包含关键字的对象。在get_schema_fields和get_schema_operation_parameters方法中，我们定义了一个keyword过滤器字段，用于接口文档中显示和说明。

在视图中使用这个自定义过滤器后端，只需要在视图类的filter_backends属性中添加CustomFilterBackend即可：

from rest_framework.views import APIView
from myapp.serializers import MyModelSerializer

class MyModelAPIView(APIView):
    serializer_class = MyModelSerializer
    filter_backends = [CustomFilterBackend]

这样，当请求这个视图时，如果传入了keyword参数，查询结果就会根据该参数进行过滤。