DRF框架（九）——drf偏移分頁組件、drf游標分頁組件(了解)、自定義過濾器、過濾器插件django-filter

drf偏移分頁組件

paginations.py

from rest_framework.pagination import LimitOffsetPagination
class MyLimitOffsetPagination(LimitOffsetPagination):
    # ?offset=從頭偏移的條數&limit=要顯示的條數
    limit_query_param = 'limit'
    offset_query_param = 'offset'
    # ?不傳offset和limit默認顯示前3條，只設置offset就是從偏移位往后再顯示3條
    default_limit = 3
    # ?limit可以自定義一頁顯示的最大條數
    max_limit = 5

　　#eg:/cars/?offset=1&limit=4  往后偏移一位，然后往后數四個數據

    # 只使用limit結合ordering可以實現排行前幾或后幾
　　 #？ordering=-price&limit=2  價格降序，取最前面兩條數據
    

views.py

from rest_framework.generics import ListAPIView

class CarListAPIView(ListAPIView):
    # 如果queryset沒有過濾條件，就必須 .all()，不然分頁會出問題
    queryset = models.Car.objects.all()
    serializer_class = serializers.CarModelSerializer
    
    # 分頁組件 - 給視圖類配置分頁類即可 - 分頁類需要自定義，繼承drf提供的分頁類即可
    pagination_class = pagenations.MyLimitOffsetPagination

drf游標分頁組件（了解）

paginations.py

# 注：必須基於排序規則下進行分頁
# 1）如果接口配置了OrderingFilter過濾器，那么url中必須傳ordering
# 1）如果接口沒有配置OrderingFilter過濾器，一定要在分頁類中聲明ordering按某個字段進行默認排序
from rest_framework.pagination import CursorPagination
class MyCursorPagination(CursorPagination):
    cursor_query_param = 'cursor'
    page_size = 3
    page_size_query_param = 'page_size'
    max_page_size = 5
    ordering = '-pk'

views.py

from rest_framework.generics import ListAPIView

class CarListAPIView(ListAPIView):
    # 如果queryset沒有過濾條件，就必須 .all()，不然分頁會出問題
    queryset = models.Car.objects.all()
    serializer_class = serializers.CarModelSerializer
    
    # 分頁組件 - 給視圖類配置分頁類即可 - 分頁類需要自定義，繼承drf提供的分頁類即可
    pagination_class = pagenations.MyCursorPagination

自定義過濾器

filters.py

# 自定義過濾器，接口：?limit=顯示的條數
class LimitFilter:
    def filter_queryset(self, request, queryset, view):
        # 前台固定用 ?limit=... 傳遞過濾參數
        limit = request.query_params.get('limit')
        if limit:
            limit = int(limit)
            return queryset[:limit]
        return queryset

views.py

from rest_framework.generics import ListAPIView

class CarListAPIView(ListAPIView):
    # 如果queryset沒有過濾條件，就必須 .all()，不然分頁會出問題
    queryset = models.Car.objects.all()
    serializer_class = serializers.CarModelSerializer
    
    # 局部配置 過濾類 們（全局配置用DEFAULT_FILTER_BACKENDS）
    filter_backends = [LimitFilter]

接口：/?limit=5  顯示5條數據

過濾器插件：django-filter

安裝

pip install django-filter

過濾條件層：自定義app01/filters.py

# django-filter插件過濾器類
from django_filters.rest_framework.filterset import FilterSet
from . import models

# 自定義過濾字段
from django_filters import filters
class CarFilterSet(FilterSet):
    min_price = filters.NumberFilter(field_name='price', lookup_expr='gte')
    max_price = filters.NumberFilter(field_name='price', lookup_expr='lte')
    class Meta:
        model = models.Car
        fields = ['brand', 'min_price', 'max_price']
        # brand是model中存在的字段，一般都是可以用於分組的字段
        # min_price、max_price是自定義字段，需要自己自定義過濾條件

視圖層：views.py

# django-filter插件過濾器
from django_filters.rest_framework import DjangoFilterBackend
from .filters import CarFilterSet

class CarListAPIView(ListAPIView):
    queryset = models.Car.objects.all()
    serializer_class = serializers.CarModelSerializer
    
    # 局部配置 過濾類 們（全局配置用DEFAULT_FILTER_BACKENDS）
    filter_backends = [DjangoFilterBackend]
    
    # django-filter過濾器插件使用
    filter_class = CarFilterSet
    # 接口：?brand=...&min_price=...&max_price=...
    # eg:?brand=寶馬&min_price=5&max_price=10 => 5~10間的寶馬牌汽車