过滤功能利用的是第三方包 django_filters,搜索和排序利用的是 Django DRF 提供的 filters
示例代码如下:
from rest_framework import filters # 搜索和排序功能 # 注意:这两个是 DRF 提供的功能
from django_filters.rest_framework import DjangoFilterBackend # DjangoFilterBackend 是精确(查找)过滤,即 字段值必须要完全一样才能匹配成功
import django_filters
class GoodsFilter(django_filters.rest_framework.FilterSet):
"""商品的过滤类"""
min_price = django_filters.NumberFilter(field_name="price",
lookup_expr="gte") # field_name 表示要过滤字段;lookup_expr 表示 过滤时要进行的操作,gte 表示 大于等于
max_price = django_filters.NumberFilter(field_name="price", lookup_expr="lte") # lte 小于等于
name = django_filters.CharFilter(field_name="name",lookup_expr="icontains") # icontains 表示 包含(忽略大小写)
class Meta:
model = models.Goods # 关联的表
fields = ["min_price","max_price","name"] # 过滤的字段
class GoodsPagination(PageNumberPagination):
page_size = 10
page_size_query_param = "page_size"
page_query_param = "p"
max_page_size = 100
class GoodsListViewSet(mixins.ListModelMixin,GenericViewSet):
"""商品查看"""
queryset = models.Goods.objects.all() # 没 get_queryset() 这个过滤方法时,需要写上这一步的 queryset;有 get_queryset 方法时,则不需要写这一步,因为会自动去 get_queryset() 中找 queryset
pagination_class = GoodsPagination
# 方式三:自定义过滤功能(也包含搜索和排序功能)
filter_backends = (DjangoFilterBackend,filters.SearchFilter,filters.OrderingFilter) # filters.SearchFilter 表示 搜索功能;filters.OrderingFilter 表示 排序功能
filterset_class = GoodsFilter # 把自定义的过滤类 GoodsFilter 赋值给 filterset_class
search_fields = ('^name', 'goods_brief') # 搜索功能对应的字段 # '^' Starts-with search;'=' Exact matches.
ordering_fields = ("sold_num","add_time") # 排序功能对应的字段
# 业务逻辑省略...
"""
# 过滤功能方式二
filter_backends = (DjangoFilterBackend,) # 过滤类型
filterset_fields = ("name","shop_price") # 过滤字段 # 这种的过滤只能满足精确过滤
"""
"""
# 方式一:get_queryset()方法
def get_queryset(self): # 过滤方法; GenericAPIView 提供的方法
queryset = models.Goods.objects.all()
price_min = self.request.query_params.get("price_min",0)
if price_min:
queryset = queryset.filter(shop_price_gt=int(price_min))
return queryset
"""
"""
方式二:通过 django-filter
# 1. pip install django-filter
# 2. 把 "django-filters" 添加到 Django 的 INSTALLED_APPS 中
# 3. 在 filter_backends 中添加 DjangoFilterBackend,在 filterset_fields 中添加 过滤字段
这个方式的过滤是精确过滤,即 用户传过来的值必须和 对应过滤字段的值完全一样才能过滤出来;
如果想自定义过滤功能(例如想过滤出价格区间),可通过方式三
"""
"""
方式三:通过 django-filter 自定义 过滤功能
1. 自定义一个过滤类
2. filter_backends = (DjangoFilterBackend,)
3. filterset_class = GoodsFilter # 把自定义的过滤类 GoodsFilter 赋值给 filterset_class
"""
django-filters 文档: https://django-filter.readthedocs.io/en/latest/guide/rest_framework.html