Django(69)最好用的过滤器插件Django-filter「建议收藏」

Django(69)最好用的过滤器插件Django-filter「建议收藏」前言如果需要满足前端各种筛选条件查询,我们使用drf自带的会比较麻烦,比如查询书名中包含“国”字,日期大于“2020-1-1”等等诸如此类的请求,Django-filter这个组件就是要解决这样的问

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

前言

  如果需要满足前端各种筛选条件查询,我们使用drf自带的会比较麻烦,比如查询书名中包含“国”字,日期大于“2020-1-1”等等诸如此类的请求,Django-filter这个组件就是要解决这样的问题。
 

1.安装

Django-filter支持的Python版本和Django版本、DRF版本如下:

  • Python: 3.5, 3.6, 3.7, 3.8
  • Django: 1.11, 2.0, 2.1, 2.2, 3.0
  • DRF: 3.10+

在虚拟环境中安装

pip3 install django-filter

Djangosettings.py文件中安装并配置django_filters应用:

INSTALLED_APPS = [
    ...
    'django_filters',
]

REST_FRAMEWORK = {
   # 过滤器默认后端
    'DEFAULT_FILTER_BACKENDS': (
           'django_filters.rest_framework.DjangoFilterBackend',),
}

 

2.使用流程

我们通过一个简单的图书查询来说明如果在DRF中使用Django-filter过滤器。图书模型如下:

# models.py
class BookInfo(models.Model):
    title = models.CharField(max_length=200,verbose_name='标题')
    pub_date = models.DateField(blank=True, null=True,verbose_name='出版日期')
    read = models.IntegerField(null=True,verbose_name='阅读数量')
    comment = models.IntegerField(null=True,verbose_name='评论数量')
    image = models.CharField(max_length=200, blank=True, null=True,verbose_name='图片')

    class Meta:
        db_table = 'bookInfo'
        verbose_name = "图书"

序列化类:

# serializers.py
class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = BookInfo
        fields = '__all__'

自定义过滤器类:

# filters.py
from django_filters import rest_framework as filters
from . models import BookInfo
class BookFilter(filters.FilterSet):
    min_read = filters.NumberFilter(field_name="read", lookup_expr='gte')
    max_read = filters.NumberFilter(field_name="read", lookup_expr='lte')

    class Meta:
        model = BookInfo
        fields = ['read']

在视图中

# views.py
class BookView(ListAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookSerializer
    filter_class = BookFilter

url配置中

app_name = "api"


urlpatterns = [
    path('books/', views.BookView.as_view()),
]

现在我们想筛选阅读数为500-1000的图书,测试结果如下
Django(69)最好用的过滤器插件Django-filter「建议收藏」
 

详解过滤器类

  过滤器类和Django中表单类极其类似,写法基本一样,目的是指明过滤的时候使用哪些字段进行过滤,每个字段可以使用哪些运算。运算符的写法基本参照DjangoORM中查询的写法,比如:大于等于,小于等于用"gte""lte"等等

可以通过模型快速构建过滤器类

from django_filters import rest_framework as filters
class BookFilter(filters.FilterSet):
    class Meta:
        model = BookInfo   # 模型名
        fields = ['title','comment']  # 可以使用的过滤字段

Meta中出现的fields是指过滤条件中可以出现的字段,默认是精确判断相等,查询的时候可以这样用:

http://127.0.0.1:8000/api/books/?comment=20&title=

以上代表查询的是评论条数为20条的书本

如果不是判断相等,可以自定义过滤字段进行过滤:

  • 过滤器中常用的字段类型,这些类型要输模型中对应字段类型兼容
CharFilter         字符串类型
BooleanFilter      布尔类型
DateTimeFilter     日期时间类型
DateFilter         日期类型
DateRangeFilter    日期范围
TimeFilter         时间类型
NumberFilter       数值类型,对应模型中IntegerField, FloatField, DecimalField
  • 过滤字段参数说明:
field_name: 过滤字段名,一般应该对应模型中字段名
lookup_expr: 查询时所要进行的操作,和ORM中运算符一致
  • Meta字段说明
model: 引用的模型,不是字符串
fields:指明过滤字段,可以是列表,列表中字典可以过滤,默认是判断相等;也可以字典,字典可以自定义操作
exclude = ['password'] 排除字段,不允许使用列表中字典进行过滤

自定义过滤字段:

class BookFilter(filters.FilterSet):
    title = filters.CharFilter(field_name='title',lookup_expr='icontains')  # 标题中包含
    pub_year = filters.CharFilter(field_name='pub_date',lookup_expr='year')  # 过滤年份相等
    pub_year__gt = filters.CharFilter(field_name='pub_date',lookup_expr='year__gt')  # 过滤大于年份
    read__gt = filters.NumberFilter(field_name='read',lookup_expr="gt")  # 最大阅读数
    read__lt = filters.NumberFilter(field_name='read',lookup_expr="lt")  # 最小阅读数

    class Meta:
        model = BookInfo
        fields = ['title','read','comment']

自定义字段名可以和模型中不一致,但一定要用参数field_name指明对应模型中的字段名
 

日期查询

定义按年查询

pub_year = filters.CharFilter(field_name='pub_date',lookup_expr='year')

年份应该大于某值

pub_year__gt = filters.CharFilter(field_name='pub_date',lookup_expr='year__gt')

年份应该小于某值

read__lt = filters.NumberFilter(field_name='read',lookup_expr="lt")

查询出版年份大于2019年的书本

http://127.0.0.1:8000/api/books/?title=&read=&comment=&pub_year=&pub_year__gt=2019&read__gt=&read__lt=

查询结果:

[
    {
        "id": 1,
        "title": "钢铁是怎样练成的",
        "pub_date": "2020-10-09",
        "read": 100,
        "comment": 3,
        "image": null
    }
]

 

标题查询

title查询的时候可以进行包含查询,icontainsORM中表示不区分大小的包含

title = filters.CharFilter(field_name='btitle',lookup_expr='icontains')

查询标题中包含三国演义的书籍

http://127.0.0.1:8000/api/books/?title=%E4%B8%89%E5%9B%BD%E6%BC%94%E4%B9%89&read=&comment=&pub_year=&pub_year__gt=&read__gt=&read__lt=

查询结果:

[
    {
        "id": 2,
        "title": "三国演义",
        "pub_date": "2019-11-12",
        "read": 200,
        "comment": 20,
        "image": null
    }
]

 

阅读数查询

阅读数大于

read__gt = filters.NumberFilter(field_name='read',lookup_expr="gt")

阅读数小于

read__lt = filters.NumberFilter(field_name='read',lookup_expr="lt")

查询阅读数在100-300之间的书籍

http://127.0.0.1:8000/api/books/?title=&read=&comment=&pub_year=&pub_year__gt=&read__gt=100&read__lt=300

查询结果:

[
    {
        "id": 2,
        "title": "三国演义",
        "pub_date": "2019-11-12",
        "read": 200,
        "comment": 20,
        "image": null
    }
]

 
官方文档:https://django-filter.readthedocs.io/en/stable/guide/install.html

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员-用户IM,转载请注明出处:https://javaforall.cn/165754.html原文链接:https://javaforall.cn

【正版授权,激活自己账号】: Jetbrains全家桶Ide使用,1年售后保障,每天仅需1毛

【官方授权 正版激活】: 官方授权 正版激活 支持Jetbrains家族下所有IDE 使用个人JB账号...

(0)


相关推荐

  • 百度快照更新方法「建议收藏」

    百度快照更新方法「建议收藏」大家在建站过程中,可能都会遇到百度快照不更新的问题。我也不例外,帮朋友维护的一网站(QQ空间留言代码)百度快照时间停在了3月1号,一直到7号也没更新,而同类网站的百度快照几乎天天更新。我这里说的是百度快照不更新,但网站的关键字排名却没有发生变化。分析原因。这个网站(www.xkyy18.cn)也没有作弊的地方,有的只是适当的优化;在1号当天网站首页增加了一个信息小版块,链接增加了28个,然后

  • 中高级Java开发面试题,最难的几道Java面试题,看看你跪在第几个

    中高级Java开发面试题,最难的几道Java面试题,看看你跪在第几个5.为什么char数组比Java中的String更适合存储密码?另一个基于String的棘手Java问题,相信我只有很少的Java程序员可以正确回答这个问题。这是一个真正艰难的核心Java面试问题,并且需要对String的扎实知识才能回答这个问题。这是最近在Java面试中向我的一位朋友询问的问题。他正在接受技术主管职位的面试,并且有超过6年的经验。如果你还没有遇到过这种情况,那么字符数组和字符串可以用来存储文本数据,但是选择一个而不是另一个很难。但正如我的朋友所说,任何

  • vue跨域解决方案反向代理_怎么解决跨域问题

    vue跨域解决方案反向代理_怎么解决跨域问题文章目录前言一、跨域是什么?二、解决跨域的办法前言跨域错误信息AccesstoXMLHttpRequestat‘http://192.168.2.92:3000/api/b/home’fromorigin‘http://localhost:8080’hasbeenblockedbyCORSpolicy:Responsetopreflightrequestdoesn’tpassaccesscontrolcheck:ItdoesnothaveHTTP

  • Mybatis源码:@MapperScan解析过程

    Mybatis源码:@MapperScan解析过程目录0.说明1.@MapperScan2.MapperScannerRegister3.ClassPathMapperScanner4.MapperFactoryBean0.说明mybatis构建过程主要包括:解析mybatis配置文件,构造Configuration配置类对象和SqlSessionFactory; 利用@MapperScan注册BeanDe…

  • Spring中Model、ModelMap、ModelAndView理解和具体使用总结

    Spring中Model、ModelMap、ModelAndView理解和具体使用总结在了解这三者之前,需要知道一点:SpringMVC在调用方法前会创建一个隐含的数据模型,作为模型数据的存储容器,成为”隐含模型”。也就是说在每一次的前后台请求的时候会随带这一个背包,不管你用没有,这个背包确实是存在的,用来盛放我们请求交互传递的值;关于这一点,spring里面有一个注解:@ModelAttribute:被该注解修饰的方法,会在每一次请求时优先执行,用于接收前台js…

  • Hmily:轻轻松松搞定高并发分布式事务[通俗易懂]

    Hmily:轻轻松松搞定高并发分布式事务[通俗易懂]点击上方“芋道源码”,选择“置顶公众号”技术文章第一时间送达!源码精品专栏 精尽Dubbo原理与源码 69篇精尽Netty原理与源码 61篇中文详细注释的开源…

发表回复

您的电子邮箱地址不会被公开。

关注全栈程序员社区公众号