title: django-rest-framework過濾、搜索、排序、分頁
date: 2019-03-14 22:57:54
tags: drf
categories: 三月，2019
過濾
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
搜索
如果要明確指定可以對哪些字段進行搜索，可以使用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後端）
- ‘$’ ：正則表達式搜索
排序
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'
}