django-restful:filters学习笔记

django-filters 使用了 DjangoFilterBackend
文档地址：http://www.django-rest-framework.org/api-guide/filtering/#djangofilterbackend
处理一些过滤搜索 例如价格的区间搜索
我们在app中建一个filters.py文件 来写

from django_filters import rest_framework as filters
from .models import Goods


class GoodsFilter(filters.FilterSet):
    """
    商品的过滤类
    """
    # gte 大于等于  lte小于等于
    price_min = filters.NumberFilter(name="shop_price", lookup_expr='gte')
    price_max = filters.NumberFilter(name="shop_price", lookup_expr='lte')
    # name = filters.CharFilter(name='name', lookup_expr='icontains')

    class Meta:
        model = Goods
        fields = ['price_min', 'price_max']  #这里前端就可以在url中加上这个进行过滤

然后就是在view中配置

class GoodsListViewSet(mixins.ListModelMixin,viewsets.GenericViewSet):
    """
    商品列表页，分页，搜索，过滤，排序
    """
    queryset = Goods.objects.all()
    serializer_class = GoodsSerializer
    pagination_class = GoodsPagination
    filter_backends = (DjangoFilterBackend,)
    filter_class = GoodsFilter

只需要这样简单的配置 就可以实现价格区间的控制进行搜索
然后就是上面的分页

class GoodsPagination(PageNumberPagination):
   """
   定制分页 更加灵活 前端可以自定义分页大小
   """
   page_size = 10
   page_size_query_param = 'page_size'  #每个的显示个数
   page_query_param = "p"  #来表示每页的页数
   max_page_size = 100

然后就是上面name的模糊搜索 和 排序
用到是serachFiled 和 OrderingFilter

from rest_framework import filters
class GoodsListViewSet(mixins.ListModelMixin,viewsets.GenericViewSet):
   queryset = Goods.objects.all()
   serializer_class = GoodsSerializer
   pagination_class = GoodsPagination
   filter_backends = (DjangoFilterBackend,filters.SearchFilter,filters.OrderingFilter,)
   filter_class = GoodsFilter
   search_fields = ('name','goods_brief', 'goods_desc')  #这里写上可以进行模糊查询的字段 
   ordering_fields = ('shop_price', 'sold_num','click_num') #这里是进行排序的字段

search_fields 还支持很多方法 例如

    '^' Starts-with search.  # 以xx开头的
    '=' Exact matches.  #必须完全相等的
    '@' Full-text search. (Currently only supported Django's MySQL backend.)  #全局搜索 mysql必须支持
    '$' Regex search.  #正则搜索

这里基本都写完了 后面我在写写 Serializer
本来是前面学的 但是忘了写 现在来补补