Django實現drf搜索過濾和排序過濾

Posted on by

前言

當我們需要對後臺的數據進行過濾的時候，drf有兩種，搜索過濾和排序過濾。
搜索過濾：比如我們想返回sex=1的，那麼我們就可以從所有數據中進行篩選
排序過濾：比如我們想對價格進行升序排列，就可以使用排序過濾

搜索過濾

在實際的使用過程中十分簡單，隻需要在視圖類中配置一個全局變量filter_backends，然後在search_fields確定需要通過哪個字段進行篩選

from rest_framework.filters import SearchFilter
class CarView(ListAPIView):
    serializer_class = CarSerializer
    queryset = Car.objects.all()
    # 局部配置過濾類和排序類
    filter_backends = [SearchFilter]
    # SearchFilter過濾類依賴的過濾條件
    search_fields = ['name']

之後我們在訪問url地址時，就可以在url後面添加?search="寶馬1系"，那麼我們就會過濾出name=”寶馬1系”的數據

排序過濾

跟搜索過濾一樣，隻需要配置局部變量filter_backends，然後配置ordering_fields來確定通過哪個字段進行排序

from rest_framework.filters import SearchFilter, OrderingFilter
class CarView(ListAPIView):
    serializer_class = CarSerializer
    queryset = Car.objects.all()
    # 局部配置過濾類和排序類
    filter_backends = [SearchFilter, OrderingFilter]
    # SearchFilter過濾類依賴的過濾條件
    search_fields = ['name']
    # 局部配置排序類
    ordering_fields = ['price']

之後我們在訪問url地址時，就可以在url後面添加?search="寶馬"&ordering="price"，那麼我們就會過濾出所有寶馬系列的車子，並且數據的排序按照車的價格從低到高排序

PS：過濾功能利用的是第三方包 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實現drf搜索過濾和排序過濾的文章就介紹到這瞭,更多相關drf搜索過濾和排序過濾內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：