过滤

DRF列表视图的默认返回一个model的全部queryset：

但是，实际上，我们往往需要筛选满足条件的数据返回。

例如，我们需要返回姓名中含有”test“的数据，那我们应该怎么做呢？

重写get_queryset

重写这个方法，可以使用很多不同的方式来定制视图返回的结果集queryset。

class UserView(ListCreateAPIView):
    '''用户注册'''

    # 查询结果集
    #queryset = User.objects.all()
    # 序列化器
    serializer_class = UserSerializer
    
 # 重写get_queryset方法
    def get_queryset(self):
        '''筛选符合条件的结果'''

        keyword = self.request.query_params.get('q')

        if not keyword:  # 没有查询参数，则返回全部
            queryset = User.objects.all()
        else:
            queryset = User.objects.filter(username__icontains=keyword)

        return queryset

注意：DRF中你通过request.query_params获取GET请求发过来的参数，而不是request.GET。

如果希望获取从URL里传递的参数，你可以使用self.kwargs['param1']。例如：

path('users/<str:username>', AricleView.as_view()),



class UserView(ListCreateAPIView):
    '''用户注册'''

    # 查询结果集
    #queryset = User.objects.all()
    # 序列化器
    serializer_class = UserSerializer

    def get_queryset(self):
        '''筛选符合条件的结果'''

        username = self.kwargs['username']

        if not keyword:  # 没有查询参数，则返回全部
            queryset = User.objects.all()
        else:
            queryset = User.objects.filter(username__icontains=keyword)

        return queryset

当一个模型需要过滤的字段很多且不确定时(比如用户姓名，性别等), 重写get_queryset方法将变得非常复杂，代码会显得过于冗余，更好的方式是借助django-filter这个第三方库实现过滤。

使用django-filter

DRF本身没有提供这个过滤插件，我们需要安装django-filter扩展来支持。

django-filter库包含一个DjangoFilterBackend类，该类支持REST框架的高度可定制的字段过滤。它自定义需要过滤的字段非常方便, 还可以对每个字段指定过滤方法(比如模糊查询和精确查询)。

下载安装使用

1）下载安装：

pip install django-filter

2）配置文件中增加过滤设置：

INSTALLED_APPS = [
    ...,
    django_filters,
]


REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': ['django_filters.rest_framework.DjangoFilterBackend']
}

3）单个视图使用：

from django_filters.rest_framework import DjangoFilterBackend

class UserView(ListCreateAPIView):
    '''用户注册'''

    # 查询结果集
    queryset = User.objects.all()
    # 序列化器
    serializer_class = UserSerializer

    # 过滤器
    filter_backends = (DjangoFilterBackend,)
    # 通过filterset_fields设置希望过滤的字段
    filter_fields = ('is_active', 'username')

可以看出通过加过滤器和添加对应字段会过滤相关的，注意这里是精确匹配，字段间是且的关系，若一个为空，则按照其他的匹配，比如is_active=true&username=则按照is_active来精确查找。

默认是按照精准匹配，若想达到模糊搜索，可以自定义过滤类。需要自定义FilterSet类，然后指定filter_class。

自定义FilterSet类

1）新建过滤文件filters.py：

import django_filters

from .models import User

class UserFilter(django_filters.FilterSet):
    '''用户过滤类'''

    # 搜索用户名，不区分大小写包含
    username = django_filters.CharFilter(field_name='username', lookup_expr='icontains')

    class Meta:
        model = User
        # 需要过滤的字段
        fields = ('username', 'is_active')

2）将视图修改为：

from django_filters.rest_framework import DjangoFilterBackend

from .filters import UserFilter

class UserView(ListCreateAPIView):
    '''用户注册'''

    # 查询结果集
    queryset = User.objects.all()
    # 序列化器
    serializer_class = UserSerializer

    # 过滤器
    filter_backends = (DjangoFilterBackend,)
    # 通过filterset_fields设置希望过滤的字段
    #filter_fields = ('is_active', 'username')

    # 自定义过滤器类
    filter_class = UserFilter

3）测试：

使用SearchFilter类

其实DRF自身提供了SearchFilter类，与Django-filter的单字段过滤略有不同，更侧重于使用一个关键词对模型的某个字段或多个字段同时进行搜索。

使用方法：

from rest_framework.filters import SearchFilter

class UserView(ListCreateAPIView):
    '''用户注册'''

    # 查询结果集
    queryset = User.objects.all()
    # 序列化器
    serializer_class = UserSerializer

    # 过滤器
    filter_backends = (SearchFilter,)

    # 使用DRF提供的过滤功能的SearchFilter类
    # 允许搜索过滤的字段
    search_fields = ('username', 'email')

上面是同一个关键字对配置的多个字段搜索search_fields = ('username', 'email')。

注意：这里进行搜索查询的默认参数名为search=xxx。

SearchFilter类非常有用，因为它不仅支持对模型的多个字段进行查询，还支持ForeinKey和ManyToMany字段的关联查询。按如下修改search_fields，就可以同时搜索标题或用户名含有某个关键词的文章资源列表。修改好后，作者用户名里如果有django，该篇文章也会包含在搜索结果了。

search_fields = ('title', 'author__username')

默认情况下，SearchFilter类搜索将使用不区分大小写的部分匹配(icontains)。你可以在search_fields中添加各种字符来指定匹配方法。

• ^开始 - 搜索。
• =完全匹配。
• @全文搜索。
• $正则表达式搜索。

例如：search_fields = (‘=title’, )精确匹配title。

排序

DRF提供了对排序的支持，使用DRF提供的OrderingFilter过滤器后端即可。

使用OrderingFilter类首先要把它加入到filter_backends，然后指定排序字段即可。

使用ordering_fields属性来指明可以进行排序的字段有哪些。

from rest_framework.filters import OrderingFilter


class UserView(ListCreateAPIView):
    '''用户注册'''

    # 查询结果集
    queryset = User.objects.all()
    # 序列化器
    serializer_class = UserSerializer

    # 过滤器
    #filter_backends = (SearchFilter,)

    # 排序过滤器
    filter_backends = (OrderingFilter,)

    # 指定排序字段
    ordering_fields = ('id', 'date_joined')

负数为倒序！！

如果不在视图上指定ordering_fields属性，过滤器类将默认允许用户对serializer_class属性指定的serializer上的任何可读字段进行过滤。

我们还可以指定默认排序：

    filter_backends = (OrderingFilter,)

    # 指定排序字段
    ordering_fields = ('id', 'date_joined')

    # 指定默认排序字段
    ordering = ('-id',)

默认按照id倒序输出。

#DRF#