django-rest-framework(实战篇)——过滤、搜

2018-04-09 本文已影响194人 Ccccolin_aha

一、过滤

official API guide—Filter
django-filter库包括一个DjangoFilterBackend类，它支持REST框架的高度可定制的字段过滤。
首先安装django-filter，然后将django_filters添加到Django的INSTALLED_APPS。
在settings.py加上如下配置：

REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',)
}

或者将过滤器加到单个View或ViewSet中(一般使用这种)：

from django_filters.rest_framework import DjangoFilterBackend

class UserListView(mixins.ListModelMixin, viewsets.GenericViewSet):
    ...
    filter_backends = (DjangoFilterBackend,)

如果要允许对某些字段进行过滤，可以使用filter_fields属性。

class ProductList(mixins.ListModelMixin, viewsets.GenericViewSet):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer
    filter_backends = (DjangoFilterBackend,)
    filter_fields = ('category', 'in_stock')

还可以自定义过滤类，再用filter_class指定过滤集合类

import django_filters
from myapp.models import Product
from myapp.serializers impoert ProductSerializer
from rest_framework import filters
from rest_framework import generics

class ProductFilter(filters.FilterSet):
　　min_price = django_filters.NumberFilter(name=’price’, lookup_type=”gte”)
　　max_price = django_filters.NumberFilter(name=’price’, lookup_type=”lte”)
　　# 行为: 名称中包含某字符，且字符不区分大小写
　　name = filters.CharFilter(name='name', lookup_expr='icontains')
　　class Meta:
　　　　model = Product
　　　　fields = [‘category’, ‘in_stock’, ‘min_price’, ‘max_price’]

class ProductList(mixins.ListModelMixin, viewsets.GenericViewSet):
　　queryset = Product.object.all()
　　serializer_class = ProductSerializer
　　filter_backends = (filter.DjangoFilterBackend,)
　　filter_class = ProductFilter

二、搜索

official API guide—Searching
如果要明确指定可以对哪些字段进行搜索，可以使用search_fields属性，默认为可以对serializer_class属性指定的串行器上的任何可读字段进行搜索：

class UserListView(mixins.ListModelMixin, viewsets.GenericViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    filter_backends = (filters.SearchFilter,)
    search_fields = ('username', 'email')

也可以使用双下划线在Foreign Key或ManyToManyField上执行相关查找：

search_fields = ('username', 'email', 'profile__profession')

默认情况下，搜索将使用不区分大小写的部分匹配。搜索参数可以包含多个搜索项，它们应该是空格和/或逗号分隔。如果使用多个搜索项，则仅当所有提供的条款匹配时，才会在列表中返回对象。默认情况下，搜索参数被命名为“search”，但这可能会被SEARCH_PARAM设置覆盖。
The search behavior may be restricted by prepending various characters to the search_fields.
可以通过在search_fields中加入一些字符来限制搜索行为，如下：

'^' ：以xx字符串开始搜索
'=' ：完全匹配
'@' ：全文搜索（目前只支持Django的MySQL后端）
'$' ：正则表达式搜索

三、排序

official API guide—Ordering
OrderingFilter类支持简单的查询参数控制结果排序。
默认情况下，查询参数被命名为“ordering”，但这可能会被ORDERING_PARAM设置覆盖。
可以使用ordering_fields属性明确指定可以对哪些字段执行排序，这有助于防止意外的数据泄露，例如允许用户对密码散列字段或其他敏感数据进行排序。
如果不指定ordering_fields属性，则默认为可以对serializer_class属性指定的串行器上的任何可读字段进行过滤。

class UserListView(generics.ListAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    filter_backends = (filters.OrderingFilter,)
    ordering_fields = ('username', 'email')

使用ordering属性设置默认排序：
ordering = ('username',)

四、分页

可以直接在view.py中自定义分页规则

class StandardResultsSetPagination(PageNumberPagination):
    """
    配置分页规则
    """
    page_size = 12
    page__size_query_param = 'page_size'
    page_query_param = 'page'
    max_page_size = 100

应用到视图函数中：

class GoodsListViewSet(mixins.ListModelMixin, viewsets.GenericViewSet):
...
    pagination_class = StandardResultsSetPagination
...

PageNumberPagination：此分页样式在请求查询参数中接受单个编号页码。
请求示例：GET https://api.example.org/accounts/?page=4
全局设置

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination'
}

PageNumberPagination类包括可以覆盖以修改分页样式的许多属性，要设置这些属性，应覆盖PageNumberPagination类，然后如上所示启用自定义分页类。
django_paginator_class：使用的Django Paginator类，默认是django.core.paginator.Paginator，对大部分用例是适用的。
page_size：数值，页面大小，默认是全局PAGE_SIZE的值。
page_query_param：字符串，查询参数的名称，默认是'page'
page_size_query_param：字符串，请求设置页面大小的参数名称，默认是None，表示客户端可能无法控制请求的页面大小。
max_page_size：字符串，最大允许请求的页面大小，此属性仅在page_size_query_param也被设置时有效。
last_page_strings：字符串列表或者元组，默认是('last',)
template：分页控件使用的模板的名称，可以覆盖或设置为None，默认为"rest_framework/pagination/numbers.html"

LimitOffsetPagination：查找多个数据库记录时使用的语法，客户端包括“limit”和“offset”查询参数，limit指示要返回的最大项目数，并且相当于其他样式中的page_size，offset表示查询起始位置。
请求示例：GET https://api.example.org/accounts/?limit=100&offset=400
全局设置

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination'
}

django-rest-framework(实战篇)——过滤、搜

一、过滤

二、搜索

三、排序

四、分页

猜你喜欢

热点阅读