django rest framework使用django-filter用法

1. Django Rest Framework 简介

在介绍Django Rest Framework使用django-filter之前，首先需要了解Django Rest Framework（简称DRF）是什么。

Django Rest Framework是一个用于构建Web API的强大框架，它是建立在Django的基础上，可以帮助开发者更轻松地构建和管理API。它提供了一组工具和库，可以用于处理序列化、验证、渲染、分页等Web API开发的常见任务。使用DRF可以很方便地编写出高效、灵活且易于维护的API代码。

2. Django-filter 简介

Django-filter是Django的一个扩展库，用于对查询结果进行过滤。它提供了一种简洁明了的方式，可以根据一定的条件过滤数据库中的数据，将符合条件的数据返回给前端。

3. Django Rest Framework 中使用 Django-filter

3.1 安装 Django-filter

在开始使用 Django-filter 之前，需要先安装 Django-filter 库。可以通过以下命令进行安装：

pip install django-filter

3.2 配置 Django-filter

在使用 Django-filter 之前，需要在 Django Rest Framework 中进行配置。

首先，在项目的 settings.py 文件中加入以下代码：

INSTALLED_APPS = [

    ...
    'django_filters',
]

然后，在需要使用 Django-filter 的视图函数中引入相关模块：

from django_filters.rest_framework import DjangoFilterBackend

接下来，在视图类中添加 `filter_backends` 属性，并指定使用的过滤器类：

class MyView(viewsets.ModelViewSet):

    ...
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['name', 'age']

在上面的代码中，通过 `filter_backends` 属性将 `DjangoFilterBackend` 添加到过滤器后端列表中，并通过 `filterset_fields` 指定了要过滤的字段。

3.3 使用 Django-filter 进行过滤

在配置完 Django-filter 后，就可以在视图函数中使用它进行过滤了。在视图的查询集上，可以使用 `filter_queryset` 方法对查询结果进行过滤。该方法接受一个参数 request，可以使用其中的 query_params 属性来获取前端传递过来的参数。

class MyView(viewsets.ModelViewSet):

    ...
    def filter_queryset(self, queryset):
        queryset = super().filter_queryset(queryset)
        return queryset.filter(name__icontains=self.request.query_params.get('name', ''))

在上面的代码中，首先调用了父类的 filter_queryset 方法来获取默认的查询结果，然后使用 filter 方法对查询结果进行进一步的过滤。

在过滤时，可以根据前端传递的参数来进行过滤。例如，在上面的代码中，我们使用了 `icontains` 查询条件，该条件表示对 name 字段进行模糊匹配，忽略大小写。

4. 总结

通过本文的介绍，我们了解了 Django Rest Framework 的概念和 Django-filter 的使用方法。使用 Django-filter 可以更方便地对查询结果进行过滤，提供更准确的返回结果。在实际项目中，可以根据具体的需求，灵活地应用 Django-filter 进行数据过滤。

最后，希望本文对于学习和使用 Django Rest Framework 和 Django-filter 有所帮助。