Django-drf过滤功能

前言

这几年一直在it行业里摸爬滚打，一路走来，不少总结了一些python行业里的高频面试，看到大部分初入行的新鲜血液，还在为各样的面试题答案或收录有各种困难问题

于是乎，我自己开发了一款面试宝典，希望能帮到大家，也希望有更多的Python新人真正加入从事到这个行业里，让python火不只是停留在广告上。

微信小程序搜索：Python面试宝典

或可关注原创个人博客：https://lienze.tech

也可关注微信公众号，不定时发送各类有趣猎奇的技术文章：Python编程学习

过滤

过滤的功能就很简单了，可以通过给定的条件进行数据库字段查询，支持精准查询和模糊查询

• 首先安装需要支持的模块 django-filter，过滤基于该模块

pip3 install django-filter

• 使用过滤功能，首先要设置过滤功能引擎，打开 settings 配置

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

• 或者还可以为使用 **GenericAPIView作为基类的视图或每个视图集局部设置过滤器

from django_filters.rest_framework import DjangoFilterBackend
class UserListView(generics.ListAPIView):
    ...
    filter_backends = [DjangoFilterBackend]

DjangoFilter 过滤

如果只需要简单的精准条件过滤，则可以 **filterset_fields在视图或视图集上设置一个属性，列出要过滤的字段集

class List(generics.ListAPIView):
    queryset = model.objects.all()
    serializer_class = Serializer
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['name',...]

注意：这种方式只能是进行精准过滤，对相应字段进行精准匹配，无法做成模糊查询哦

• 如果希望完成一些模糊匹配的工作，可以自定义过滤类

from django_filters import FilterSet, rest_framework
class UserFilter(FilterSet):
    name = rest_framework.CharFilter(
        field_name="name", # 模型类中的字段
        lookup_expr='contains' # 过滤链式条件
    )
    class Meta:
        model = User  # 模型
        fields = ['name']

• 之后将自定义过滤类加持到视图类下

filter_class = UserFilter

SearchFilter 过滤

如果想要完成基本的模糊查询，可以使用另外一种过滤引擎，叫做 SearchFilter，这是一个由 ***rest_framework***自带的过滤引擎，直接就可以实现模糊查询哦

from rest_framework import filters
class List(generics.ListAPIView):
    queryset = model.objects.all()
    serializer_class = Serializer
    filter_backends = [filters.SearchFilter]
    search_fields = ['name',...]

***search_fields***指明的即是一些文本字符串的字段，比如 ***CharField***或 ***TextField***这样的

• 还可以使用查找双下划线表示法在 ***ForeignKey***或 ***ManyToManyField***上执行相关查找

search_fields = ['username', 'foreignkey__field']

通过路由访问时，可以传递***search***参数来确定要过滤的条件

...?search=char

除此之外，字段还可以通过在字符前面添加各种字符来限制搜索行为

• **’^’：**从开头匹配搜索。
• ’=’：完全匹配
• ’@’：全文搜索。当前仅支持 Django 的 ***PostgreSQL***后端
• ’$’：正则表达式搜索。