django-9-过滤

一、DRF中的过滤

REST framework 的通用列表视图的默认行为是返回模型管理器的整个查询集。通常，您希望 API 限制查询集返回的 数据。 过滤子类化的任何视图的查询集的最简单方法是覆盖GenericAPIView.get_queryset()方法。 覆盖此方法允许您以多种不同方式自定义视图返回的查询集。 

1.1 针对当前用户过滤

您可能希望过滤查询集以确保只返回与当前已通过身份验证的发出请求的用户相关的结果。 您可以通过 request.user 的值进行过滤来实现。

from rest_framework import viewsets

from rest_framework.permissions import IsAuthenticated

from rest_framework.pagination import PageNumberPagination

from projects import serializers

from projects import models

from projects.permissions import IsOwnerOrReadOnly, IsLeaderCreateOnly

class ProjectViewSet(viewsets.ModelViewSet):
    """
   project视图集

   """

    serializer_class = serializers.ProjectSerializer

    permission_classes = [IsAuthenticated, IsOwnerOrReadOnly]
 
    def get_queryset(self)
        return models.Project.objects.filter(leader=self.request.user)

1.2 根据路径参数过滤

另一种过滤方式可能涉及基于 URL 的某些部分限制查询集。 

例如，如果您的 URL 配置包含这样的条目：

re_path('^projects/(?P<username>.+)/$', ProjectViewSet.as_view()),

然后，您可以编写一个视图，该视图返回由 URL 的用户名部分过滤的项目查询集：

def get_queryset(self)
    username = self.kwargs['username']
    return models.Project.objects.filter(leader__username=username)

1.3 根据查询参数过滤

过滤初始查询集的最后一个示例是根据 url 中的查询参数确定初始查询集。 

我们可以覆盖 .get_queryset() 以处理诸如http://example.com/api/purchases?username=denvercoder9 之 类的 URL，并且仅当URL 中包含 username 参数时才过滤查询集：

def get_queryset(self)
    queryset = models.Project.objects.all()
    username = self.request.query_params.get('username')
    if username is not None:
        queryset = queryset.filter(leader__username=username)
    return queryset

1.4 通用过滤

除了能够覆盖默认查询集之外，REST 框架还包括对通用过滤后端的支持，允许您轻松构建复杂的搜索和过滤器。

1.4.1 设置通用过滤后端

可以使用设置全局 设置默认过滤器后端 DEFAULT_FILTER_BACKENDS 。

例如：

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

您还可以使用 GenericAPIView 基于类的视图在每个视图或每个视图集的基础上设置过滤器后端。

import django_filters.rest_framework

from django.contrib.auth.models import User

from myapp.serializers import UserSerializer

from rest_framework import generics

class UserListView(generics.ListAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

    filter_backends = [django_filters.rest_framework.DjangoFilterBackend]

注意：

• 一般情况下我们不需要自己实现过滤后端，有很多很成熟的三方插件供我们选择。我们这里使用 django-filter
• 一般情况我们设置为全局过滤后端，因为，在视图中，只要不设置过滤字段，这个过滤器就不会生效

二、安装django-filter

2.1 安装

该 django-filter 库包括一个支持 REST 框架的高度可定制的字段过滤的类 DjangoFilterBackend 。 要使用 DjangoFilterBackend ，请先安装 django-filter 。

pip install django-filter

2.2 配置

然后添加 'django_filters' 到 Django 的 INSTALLED_APPS ：

INSTALLED_APPS = [
   ...
    'django_filters',
   ...
]

现在应该将过滤器后端添加到您的设置中：

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

或者将过滤器后端添加到单个视图或视图集。

from django_filters.rest_framework import DjangoFilterBackend

class UserListView(generics.ListAPIView):
   ...
    filter_backends = [DjangoFilterBackend]

2.3 使用

在后端类视图或者视图集中添加 filterset_fields 属性即可实现指定字段过滤

例如改写环境管理视图集如下：

class TestEnvViewSet(ModelViewSet):
    """测试环境视图集"""

    queryset = TestEnv.objects.all()
    serializer_class = TestEnvSerializer

    filterset_fields = ('project', )
    permission_classes = [IsAuthenticated]

不需要在复写 get_queryset 方法手动过滤，就可以通过url /test_envs/?project=1 访问过滤数据了。 

注意：当使用外键字段过滤时，如果级联模式是删除，则使用不存在的数据过滤会返回400响应。例如上面的视图如 果使用不存在的项目id过滤返回结果如下：

 # http://127.0.0.1:8000/environments/?project=2

{
    "project": [
        "选择一个有效的选项： 该选择不在可用的选项中。"

   ]
}

更多详细用法见官方文档：https://django-filter.readthedocs.io/en/latest/guide/rest_framework.html