分页
强大的 drf 还提供了对于分页的支持，可以方便快捷的进行接口的全局分页或者局部分页设置
全局分页
直接在 settings中配置即可
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS':
# 'rest_framework.pagination.PageNumberPagination',
'rest_framework.pagination.LimitOffsetPagination',
'PAGE_SIZE': 2 # 每页数目
}
配置完了如果不向用，那么就直接在视图类下使用如下属性关闭全局分页功能
class View(...):
pagination_class = None
- PageNumberPagination
可以进行直接的页码处理，返回某一页分页数据
http://127.0.0.1:8000/user/?limit=2&page=2
# limit：每页的数据大小
# page：当前的页码
- LimitOffsetPagination
可以通过连接可选的参数进行分页单页数量大小的控制，分页数据偏移的选择
http://127.0.0.1:8000/path/?limit=2&offset=2"
# limit：每页的数据大小
# offset：从某一个数据位置开始偏移
局部分页
除了默认的分页样式之外，还可以通过继承分页类的方式重写分页样式，并将其作用至局部
from rest_framework.pagination import PageNumberPagination
class StandardResultsSetPagination(PageNumberPagination):
page_size = 2 # 每页数据量
page_size_query_param = 'page_size' # 每页大小连接传递参数
max_page_size = 5 # 每页数据量最多
page_query_param = 'page' # 路由传递获取的页码参数 key 值
- 局部作用分页类，需要使用pagination_class属性
class SomeModelViewSet(ModelViewSet):
...
pagination_class = StandardResultsSetPagination
自定义分页
要创建自定义的分页序列化程序类，可以继承分页基类，重写 paginate_queryset 和 get_paginated_response 方法
- paginate_queryset：分页所要操作的数据对象
- get_paginated_response：分页后的实际数据，并返回一个 Response
如希望可以返回分页数据时，带上分了多少页的信息，可以重写*****get_paginated_response*
from rest_framework.utils.urls import replace_query_param
class CustomPagination(PageNumberPagination):
def get_paginated_response(self, data):
url = self.request.build_absolute_uri()
num_pages = self.page.paginator.num_pages
return Response({
'links': {
'next': self.get_next_link(),
'previous': self.get_previous_link()
},
'count': self.page.paginator.count,
# 'num_pages': self.page.paginator.num_pages,
'num_pages': [
replace_query_param(
url, # 接口主机地址
self.page_query_param, # get传参时的页码标示
num_page # 带拼接的页码
)
for num_page in range(1, num_pages + 1) # 推导式
],
'results': data
})
过滤
过滤的功能就很简单了，可以通过给定的条件进行数据库字段查询，支持精准查询和模糊查询
- 首先安装需要支持的模块 django-filter，过滤基于该模块
pip3 install django-filter
- 使用过滤功能，首先要设置过滤功能引擎，打开 settings 配置
REST_FRAMEWORK = {
'DEFAULT_FILTER_BACKENDS':
['django_filters.rest_framework.DjangoFilterBackend']
}
- 或者还可以为使用 GenericAPIView作为基类的视图或每个视图集局部设置过滤器
from django_filters.rest_framework import DjangoFilterBackend
class UserListView(generics.ListAPIView):
...
filter_backends = [DjangoFilterBackend]
DjangoFilter 过滤
如果只需要简单的精准条件过滤，则可以 filterset_fields在视图或视图集上设置一个属性，列出要过滤的字段集
class List(generics.ListAPIView):
queryset = model.objects.all()
serializer_class = Serializer
filter_backends = [DjangoFilterBackend]
filterset_fields = ['name',...]
注意：这种方式只能是进行精准过滤，对相应字段进行精准匹配，无法做成模糊查询哦
- 如果希望完成一些模糊匹配的工作，可以自定义过滤类
from django_filters import FilterSet, rest_framework
class UserFilter(FilterSet):
name = rest_framework.CharFilter(
field_name="name", # 模型类中的字段
lookup_expr='contains' # 过滤链式条件
)
class Meta:
model = User # 模型
fields = ['name']
- 之后将自定义过滤类加持到视图类下
filter_class = UserFilter
SearchFilter 过滤
如果想要完成基本的模糊查询，可以使用另外一种过滤引擎，叫做 SearchFilter，这是一个由 rest_framework自带的过滤引擎，直接就可以实现模糊查询哦
from rest_framework import filters
class List(generics.ListAPIView):
queryset = model.objects.all()
serializer_class = Serializer
filter_backends = [filters.SearchFilter]
search_fields = ['name',...]
search_fields指明的即是一些文本字符串的字段，比如 CharField或 TextField这样的
- 还可以使用查找双下划线表示法在 ForeignKey或 ManyToManyField上执行相关查找
search_fields = ['username', 'foreignkey__field']
通过路由访问时，可以传递search参数来确定要过滤的条件
...?search=char
除此之外，字段还可以通过在字符前面添加各种字符来限制搜索行为
- **'^'：**从开头匹配搜索。
- '='：完全匹配
- '@'：全文搜索。当前仅支持 Django 的 PostgreSQL后端
- '$'：正则表达式搜索。
排序
很简单，就是将获取的数据按照一定的字段要求顺序进行排序，其实在 model模型类中也可以定义 ordering字段实现，排序实现其实还是用到了过滤部分的功能
实现排序要使用 DRF提供的 OrderingFilter实现
from rest_framework import filters
class SomeModelViewSet(ModelViewSet):
...
filter_backends = [filters.OrderingFilter]
ordering_fields = ['age','name']
- 这样的配置并不是自动默认就会排序的，还需要我们通过连接GET参数手动指明排序字段
http://127.0.0.1:8000/user/?ordering=-age # 从大到小
http://127.0.0.1:8000/user/?ordering=age # 从小到大
