【django开发手册】详解drf filter中DjangoFilterBackend,SearchFilter,OrderingFilter使用方式

  • 💖 作者简介:大家好,我是Zeeland,开源建设者与全栈领域优质创作者。
  • 📝 CSDN主页:Zeeland🔥
  • 📣 我的博客:Zeeland
  • 📚 Github主页: Undertone0809 (Zeeland)
  • 🎉 支持我:点赞👍+收藏⭐️+留言📝
  • 💬介绍:The mixture of software dev+Iot+ml+anything🔥

Django系列专栏

  • 【django开发手册】Django 中使用自定义用户模型:一个比自带 User 更强的选择
  • 【django开发手册】如何使用select_related进行一次连表查询
  • 【django开发手册】drf通过添加自定义字段优化DRF序列化器,轻松实现高速API
  • 【django开发手册】解决admin添加外键下拉显示外键的问题
  • 【Django Rest Framework优化实践】ResponseResult、异常处理方法详解
  • 【DRF】深度分析枚举类型在DRF中的序列化问题及解决方案
  • 【django开发手册】关于django admin添加表信息的时候外键无法为空的问题解决方案
  • 【django开发手册】django admin如何显示外键对应的字段
  • 【django开发手册】DRF外键模型查询没有信息?教你实现序列化返回

前言

django restframework filter用于API的filter内容搜索,如对于/user接口,如果你想要查询其username字段,就使用/user/?username=jack的方式进行查询,这种方式就是通过drf的filter模块构建起来的,通过drf封装的filter模块,节约了自己写query代码的工作成本,而其底层本质是drf filter来帮你实现了数据库字段查询的功能,本文将重点介绍如何快速上手构建起drf的filter。

快速上手

首先先附上drf filter相关文档,没有什么比官方文档更加详细的了。

drf主要提供了DjangoFilterBackend,SearchFilter,OrderingFilter三种filter,通过三种不同的过滤器后端类,用于在API视图中实现数据过滤功能。

  1. DjangoFilterBackend:
    DjangoFilterBackend是DRF提供的一个过滤器后端类,它使用第三方库django-filter来执行过滤操作。它允许你根据模型的字段值进行高级过滤,并提供了丰富的过滤选项。你可以通过在视图中指定filter_backends属性为[DjangoFilterBackend]来使用该过滤器后端。

    DjangoFilterBackend做到的事情:

    • 支持通过URL参数进行过滤,例如:/user/?username=jack 这样的 ?field=value 查询方式。
    • 提供了各种过滤选项,如精确匹配、范围查询、日期过滤、外键关联过滤等。
    • 自动生成基于模型定义的过滤表单(FilterSet)。

    使用DjangoFilterBackend可以让你快速、方便地实现复杂的模型字段过滤需求,尤其是当你的过滤器需求比较复杂且需要自定义的时候。

  2. filters.SearchFilter:
    filters.SearchFilter是DRF提供的另一个过滤器后端类,用于执行文本搜索过滤。它基于数据库的全文搜索功能,可以在指定的字段上执行全文搜索,并返回匹配指定搜索词的结果。你可以通过将SearchFilter添加到视图的filter_backends属性列表中来使用它。

    filters.SearchFilter做到的事情:

    • 允许在API请求中通过URL参数指定搜索词,例如:?search=query
    • 支持在指定的字段上进行全文搜索,并返回匹配搜索词的结果。
    • 可以自定义搜索字段、搜索算法和搜索运算符等。

    使用filters.SearchFilter可以轻松地实现基于文本内容的搜索功能,如在文章标题、标签或用户名称等字段上执行搜索。它适用于需求比较简单的文本搜索场景。

  3. filters.OrderingFilter:

    filters.OrderingFilter是DRF提供的另一个过滤器后端类,用于对查询结果进行排序。它允许你通过URL参数指定排序字段,对返回的数据进行排序操作。

总结:

  • DjangoFilterBackend主要用于基于模型字段进行高级过滤,支持丰富的过滤选项和自定义。
  • filters.SearchFilter主要用于执行文本搜索过滤,支持在指定字段上进行全文搜索,并返回匹配搜索词的结果。
  • filters.OrderingFilter主要用于执行数据排序。

你可以根据你的具体需求选择合适的过滤器后端来实现数据过滤功能。如果你需要更精细的过滤控制和多字段过滤,DjangoFilterBackend是一个不错的选择。如果你只需要简单的文本搜索功能,filters.SearchFilter就足够了。在某些情况下,你甚至可以同时使用它们来实现更复杂的过滤需求,而filters.OrderingFilter的使用相对较少,因为在大多数情况下,排序是后端的工作,在接口内部已经做了相关的排序处理再返回给前端。下面将介绍三个的快速上手使用方式。

DjangoFilterBackend

在Django Rest Framework中,可以使用filters模块来根据数据库字段进行查询。以下是一个示例代码片段,说明如何在DRF中实现根据数据库字段查询的功能:

首先,确保你已经安装了Django Rest Framework。你可以使用以下命令安装它:

pip install djangorestframework

接下来,在你的Django项目的设置文件(settings.py)中,添加django_filtersINSTALLED_APPS设置中:

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

接下来,在你的Django项目的设置文件(settings.py)中,添加DEFAULT_FILTER_BACKENDSREST_FRAMEWORK设置中:

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

在你的应用程序的models.py文件中,定义你的模型类。例如,假设你有一个名为Book的模型,它有一个字段叫做title

from django.db import modelsclass Book(models.Model):title = models.CharField(max_length=100)# other fields...

接下来,创建一个序列化器(Serializer)来定义模型的序列化和反序列化行为。在你的应用程序的serializers.py文件中,创建一个名为BookSerializer的序列化器:

from rest_framework import serializers
from .models import Bookclass BookSerializer(serializers.ModelSerializer):class Meta:model = Bookfields = '__all__'  # 可以选择指定特定字段

现在,你可以在视图中使用过滤器查询数据库。在你的应用程序的views.py文件中,创建一个视图,并使用DRF的过滤器。以下是一个示例视图:

from rest_framework import viewsets
from .models import Book
from .serializers import BookSerializer
from django_filters.rest_framework import DjangoFilterBackendclass BookViewSet(viewsets.ModelViewSet):queryset = Book.objects.all()serializer_class = BookSerializerfilter_backends = [DjangoFilterBackend]filterset_fields = ['title']  # 指定要过滤的字段

在这个示例中,filterset_fields属性指定了你想要使用过滤器进行查询的字段。你可以根据需要添加或删除其他字段。

最后,在你的项目的URL配置文件(urls.py)中,将你的视图配置为路由,以便能够访问它:

from django.urls import include, path
from rest_framework import routers
from .views import BookViewSetrouter = routers.DefaultRouter()
router.register(r'books', BookViewSet)urlpatterns = [path('', include(router.urls)),
]

以上代码将创建一个名为books的URL路径,它将映射到你的BookViewSet视图。

完成以上步骤后,你可以使用类似以下的请求来过滤查询结果:

GET /books?title=your-search-term

以上请求将返回具有匹配标题的书籍对象。

注意:在实际开发中,你可能还需要进行身份验证和权限控制,以确保只有经过授权的用户可以访问你的API。以上示例中并未包含这些功能,你可以根据需要进行进一步的开发和配置。

SearchFileter

SearchFilter类支持简单的基于单个查询参数的搜索,并且基于Django管理员的搜索功能。

使用时,可浏览的API将包括一个SearchFilter控件:

使用方式如下所示:

from rest_framework import filtersclass UserListView(generics.ListAPIView):queryset = User.objects.all()serializer_class = UserSerializerfilter_backends = [filters.SearchFilter]search_fields = ['username', 'email']

运行应用之后,可以以如下方式运行接口:

http://example.com/api/users?search=russell

您还可以使用search_fields对外键和多对多字段进行查询,通过如下方式构建:

search_fields = ['username', 'email', 'profile__profession']

更多操作方式可以查看https://www.django-rest-framework.org/api-guide/filtering/#searchfilter

OrderingFilter

OrderingFilter类可以执行按照特定字段进行排序的操作,下面的示例展示了将查询出的users通过username和email进行排序的快速上手过程,首先构建一个ListAPIView。

class UserListView(generics.ListAPIView):queryset = User.objects.all()serializer_class = UserSerializerfilter_backends = [filters.OrderingFilter]ordering_fields = ['username', 'email']

然后你可以通过如下方式进行查询:

http://example.com/api/users?ordering=username

或者进行倒序查询

http://example.com/api/users?ordering=-username

总结

本文介绍了drf filter中DjangoFilterBackend,SearchFilter,OrderingFilter使用方式,更加进阶的使用方式,我更推荐你直接看官方文档,如有任何问题,欢迎交流讨论~

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/73639.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Java基础:反射

目录 一 概述二 反射的三种方式1、通过已实例化的java对象获取:xxx.getClass()2、通过类名获取:xxx.class3、通过类的全路径获取:Class.forName("xxx") 三 获取并使用类的构造方法1、获取构造方法:2、调用构造方法&…

Expected a mapping or list of mappings for merging, but found scalar

最近,在将项目转移到CircleCI时,遇到了这样一个错误,经过调查发现都说可能的原因缩进的问题导致的, 例如: definitions:steps:- step: &prepare-build-envname: Prepare build env 这里的name和- step 行之间应…

如何使用CSS实现一个响应式图片幻灯片(Responsive Image Slider)效果?

聚沙成塔每天进步一点点 ⭐ 专栏简介⭐ 响应式图片幻灯片⭐ HTML结构⭐ CSS样式⭐ JavaScript交互⭐ 写在最后 ⭐ 专栏简介 前端入门之旅:探索Web开发的奇妙世界 记得点击上方或者右侧链接订阅本专栏哦 几何带你启航前端之旅 欢迎来到前端入门之旅!这个…

Astro建站教程:安装nodejs,npm下载Astro,安装扩展

下载Nodejs LTS版:https://nodejs.org/en 安装步骤全默认即可,安装路径可以根据自己的爱好更改在桌面右键打开cmd或powershell,输入node -v和npm -v测试是否安装成功 浏览器打开https://docs.astro.build/en/install/auto/ 复制里面的npm cre…

糖生物学要点.4- 学习指南

学习指南 转到: 第1章 历史背景与概述 哪些因素阻碍了聚糖生物学(“糖生物学”)研究与传统分子和细胞生物学的整合? 为什么进化反复选择聚糖作为所有细胞表面的主要分子? 解释细胞外聚糖和核/胞质聚糖之间的区别。 影响…

安全狗陈奋:数据安全需要建立在传统网络安全基础之上

8月22日-23日,由创业邦主办的“2023 DEMO WORLD 企业开放式创新大会”在上海顺利举行。 作为国内云原生安全领导厂商,安全狗受邀出席此次活动。 本次大会以“拥抱开放”为主题,聚焦开放式创新,通过演讲分享、专场对接、需求发布…

你用过 Maven Shade 插件吗?

文章首发地址 Maven Shade插件是Maven构建工具的一个插件,用于构建可执行的、可独立运行的JAR包。它解决了依赖冲突的问题,将项目及其所有依赖(包括传递依赖)合并到一个JAR文件中。 下面是对Maven Shade插件的一些详解&#xff…

day 53 | 25. K 个一组翻转链表

25. K 个一组翻转链表 面试真的碰到了,可惜没a出来。 没啥特殊的算法,就是很难绕出来感觉。 /*** Definition for singly-linked list.* type ListNode struct {* Val int* Next *ListNode* }*/ func reverseKGroup(head *ListNode, k int) *L…

初学python的感受

目录 初学感受学习计划学习目标 初学感受 刚学python的我惊讶的发现编程语言之间竟有如此多的相似之处,因此在学python的时候相对于学C语言时要轻松的多,虽然二者也有一些不同之处,但是我想只要对二者稍微区分的话应该不会搞混的,并且在学习的过程中也可以借鉴学C语言的方法去…

MySQL知识笔记——初级基础(实施工程师和DBA工作笔记)

老生长谈,MySQL具有开源、支持多语言、性能好、安全性高的特点,广受业界欢迎。 在数据爆炸式增长的年代,掌握一种数据库能够更好的提升自己的业务能力(实施工程师)。 此系列将会记录我学习和进阶SQL路上的知识&#xf…

同一台Windows机器中启动多个Memcached服务

假设Memcached在如下目录:C:\memcached\memcached.exe 在CMD中执行如下命令即可再安装一个Memcached服务(记得换个端口号啊!): sc create "Memcached Server1" start auto binPath "C:\memcached\mem…

Revit SDK 介绍:RayTraceBounce 光线反弹

前言 这个例子模拟光线反弹。 内容 通过修改参数,从(0,0,0)点向(1,0,0)方向射出光线,经过若干次反弹之后的结果。如图所示: 在Revit API 中&…

Codeforces-Round-895-Div-3

A. Two Vessels 题目翻译 你有两个装有水的容器。第一个容器含有 a a a克水,第二个容器含有 b b b克水。这两艘船都非常大,可以容纳任意数量的水。 您还有一个空杯子,最多可容纳 c c c克水。 一次,您可以从任何容器中舀出多 c…

go语言基本操作--四

面向对象编程 对于面向对象编程的支持go语言设计得非常简洁而优雅。因为,Go语言并没有沿袭面向对象编程中诸多概念,比如继承(不支持继承,尽管匿名字段的内存布局和行为类似继承,但它并不是继承)、虚函数、构造函数和析构函数、隐…

HTTP代理如何设置

HTTP代理是一种非常重要的网络工具,它可以帮助我们在访问互联网时提高访问速度,保护用户隐私等等。在使用HTTP代理时,需要先进行设置。下面就来介绍一下HTTP代理如何设置。 一、了解HTTP代理 在开始设置HTTP代理之前,我们需要先了…

html 标签简介

概述 标签的效果不重要,重要的是标签的语义。 文本标签 文本标签用于包裹:词汇、短语等。排版标签,比如div,p,h1等。排版标签更宏观(大段的文字),文本标签更微观(词汇、短语)。文…

python实现根据词根词缀查询四级英语词汇

# !/usr/bin/env python # -*-coding:utf-8 -*- # File : 四级英语词汇学习.py # Time :2023/9/9 11:57 # Author :QQ736592720 import re from time import sleep from bs4 import BeautifulSoup import requests import jsondef get_w…

是的,决定放弃算法去机器学习了

可是梦想啊!~她永存心间!!! 我啊~本是执着于这些算法的怪咖,梦想是icpc,ccpc~ 可是啊~ 在以后的科研和工作中,这些算法很多都是用不到的,学习算法更重要的目的是锻炼编程能力和分析…

西门子LAD编程扫描周期带来的步序跳转问题

一、程序目的 按一下启动,程序进入第一步。延时五秒之后进入第二步进行自加1,然后回到第一步继续延时5秒循环,依次类推。 二、出现的问题 第一次程序进入第一步时,定时器正常定时,计数正常加1,但从第二轮开…

文件上传漏洞-upload靶场5-12关

文件上传漏洞-upload靶场5-12关通关笔记(windows环境漏洞) 简介 ​ 在前两篇文章中,已经说了分析上传漏的思路,在本篇文章中,将带领大家熟悉winodws系统存在的一些上传漏洞。 upload 第五关 (大小写绕过…