「Django REST Framework 框架」Filtering过滤解析及应用举例

「爱情、让人受尽委屈。」 2022-11-19 07:58 484阅读 0赞

### 文章目录 ###

*  内容介绍
 *  Filtering过滤
 *  应用举例

# 内容介绍 #

开发环境为 Python3.6，Django 版本 3.0.x ，REST Framework 版本 3.12.x

全部内容索引目录  
**[看懂Django框架，没有最好只有更好][Django]**

框架通用列表试图默认返回模型管理器的整个查询集合，通常会控制 API 限制查询集返回的项目。

筛选 GenericAPIView 子类的任何视图的查询集的最简单方法即覆盖该 .get\_queryset()方法。

# Filtering过滤 #

**1.针对当前用户的过滤查询**

# 过滤查询集确保仅返回与发出请求的当前经过身份验证的用户相关的结果
    # 可以根据的值进行过滤 request.user
    
    from myapp.models import Purchase
    from myapp.serializers import PurchaseSerializer
    from rest_framework import generics
    
    class PurchaseList(generics.ListAPIView):
        serializer_class = PurchaseSerializer
    
        def get_queryset(self):
            """ 此视图应返回所有购买的清单当前验证的用户。 """
            user = self.request.user
            return Purchase.objects.filter(purchaser=user)

**2. 根据网址过滤**

# 涉及基于 URL 的某些部分限制查询集
    # 例如 URL 配置包含正则表达式
    re_path('^purchases/(?P<username>.+)/$', PurchaseList.as_view()),
    
    # 该视图返回按 URL 的用户名部分过滤的购买查询集
    class PurchaseList(generics.ListAPIView):
        serializer_class = PurchaseSerializer
    
        def get_queryset(self):
            """ 该视图应返回所有购买的清单 由URL的用户名部分确定的用户。 """
            username = self.kwargs['username']
            return Purchase.objects.filter(purchaser__username=username)

**3.根据查询参数过滤**

class PurchaseList(generics.ListAPIView):
        serializer_class = PurchaseSerializer
    
        def get_queryset(self):
            """ 将退回的购买限制为给定用户， 通过根据网址中的“用户名”查询参数进行过滤。 """
            queryset = Purchase.objects.all()
            username = self.request.query_params.get('username', None)
            if username is not None:
                queryset = queryset.filter(purchaser__username=username)
            return queryset

**4.通用过滤**  
通用过滤器还可以将自己显示为可浏览 API 和 admin API 中的 HTML 控件。  
同样django\_swager也可以实现同样的功能。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMjg4MzI3_size_16_color_FFFFFF_t_70]  
**5.设置过滤器后端**

# 参数全局设置默认过滤器后端
    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]

**6.过滤和对象查找**

# 视图配置了过滤器后端
    # 则该过滤器后端不仅用于过滤列表视图
    # 还将用于过滤用于返回单个对象的查询集
    
    http://example.com/api/products/4675/?category=clothing&max_price=10.00

**7.覆盖初始查询集**

# 使用覆盖 .get_queryset() 过滤和通用过滤
    # 例如 Product 与 User 为的多对多关系, 映射字段是 purchase
    class PurchasedProductsList(generics.ListAPIView):
        """ 返回经过身份验证的所有产品的列表 用户曾经购买过，并具有可选的过滤功能。 """
        model = Product
        serializer_class = ProductSerializer
        filterset_class = ProductFilter
    
        def get_queryset(self):
            user = self.request.user
            return user.purchase_set.all()

# 应用举例 #

# django-filter 库包含一个 DjangoFilterBackend 类
    # 该类支持针对框架的高度可自定义的字段筛选。
    # 安装
    pip install django-filter

**1.DjangoFilterBackend 查询类**

# settings.py中添加
    INSTALLED_APPS = [
        ...
        'django_filters',
        ...
    ]
    
    # settings.py全局设置
    REST_FRAMEWORK = { 
        'DEFAULT_FILTER_BACKENDS':
        	['django_filters.rest_framework.DjangoFilterBackend']
    }
    
    
    
    # 或将过滤器后端添加到单个 View 或 ViewSet
    from django_filters.rest_framework import DjangoFilterBackend
    
    class UserListView(generics.ListAPIView):
        ...
        filter_backends = [DjangoFilterBackend]
    
    
    # 如果只需要简单的基于等式的过滤可以在视图或视图集上设置一个 filterset_fields 属性并列出要过滤的字段集
    class ProductList(generics.ListAPIView):
        queryset = Product.objects.all()
        serializer_class = ProductSerializer
        filter_backends = [DjangoFilterBackend]
        filterset_fields = ['category', 'in_stock']
    
    # 请求举例
    http://example.com/api/products?category=clothing&in_stock=True
    
    # 对于更高级的过滤要求您可以指定视图应使用的 FilterSet 类。

**2.SearchFilter**  
![在这里插入图片描述][20210126133142869.png]

# SearchFilter 级支持简单单的查询参数基于搜索和基于该 admin 界面的搜索功能
    # 使用时可浏览的 API 将包含一个 SearchFilter 控件
    # SearchFilter 类仅在视图具有 search_fields 属性集的情况下应用
    # search_fields 属性应该是模型上文本类型字段名称的列表
    # 例如 CharField 或 TextField
    
    from rest_framework import filters
    
    class UserListView(generics.ListAPIView):
        queryset = User.objects.all()
        serializer_class = UserSerializer
        filter_backends = [filters.SearchFilter]
        search_fields = ['username', 'email']
    
    
    # 请求举例
    http://example.com/api/users?search=xxxx
    
    
    # 还可以使用查找 API 双下划线表示法在 ForeignKey 或 ManyToManyField 上执行相关查找
    search_fields = ['username', 'email', 'profile__profession']
    
    # 对于 JSONField 和 HStoreField 字段,
    # 可以使用相同的双下划线符号根据数据结构内的嵌套值进行过滤(就是高级)
    search_fields = ['data__breed', 'data__owner__other_pets__0__name']
    
    
    # 默认情况下搜索将使用不区分大小写的部分匹配
    # 搜索参数可以包含多个搜索词
    # 应将其用 空格 和 / 或 逗号 分隔
    # 如果使用多个搜索词则仅当所有提供的词都匹配时对象才会在列表中返回
    # 可以通过在 search_fields 字符前面添加各种字符来限制搜索行为
    # - '^' 开始搜索
    # - '=' 完全匹配
    # - '@' 全文搜索(当前仅支持 Django 的 PostgreSQL 后端)
    # - '$' 正则表达式搜索
    search_fields = ['=username', '=email']
    
    # 默认情况下搜索参数名为 'search'
    # 但是此参数可能会被 SEARCH_PARAM 设置覆盖
    # 要根据请求内容动态更改搜索字段
    # 可以对进行 SearchFilter 子类化并覆盖该 get_search_fields() 函数
    # 例如以下子类仅在查询参数 title_only 在请求中时才搜索 title
    from rest_framework import filters
    
    class CustomSearchFilter(filters.SearchFilter):
        def get_search_fields(self, view, request):
            if request.query_params.get('title_only'):
                return ['title']
            return super(CustomSearchFilter, self).get_search_fields(view, request)

**3.OrderingFilter**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMjg4MzI3_size_16_color_FFFFFF_t_70 1]

# OrderingFilter 类支持查询结果简单的查询参数进行顺序控制
    # 默认情况下查询参数名为 'ordering'
    # 但这可以被 ORDERING_PARAM 设置覆盖
    
    # 按用户名排序用户
    http://example.com/api/users?ordering=username
    
    # 客户端还可以通过在字段名称前添加 - 来实现倒序
    http://example.com/api/users?ordering=-username
    
    # 指定多个顺序
    http://example.com/api/users?ordering=account,username
    
    # 指定 API 应在排序过滤器中允许的字段视图上设置 ordering_fields
    class UserListView(generics.ListAPIView):
        queryset = User.objects.all()
        serializer_class = UserSerializer
        filter_backends = [filters.OrderingFilter]
        ordering_fields = ['username', 'email']
        
    
    # 为了防止意外的数据泄漏
    # 例如允许用户针对密码哈希字段或其他敏感数据进行排序
    # 如果未在视图上指定 ordering_fields 属性
    # 则过滤器类将默认为允许用户对 serializer_class 属性指定的序列化器上的任何可读字段进行过滤。
    # 视图使用的查询集不包含任何敏感数据, 则还可以通过使用 __all__全字段排序
    class BookingsListView(generics.ListAPIView):
        queryset = Booking.objects.all()
        serializer_class = BookingSerializer
        filter_backends = [filters.OrderingFilter]
        ordering_fields = '__all__'
        
    
    # 视图上设置了 ordering 属性它将用作默认顺序
    # 通常您可以通过 order_by 在初始查询集上进行设置来控制此操作
    # 但是使用 ordering 视图上的参数可以指定顺序
    # 然后将其作为上下文自动传递到呈现的模板
    # 如果使用列标题对结果进行排序，则可以自动呈现不同的列标题
    class UserListView(generics.ListAPIView):
        queryset = User.objects.all()
        serializer_class = UserSerializer
        filter_backends = [filters.OrderingFilter]
        ordering_fields = ['username', 'email']
        ordering = ['username']
        
    # ordering 属性可以是字符串，也可以是字符串列表、字符串元组

**4.自定义过滤**

# 重写 BaseFilterBackend 并重写 .filter_queryset(self, request，queryset, view) 方法
    # 该方法应返回一个经过过滤的新查询集。
    # 除了允许客户端执行搜索和过滤外
    # 通用过滤器后端对于限制对任何给定请求或用户应可见的对象也很有用
    class IsOwnerFilterBackend(filters.BaseFilterBackend):
        """ 仅允许用户查看自己对象的过滤器。 """
        def filter_queryset(self, request, queryset, view):
            return queryset.filter(owner=request.user)

**5.定制过滤界面**

# 通用过滤器还可以在可浏览的 API 中提供接口
    # 为此您应该实现一个 to_html() 方法
    # 该方法返回过滤器的呈现的 HTML 表示形式
    # 该方法应返回呈现的 HTML 字符串
    
    to_html(self, request, queryset, view)

**6.分页和模式**

# 还可以通过实现一种 get_schema_fields() 方法
    # 使过滤器控件可用于框架提供的模式自动生成
    # 该方法应返回 coreapi.Field 实例列表。
    
    get_schema_fields(self, view)

**7.第三方库**

# Django REST框架过滤器软件包
    # 在 Django 框架过滤器封装与 DjangoFilterBackend 类一起工作
    # 并允许在跨关系的创建过滤器或在指定字段创建多个过滤器查找类型
    
    
    # Django REST框架全字搜索过滤器
    # djangorestframework-word-filter作为 filter.SearchFilter 替代品
    # 将在文本中搜索完整的单词或完全匹配
    
    
    # Django URL过滤器
    # django-url-filter 提供了一种通过友好的 url 过滤数据的安全方法，
    # 工作原理与 DRF 序列化程序和字段非常相似
    # 在某种意义上它们可以嵌套，被称为 filtersets和 filters
    # 这提供了过滤相关数据的简单方法，而且这个库也是通用的
    # 所以它可以用来过滤其他数据源，而不仅仅是 Django QuerySet
    
    # drf-url-filters
    # DRF-URL-Filters 是一个简单的 Django 应用程序
    # 以干净、简单和可配置的方式在 drfmodelviewset 的 Queryset 上应用过滤器
    # 它还支持对传入查询参数的验证
    # Voluptuous 用于对传入的查询参数进行验证
    # 关于 Voluptuous 的最好的部分是您可以根据查询参数要求自定义的验证

[Django]: https://blog.csdn.net/qq_20288327/article/details/117383454
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMjg4MzI3_size_16_color_FFFFFF_t_70]: /images/20221119/f6c04f983316450d9d71bb6b1c0e0cce.png
[20210126133142869.png]: https://img-blog.csdnimg.cn/20210126133142869.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMjg4MzI3_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20210126133858846.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIwMjg4MzI3,size_16,color_FFFFFF,t_70