Django Restful（DRF）框架学习（四）搜索、分页、排序

一、分页

在实际开发中不可能直接把一个视图下的全部数据一次性发送出去。

1.1 全局分页

1. 在settings.py下配置即可设置全局分页的功能：为REST_FRAMEWORK字典加上'DEFAULT_PAGINATION_CLASS':'rest_framework.pagination.PageNumberPagination'。
2. PageNumberPagination类中有许多属性可以自己设置
   
3. 我们需要在视图(views.py)中编写对应模型的分页配置类并在对应模型的视图类中引用。

1.2 自定义分页

1.先在views.py定义一个分页配置类
from rest_framework import viewsets,filters,pagination

class PageSet(pagination.PageNumberPagination):
    #页面大小
    page_size = 3
    page_size_query_param = "size"
    max_page_size = 10
    page_query_param = "page"

2. 然后在之前写好的对应的模型类的ViewSet类中引用

class PageSet(pagination.PageNumberPagination):
    # 页面大小
    page_size = 3
    page_size_query_param = "size"
    max_page_size = 10
    page_query_param = "page"

class StudentViewSet(viewsets.ModelViewSet):
    #指定结果集并设置排序
        queryset = Student.objects.all().order_by('-pk')
    #指定序列化的类
        serializer_class = StudentSerializers
        pagination_class = PageSet

3. 可以通过两种方法测试

• count是该资源下的所有资源的数量。
• next是下一页的URL，这个非常重要，在许多场景下会使用得到。
• previous则是上一页，也是一个重要的功能
• results则是我们的结果集了。
  
  

4. 当然，也是可以临时指定size大小的
   http://127.0.0.1:8000/api/student/?page=1&size=10

5. 如果需要同时查找多个数据库记录时，客户端包括limit参数和offset参数，limit表示要返回的最大项目数，相当于其他样式中的page_size，offset表示查询其实位置。

• 先在settings.py中进行全局设置

REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASSES': (
    #   设置访问权限为只读
    'rest_framework.permissions.IsAuthenticatedOrReadOnly',
    #   设置访问权限为必须是用户
    # 'rest_framework.permissions.IsAuthenticated',
),
'DEFAULT_AUTHENTICATION_CLASSES': (
    'rest_framework_jwt.authentication.JSONWebTokenAuthentication',
    'rest_framework.authentication.BasicAuthentication',
    #可以用session登陆
    'rest_framework.authentication.SessionAuthentication',
    ),
'DEFAULT_PAGINATION_CLASS':('rest_framework.pagination.PageNumberPagination',
                            'rest_framework.pagination.LimitOffsetPagination',)
}

• 然后在views.py中写类

class LimitSet(pagination.PageNumberPagination):
    #每页默认几条
    default_limit = 3
    #url中指定页码的参数
    page_query_param = "page"
    #url中指定传入条数的参数
    limit_query_param = 'limit'
    #url中指定位置的参数
    offset_query_param = 'offset'
    max_limit = None

二、搜索功能

1. 这里讲的是利用framework框架简单快速设置搜索功能。
2. 在vies.py中导入模块，from rest_framework import viewsets,filters,pagination
3. 先在views.py定义一个中之前定义好的ViewSet类中加上filter

class StudentViewSet(viewsets.ModelViewSet):
    #指定结果集并设置排序
        queryset = Student.objects.all().order_by('-pk')
    #指定序列化的类
        serializer_class = StudentSerializers
    #指定分页配置
        pagination_class = PageSet
        #pagination_class = LimitSet
    #配置搜索功能
        filter_backends = (filters.SearchFilter,)
    #设置搜索的关键字
        search_fields = ('=name','id')

4. 这里的search_fields是指定需要过滤的字段，这里是姓名和学号。至于是否加等号的区别是加了等号是完全匹配。
5. 有两种测试方式
   

• 或者用url测试：http://example.com/list/?search=keyword
• 姓名是完全匹配
  
  
• 学号是模糊搜索
  

6. 搜索的方式有很多种

• ^：托字符
• =：完全匹配搜索
• @：全文搜索（只支持mysql）
• $:正则表达式搜索

三、排序功能

1. 这里所说的排序是在进行搜索时的排序，而不是直接使用get方法访问url所得到的的json数据的排序方式。
2. 仍然是在views.py下设置

class StudentViewSet(viewsets.ModelViewSet):
    #指定结果集并设置排序
        queryset = Student.objects.all().order_by('-pk')
    #指定序列化的类
        serializer_class = StudentSerializers
    #指定分页配置
        pagination_class = PageSet
        #pagination_class = LimitSet
    #配置搜索功能
        filter_backends = (filters.SearchFilter,filters.OrderingFilter,)
    #设置搜索的关键字
        search_fields = ('=name','sid')
    #设置搜索出的结果中需要排序的字段
        ordering_field = ('name','sid')

3. 测试
   
   
4. 而正序或者倒叙排序只是在字段名称前面是否加负号的区别