【DRF】过滤-CSDN博客

使用 queryset

通过在视图中重载 get_queryset(self) 来过滤

class GoodsListViewSet(mixins.ListModelMixin, mixins.CreateModelMixin, generics.GenericAPIView):

    serializer_class = GoodsSerializer
    
    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

    def get_queryset(self):
        good_name = self.request.query_params.get("good_name")  # 通过获取前端传递的数据来过滤
        if good_name:
            return Student.objects.filter(name=good_name)
        else:
            return Student.objects.all()
复制代码

使用 Filtering

官方文档：www.django-rest-framework.org/api-guide/f…
Django-filter文档：django-filter.readthedocs.io/en/master/

常用的三种过滤：DjangoFilterBackend SearchFilter OrderingFilter

DjangoFilterBackend 完全匹配

前言 【DjangoFilterBackend过滤是完全等于】，不是模糊搜索

安装 django-filter

pip install django-filter
复制代码

统一将 django-filter 加入到 REST 的配置中

REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',)
}
复制代码

或者局部配置

from django_filters.rest_framework import DjangoFilterBackend

class UserListView(generics.ListAPIView):
    ...
    filter_backends = (DjangoFilterBackend,)
复制代码

配置过滤项(配置)

class ProductList(generics.ListAPIView):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer
    filter_backends = (DjangoFilterBackend,)
    filterset_fields = ('category', 'in_stock')
复制代码

前端调用过滤

http://example.com/api/products?category=clothing&in_stock=True
复制代码

SearchFilter 模糊查询

配置搜索过滤

from rest_framework import filters

class UserListView(generics.ListAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    filter_backends = (filters.SearchFilter,)
    search_fields = ('username', 'email')  # 将关键词在多个字段中模糊搜索，并且会去重
复制代码

前端调用过滤

http://example.com/api/users?search=russell
复制代码

搜索行为可以通过在其中添加各种字符来限制search_fields

'^' 以该关键字开头的的内容
'=' 完全匹配
'@' 全文搜索（目前只支持Django的MySQL后端）
'$' 正则表达式搜索

search_fields = ('=username', '=email')
复制代码

OrderingFilter 排序

如果未ordering_fields在视图上指定属性，则筛选器类将默认允许用户筛选serializer_class属性指定的序列化程序上的任何可读字段。

确定视图使用的查询集不包含任何敏感数据，则还可以使用特殊值明确指定视图应允许对任何模型字段或查询集合进行排序'__all__'

class UserListView(generics.ListAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    filter_backends = (filters.OrderingFilter,)
    ordering_fields = ('username', 'email')
复制代码

前端正向排序

http://example.com/api/users?ordering=username
复制代码

前端反向排序

http://example.com/api/users?ordering=-username
复制代码

指定多个排序

http://example.com/api/users?ordering=account,username
复制代码

指定默认排序

如果ordering在视图上设置了属性，则将其用作默认排序

通常，您可以通过设置order_by初始查询集来控制它，但是使用ordering视图上的参数允许您以一种方式指定排序，然后它可以作为上下文自动传递给渲染模板。这样，如果用于排序结果，则可以自动呈现列标题。

class UserListView(generics.ListAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    filter_backends = (filters.OrderingFilter,)
    ordering_fields = ('username', 'email')
    ordering = ('username',)
复制代码

使用 django-filter 自定义过滤

"""【filters.py】"""
from django.db.models import Q
from django_filters import rest_framework as filters

from .models import Goods

class GoodsFilter(filters.FilterSet):
    min_price = filters.NumberFilter(field_name="shop_price", lookup_expr='gte')
    max_price = filters.NumberFilter(field_name="shop_price", lookup_expr='lte')

    top_category = filters.NumberFilter(method="top_category_filter")

    # 模糊查询 icontains忽略大小写 contains不忽略大小写
    # name = filters.CharFilter(field_name="name", lookup_expr='icontains')

    # queryset, name, value 这三个参数必须加
    def top_category_filter(self, queryset, name, value):
        return queryset.filter(Q(category_id=value)|Q(category__parent_category_id=value)|Q(category__parent_category_id__parent_category=value))

    class Meta:
        model = Goods
        fields = ['min_price', 'max_price']
        
----------------------------------------------------------------------
"""【views.py】"""
class GoodsListViewSet(mixins.ListModelMixin, viewsets.GenericViewSet):

    queryset = Goods.objects.all()  # 有了 get_queryset 则可不用设置
    serializer_class = GoodsSerializer  # 自定义的 Serializer

    # 设置过滤
    filter_backends = (DjangoFilterBackend)
    filter_class = GoodsFilter
复制代码