7.DRF 过滤、排序、分页

过滤Filtering

对于列表数据可能需要根据字段进行过滤,我们可以通过添加django-fitlter扩展来增强支持。

pip install django-filter

在配置文件中增加过滤器类的全局设置:

"""drf配置信息必须全部写在REST_FRAMEWORK配置项中"""
REST_FRAMEWORK = {# ....代码省略。。。# 过滤查询,全局配置'DEFAULT_FILTER_BACKENDS': ['django_filters.rest_framework.DjangoFilterBackend'],
}

在视图类中添加类属性filter_fields,指定可以过滤的字段

class Hom4APIView(ModelViewSet):queryset = Student.objects.all()serializer_class = StudentModelSerializerfilter_fields = ["sex","classmate"]# list方法中进行调用->调用了GenericAPIView中声明的filter_queryset方法---> 配置中的过滤器类的filter_queryset---> filter_fields# 单个字段过滤
# http://127.0.0.1:8000/opt/s4/?classmate=502&sex=2
# http://127.0.0.1:8000/opt/s4/?sex=2
# 多个字段过滤
# http://127.0.0.1:8000/opt/s4/?classmate=502&sex=2

路由代码:

from django.urls import path,include
from . import viewsfrom rest_framework.routers import DefaultRouter
router = DefaultRouter()
router.register("s2", views.Hom2APIView, "s2")
router.register("s4", views.Hom4APIView, "s4")urlpatterns = [path("s1/", views.HomeAPIView.as_view()),path("", include(router.urls)),  # 等价于  urlpatterns += router.urlspath("s3/", views.Hom3APIView.as_view()),path("s3/", views.Hom3APIView.as_view()),
]

局部设置,直接在视图中,指定当前视图类中调用的过滤器类

# 先注释掉settings中的全局过滤配置
from rest_framework.viewsets import ModelViewSet
from students.models import Student
from students.serializers import StudentModelSerializer
# Create your views here.
from django_filters.rest_framework import DjangoFilterBackend
class Hom4APIView(ModelViewSet):queryset = Student.objects.all()serializer_class = StudentModelSerializerfilter_backends = [DjangoFilterBackend, ]filter_fields = ["sex","classmate"]# list方法中进行调用->调用了GenericAPIView中声明的filter_queryset方法---> 配置中的过滤器类的filter_queryset---> filter_fields

排序Ordering

对于列表数据,REST framework提供了OrderingFilter过滤器来帮助我们快速指明数据按照指定字段进行排序。

使用方法:

在类视图中设置filter_backends,使用rest_framework.filters.OrderingFilter过滤器,REST framework会在请求的查询字符串参数中检查是否包含了ordering参数,如果包含了ordering参数,则按照ordering参数指明的排序字段对数据集进行排序。

前端可以传递的ordering参数的可选字段值需要在ordering_fields中指明。

配置文件,settings.py,代码:

"""drf配置信息必须全部写在REST_FRAMEWORK配置项中"""
REST_FRAMEWORK = {# 。。。代码省略# 过滤查询,全局配置# 过滤和排序使用了一个公用的配置项,所以2个组件要么一起全局配置,要么就一起局部配置'DEFAULT_FILTER_BACKENDS': [#     'django_filters.rest_framework.DjangoFilterBackend',  # 过滤'rest_framework.filters.OrderingFilter',  # 排序],
}

视图代码:

from rest_framework.viewsets import ModelViewSet
from students.models import Student
from students.serializers import StudentModelSerializer
# Create your views here.
from django_filters.rest_framework import DjangoFilterBackend
class Hom4APIView(ModelViewSet):queryset = Student.objects.all()serializer_class = StudentModelSerializer# 局部过滤# filter_backends = [DjangoFilterBackend, OrderingFilter]# 过滤字段# filter_fields = ["sex","classmate"]# 数据排序ordering_fields = ['id', 'age']# 127.0.0.1:8000/books/?ordering=-age
# -id 表示针对id字段进行倒序排序
# id  表示针对id字段进行升序排序

上面提到,因为过滤和排序公用了一个配置项,所以排序和过滤要一起使用,则必须整个项目,要么一起全局过滤排序,要么一起局部过滤排序。

from rest_framework.viewsets import ModelViewSet
from students.models import Student
from students.serializers import StudentModelSerializer
# Create your views here.
from django_filters.rest_framework import DjangoFilterBackend
from rest_framework.filters import OrderingFilter
class Hom4APIView(ModelViewSet):queryset = Student.objects.all()serializer_class = StudentModelSerializer# 局部过滤filter_backends = [DjangoFilterBackend, OrderingFilter]# 过滤字段filter_fields = ["sex","classmate"]# list方法中进行调用->调用了GenericAPIView中声明的filter_queryset方法---> 配置中的过滤器类的filter_queryset---> filter_fields# 数据排序ordering_fields = ['id', 'age']

分页Pagination

因为django默认提供的分页器主要使用于前后端不分离的业务场景,所以REST framework也提供了分页的支持。

我们可以在配置文件中设置全局的分页方式,如:

REST_FRAMEWORK = {# 分页,全局配置# 页码分页器,  ?page=页码&page_size=单页数据量# 'DEFAULT_PAGINATION_CLASS':  'rest_framework.pagination.PageNumberPagination',# 偏移量分页器, ?limit=单页数据量&offset=数据开始下标'DEFAULT_PAGINATION_CLASS':  'rest_framework.pagination.LimitOffsetPagination','PAGE_SIZE': 10  # 每页数目,如果不设置,则没有进行分配
}
# 如果在settings.py配置文件中, 设置了全局分页,那么在drf中凡是调用了ListModelMixin的list(),都会自动分页。如果项目中出现大量需要分页的数据,只有少数部分的不需要分页,则可以在少部分的视图类中关闭分页功能。
# 另外,视图类在使用过分页以后,务必在编写queryset属性时,模型.objects后面调用结果。例如:
# Student.objects.all()
class Hom5APIView(ListAPIView):pagination_class = None

也可通过自定义Pagination类,来为视图添加不同分页行为。在视图中通过pagination_clas属性来指明。

可选分页器

1) PageNumberPagination

前端访问网址形式:

GET  http://127.0.0.1:8000/students/?page=4

可以在子类中定义的属性:

  • page_size 每页数目
  • page_query_param 前端发送的页数关键字名,默认为"page"
  • page_size_query_param 前端发送的每页数目关键字名,默认为None
  • max_page_size 前端最多能设置的每页数量

分页器类,paginations,代码:

from  rest_framework.pagination import PageNumberPagination,LimitOffsetPagination
# PageNumberPagination,以页码作为分页条件
# page=1&page_size=10      第1页
# page=2&page_size=10      第2页
# ...
# LimitOffsetPagination,以数据库查询的limit和offset数值作为分页条件
# limit=10&offset=0   第1页
# limit=10&offset=10  第2页
# ...# 自定义分页器,PageNumberPagination
class StudentPageNumberPagination(PageNumberPagination):page_query_param = "page" # 查询字符串中代表页码的变量名page_size_query_param = "size" # 查询字符串中代表每一页数据的变量名page_size = 2 # 每一页的数据量max_page_size = 4 # 允许客户端通过查询字符串调整的最大单页数据量

视图,views ,代码:

from rest_framework.pagination import LimitOffsetPagination, PageNumberPagination# 分页类往往会单独的保存到一个独立的模块,例如:当前子应用目录下创建一个pagination.py保存,使用时导包
class Hom5PageNumberPagination(PageNumberPagination):page_size = 10                  # 默认分页的每一页数据量max_page_size = 20              # 设置允许客户端通过地址栏参数调整的最大单页数据量page_query_param = "pn"         # 地址栏上代表页码的变量名,默认是 pagepage_size_query_param = "size"  # 地址栏上代表单页数据量的变量名,默认是page_sizeclass Hom5APIView(ModelViewSet):# queryset = Student.objects  # 这句话在没有进行分页时不会报错,调用了分页则会报错!queryset = Student.objects.all()serializer_class = StudentModelSerializer# 局部分页# pagination_class = None  # 关闭分页功能# 局部分页往往采用自定义分页类,进行分页数据量的配置pagination_class = Hom5PageNumberPaginationdef list(self, request, *args, **kwargs):# 获取django的配置项from django.conf import settings# 获取rest_framework的配置项# from rest_framework.settings import api_settings# print(api_settings.DEFAULT_PAGINATION_CLASS)return super().list(request, *args, **kwargs)

2)LimitOffsetPagination

前端访问网址形式:

GET http://127.0.0.1/four/students/?limit=100&offset=100

可以在子类中定义的属性:

  • default_limit 默认限制,默认值与PAGE_SIZE设置一直
  • limit_query_param limit参数名,默认’limit’
  • offset_query_param offset参数名,默认’offset’
  • max_limit 最大limit限制,默认None

分页类,代码:

from  rest_framework.pagination import PageNumberPagination,LimitOffsetPagination
# PageNumberPagination,以页码作为分页条件
# page=1&size=10      第1页
# page=2&size=10      第2页
# LimitOffsetPagination,以数据库查询的limit和offset数值作为分页条件
# limit=10&offset=0   第1页
# limit=10&offset=10  第2页# LimitOffsetPagination
class StudentLimitOffsetPagination(LimitOffsetPagination):limit_query_param = "limit" # 查询字符串中代表每一页数据的变量名offset_query_param = "offset" # 查询字符串中代表页码的变量名default_limit = 2 # 每一页的数据量max_limit = 4 # 允许客户端通过查询字符串调整的最大单页数据量

视图,views,代码:

from .paginations import StudentPageNumberPagination,StudentLimitOffsetPagination
class Student3ModelViewSet(ModelViewSet):queryset = Student.objects.all()serializer_class = StudentModelSerializer# 取消当前视图类的分页效果# pagination_class = None# 局部分页pagination_class = StudentLimitOffsetPagination

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

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

相关文章

二、CUDA、Pytorch与依赖的工具包

CUDA Compute Unified Device Architecture(统一计算架构)。专门用于 GPU 通用计算 的平台 编程接口。CUDA可以使你的程序(比如矩阵、神经网络)由 GPU 执行,这比CPU能快几十甚至上百倍。 PyTorch 是一个深度学习框架…

SpringCloude快速入门

近期简单了解一下SpringCloude微服务,本文主要就是我学习中所记录的笔记,然后具体原理可能等以后再来深究,本文可能有些地方用词不专业还望包容一下,感兴趣可以参考官方文档来深入学习一下微服务,然后我的下一步学习就是docker和linux了。 nacos: Nacos 快速开始 | Nacos 官网…

GPT Agent与Comet AI Aent浏览器对比横评

1. 架构设计差异GPT Agent的双浏览器架构:文本浏览器:专门用于高效处理大量文本内容,适合深度信息检索和文献追踪,相当于Deep Research的延续可视化浏览器:具备界面识别与交互能力,可以点击网页按钮、识别图…

应用信息更新至1.18.0

增加DO权限 增加权限管理(需DO支持) 增加应用冻结隐藏(需DO支持) 增加权限委托(需DO支持) 增加特殊组件 ...

常用git命令集锦

git init 初始化 将当前目录初始化为 git 本地仓库,此时会在本地创建一个 .git 的文件夹 git init -q 静默执行,就是在后台执行 git init --bare –bare 参数,一般用来初始化一个空的目录,作为远程存储仓库 git init --template dir –templa…

skywalking安装

一、简介 SkyWalking是一款用于分布式系统跟踪和性能监控的开源工具。它可以帮助开发人员了解分布式系统中不同组件之间的调用关系和性能指标,从而进行故障排查和性能优化。 它支持多种语言和框架,包括Java、.NET、Node.js等。它通过在应用程序中插入代…

利用DataStream和TrafficPeak实现大数据可观察性

可观察性工作流对于深入了解应用程序的健康状况、客户流量和整体性能至关重要。然而,要实现真正的可观察性还面临一些挑战,包括海量的流量数据、数据保留、实施时间以及各项成本等。TrafficPeak是一款为Akamai云平台打造,简单易用、可快速部署…

jQuery 最新语法大全详解(2025版)

引言 jQuery 作为轻量级 JavaScript 库,核心价值在于 简化 DOM 操作、跨浏览器兼容性和高效开发。尽管现代框架崛起,jQuery 仍在遗留系统维护、快速原型开发中广泛应用。本文涵盖 jQuery 3.6 核心语法,重点解析高效用法与最佳实践。 一、jQu…

Android 15 修改截图默认音量大小

概述 在 Android 15 中,截图音效的默认音量可能过大,影响用户体验。本文将介绍如何通过修改系统源码来调整截图音效的默认音量大小。 修改位置 需要修改的文件路径: frameworks/base/packages/SystemUI/src/com/android/systemui/screenshot/ScreenshotSoundProvider.kt…

Python爬虫实战:快速采集教育政策数据(附官网工具库API)

解锁教育政策研究的数据金矿,用技术提升学术效率 在教育政策研究领域,获取最新、最全面的政策文本是学术工作的基础。传统手动收集方式效率低下且容易遗漏关键政策,而Python爬虫技术为教育研究者提供了高效的数据采集解决方案。本文将系统介…

验证回文串-leetcode

如果在将所有大写字符转换为小写字符、并移除所有非字母数字字符之后,短语正着读和反着读都一样。则可以认为该短语是一个 回文串 。 字母和数字都属于字母数字字符。 给你一个字符串 s,如果它是 回文串 ,返回 true ;否则&#xf…

嵌入式学习日志(十)

10 学习指针1 指针核心定义与本质1.1 指针与指针变量1、指针即地址,指针变量是存放地址的变量,其大小与操作系统位数相关:64 位系统中占 8 字节,32 位系统中占 4 字节。2、指针的核心功能是通过地址间接访问目标变量&#xff0…

Anaconda创建环境报错:CondaHTTPEFTOT: HTTP 403 FORBIDDEN for url

一、快速解决方案这类报错的原因通常是由于 conda 无法访问镜像源或权限被服务器拒绝,以下是常见原因和对应的解决方案:检查镜像源拼写是否正确conda config --show channels清华源镜像示例如果不正确,先清除旧配置del %USERPROFILE%\.condar…

亚马逊地址关联暴雷:新算法下的账号安全保卫战

2025年Q3,上千个店铺因共享税代地址、海外仓信息重叠等问题被批量冻结,为行业敲响了“精细化合规”的警钟。事件复盘:地址成为关联风控的“致命开关”税代机构违规引发“多米诺效应”事件的导火索指向税代机构“saqibil”,其为降低…

在本地环境中运行 ‘dom-distiller‘ GitHub 库的完整指南

在本地环境中运行 ‘dom-distiller’ GitHub 库的完整指南 前些天发现了一个巨牛的人工智能学习网站,通俗易懂,风趣幽默,忍不住分享一下给大家,觉得好请收藏。点击跳转到网站。 1. 项目概述 ‘dom-distiller’ 是一个用于将网页…

11. isaacsim4.2教程-Transform 树与Odometry

1. 前言学习目标在本示例中,你将学习如何:使用 TF 发布器将相机作为 TF 树的一部分发布在 TF 上发布机械臂/可动结构(articulation)的树状结构发布里程计(Odometry)消息开始之前前置条件已完成 …

安宝特新闻丨安宝特与Logivations正式建立合作伙伴关系,共筑物流新未来

近日,安宝特与物流创新企业Logivations签署合作协议,双方将深度融合技术专长,共同为客户提供高效、精准的智能物流解决方案,助力企业实现从人工巡检到智能管控的跨越式升级。 关于Logivations Logivations是一家深耕物流与供应链…

第三阶段—8天Python从入门到精通【itheima】-139节(pysqark实战-前言介绍)

目录 139节——pysqark实战-前言介绍 1.学习目标 2.spark是什么 3.如下是详细介绍 PySpark 的两种使用方式,并提供具体的代码示例【大数据应用开发比赛的代码熟悉如潮水一般冲刷我的记忆】: 一、本地模式(作为 Python 第三方库使用&#…

redis数据库的四种取得 shell方法

Redis作为高性能内存数据库,若配置不当(特别是未授权访问),将面临极高安全风险。攻击者可利用漏洞实现远程代码执行(GetShell),严重威胁数据安全与服务器控制权。本文深入剖析此类漏洞的核心原理…

墨者:SQL过滤字符后手工绕过漏洞测试(万能口令)

1. 墨者学院:SQL过滤字符后手工绕过漏洞测试(万能口令)🚀 2. 漏洞背景分析🔍 近期发现某登录系统存在SQL注入漏洞,攻击者可通过构造特殊用户名admin,a,a)#绕过身份验证。本文将深入解析其工作原理,并演示完整渗透测试流…