drf-jwt分页器详解

drf偏移分页组件

pahenations.py

from rest_framework.pagination import LimitOffsetPagination
class MyLimitOffsetPagination(LimitOffsetPagination):
    # ?offset=从头偏移的条数&limit=要显示的条数，也可以是 limit_query_param = 'a'
    #携带参数的时候就是?a=2
    limit_query_param = 'limit'
    offset_query_param = 'offset'
    # ?不传offset和limit默认显示前3条，只设置offset就是从偏移位往后再显示3条
    default_limit = 3
    # ?limit可以自定义一页显示的最大条数
    max_limit = 5

    # 只使用limit结合ordering可以实现排行前几或后几，视图类中必须要写filter_backends = [SearchFilter, OrderingFilter]
    # ?ordering=-price&limit=2  => 价格前2

当这个类为pass的时候，发送get请求不携带参数返回所有的数据，而携带参数的时候limit=2会返回两条数据，但是offset的时候就不起作用，当这个类只写一个default_limit的时候，不传参数就是默认显示前3条数据，如果传入一个参数?offset=2也是会后移两个来显示3条数据，如果只传一个参数?limit=2就是往后移3个展示2条数据，default_limit=3和max_limit=5配置了，访问的路由就不需要传参默认为3，5，如果需要自己传就自己携带参数，以路由的参数为首选,最大限制数，如果difault_limit=3,max_limit=2,那也只会显示两条

limit=100限制条数100，数据总共只有8条，那就是说明没有限制

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游标分页组件（了解）

pahenations.py（在api应用下创建的）

# 注：必须基于排序规则下进行分页
# 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
    # 'pk'一定要是存在的字段，在没有写这个ordering的时候，路由一定要要配参数?ordering='pk',不然会报错，这里写的就是默认的字段，自动排序，并且在视图类中不能配置filter_backends = [SearchFilter, OrderingFilter]，这个排序组件，因为会发生拦截，所以导致卸了默认的也必须传?ordering=-pk
    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):
        # 前台固定用get请求  http://127.0.0.1:8000/api/cars/?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]

过滤器插件：django-filter

安装

>: pip3 install django-filter

过滤条件层：自定义api/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间的宝马牌汽车

源码分析

点击DjangoFilterBackend -->filter_queryset --> 1.get_filterset--
>2.get_filterset_class

   1.get_filterset
    def get_filterset(self, request, queryset, view):
        #view中获取过滤类，view是视图类的对象
        filterset_class = self.get_filterset_class(view, queryset)
        #如果为空，返回None
        if filterset_class is None:
            return None
		#
        kwargs = self.get_filterset_kwargs(request, queryset, view)
        #如果不为空，就将其初始化，类初始化就变成了对象，返回就是过滤器对象
        return filterset_class(**kwargs)

   2.get_filterset_class
    def get_filterset_class(self, view, queryset=None):
        """
        Return the `FilterSet` class used to filter the queryset.
        """
        #从视图类中配置filterset_class filterset_fields,如果没有配置返回的就是空，filterset_class是类， filterset_fields字段
        filterset_class = getattr(view, 'filterset_class', None)
        filterset_fields = getattr(view, 'filterset_fields', None)

        # TODO: remove assertion in 2.1
        #如果 没有filterset_class，就从视图中获取filter_class，也就是说可以在视图类配置filterset_class或filter_class
        if filterset_class is None and hasattr(view, 'filter_class'):
            utils.deprecate(
                "`%s.filter_class` attribute should be renamed `filterset_class`."
                % view.__class__.__name__)
            filterset_class = getattr(view, 'filter_class', None)

        # TODO: remove assertion in 2.1
        #如果 没有filterset_fields，就从视图中获取filter_fields，也就是说可以在视图类配置filterset_fields或filter_fields
        if filterset_fields is None and hasattr(view, 'filter_fields'):
            utils.deprecate(
                "`%s.filter_fields` attribute should be renamed `filterset_fields`."
                % view.__class__.__name__)
            filterset_fields = getattr(view, 'filter_fields', None)
		#如果配置的是类，就直接返回这个类
        if filterset_class:
            #如果filterset_class有值就返回filterset_class，没值返回None
            # filterset_class过滤器类，._meta过滤器的子类Meta中设置model
            filterset_model = filterset_class._meta.model

            # FilterSets do not need to specify a Meta class
            if filterset_model and queryset is not None:
                assert issubclass(queryset.model, filterset_model), \
                    'FilterSet model %s does not match queryset model %s' % \
                    (filterset_model, queryset.model)

            return filterset_class
        #如果你配置的是filterset_fields字段，就会生成一个包含这些字段的类返回
		#如果 filterset_fields没有空
        if filterset_fields and queryset is not None:
            #在基类中配置Meta,
            MetaBase = getattr(self.filterset_base, 'Meta', object)
			#自定义的类AutoFilterSet，继承self.filterset_base基类
            class AutoFilterSet(self.filterset_base):
                #子类Meta
                class Meta(MetaBase):
                    #queryset.model就是我们设置的model表
                    model = queryset.model
                    fields = filterset_fields

            return AutoFilterSet

        return None

高级之处
from django_filters import filters
点击filters -->ctrl+F查询gt*

详见代码：E:\ten_django\page