DRF 查询(排序、过滤、分页)

devtools/2024/9/23 14:29:25/

查询(排序、过滤、分页)

【0】准备

(1)Q查询

  • 详细内容可见:Django模型层-CSDN博客
  • Django 的 Q 对象提供了一种在数据库查询中构造复杂查询的方法。当你想在单个查询中组合多个过滤条件,并且这些条件之间不仅仅是简单的 AND 关系时,Q 对象就显得非常有用。
  • 导入:from django.db.models import Q
  • 简单示例:或与非
python"># 查找 name 字段为 'John' 或 age 字段大于 30 的对象  
MyModel.objects.filter(Q(name='lily') | Q(age__gt=30))
python"># 查找 name 字段为 'John' 并且 age 字段大于 30 的对象  
MyModel.objects.filter(Q(name='lily') & Q(age__gt=30))
python"># 查找 name 字段不是 'John' 的对象  
MyModel.objects.filter(~Q(name='lily'))

(2)数据准备

  • 模型表
python">from django.db import modelsclass Book(models.Model):name = models.CharField(max_length=64, verbose_name="书名")price = models.DecimalField(max_digits=6, decimal_places=2, verbose_name="价格")publish_name = models.CharField(max_length=64, verbose_name="出版社名字")# 数据信息    
INSERT INTO `test04_book` (`id`, `name`, `price`, `publish_name`) VALUES (1, '三国演绎', 99.00, '东方出版社');
INSERT INTO `test04_book` (`id`, `name`, `price`, `publish_name`) VALUES (2, '新三国', 105.00, '东方出版社');
INSERT INTO `test04_book` (`id`, `name`, `price`, `publish_name`) VALUES (3, '小王子', 89.00, '西方出版社');
INSERT INTO `test04_book` (`id`, `name`, `price`, `publish_name`) VALUES (4, '新能源', 99.00, '南方出版社');
INSERT INTO `test04_book` (`id`, `name`, `price`, `publish_name`) VALUES (5, '永动机', 105.00, '东方出版社');
INSERT INTO `test04_book` (`id`, `name`, `price`, `publish_name`) VALUES (6, '黑火药', 99.00, '北方出版社');
INSERT INTO `test04_book` (`id`, `name`, `price`, `publish_name`) VALUES (7, '支付宝', 109.00, '东方出版社');
INSERT INTO `test04_book` (`id`, `name`, `price`, `publish_name`) VALUES (8, '云电脑', 101.00, '西方出版社');
  • 序列化类
python">from rest_framework.serializers import ModelSerializer
from .models import Bookclass BookModelSerializer(ModelSerializer):class Meta:model = Bookfields = '__all__'
  • 视图函数和路由
python"># 视图层
from rest_framework.viewsets import ReadOnlyModelViewSet
from .serializer import BookModelSerializer
from .models import Bookclass BookAPIView(ReadOnlyModelViewSet):queryset = Book.objects.all()serializer_class = BookModelSerializer# 路由层
from django.urls import path, include
from .views import BookAPIView
from rest_framework.routers import SimpleRouterrouter = SimpleRouter()
router.register(prefix='books', viewset=BookAPIView, basename='books')
urlpatterns = [path('', include(router.urls))
]

【1】排序

(1)介绍

  • restful规范中,有提到查询地址中可以带条件,默认排序条件是pk
  • 即:
    • http://127.0.0.1:8000/test04/books/?ordering=price表示按照价格从低到高排序
    • http://127.0.0.1:8000/test04/books/?ordering=-price表示按照价格从高到低排序
    • http://127.0.0.1:8000/test04/books/?ordering=price,name表示价格从低到高,同价格的情况下,在名字以低到高排序

(2)简单使用

  • 必须要是继承 GenericAPIView 的视图类
  • filter_backends=[排序类, ]:排序类的地址
  • ordering_fields = ['子段1', '子段2'...]:这里的字段没有先后顺序,只是指定排序的字段可以有哪些
python">from rest_framework.filters import OrderingFilter, SearchFilterclass BookAPIView(ReadOnlyModelViewSet):queryset = Book.objects.all()serializer_class = BookModelSerializerfilter_backends = [OrderingFilter]ordering_fields = ['price', 'name']

image-20240417211107216

  • 注意:如果有自定义的内容,需要重写父类的方法比如List,一定要使用self.filter_queryset(self.get_queryset()),而不是使用self.get_queryset(),因为后者将没有排序的功能

【2】过滤

  • 如果提示UnorderedObjectListWarning: Pagination may yield inconsistent results with an unordered object_list:
    • 可以在queryset后面加上.order_by('id')默认以id排序

(1)内置:多字段(与的条件)模糊匹配

  • 必须要是继承 GenericAPIView 的视图类

  • 和排序一样需要,需要添加两个类属性,不过有个是一样的,即过滤和排序是可以同时使用的

  • filter_backends=[过滤类, ]:过滤类的地址,这里的先后顺序不影响结果,只不过一个是先过滤再排序,一个是先排序再过滤

  • search_fields= ['子段1', '子段2'...]:这里的字段也没有先后顺序,只是指定排序的字段可以有哪些

  • 路由示例:http://127.0.0.1:8000/test04/books/?search=东

    • 根据search_fields的字段,模糊匹配含有东的
python">from rest_framework.filters import OrderingFilter, SearchFilterclass BookAPIView(ReadOnlyModelViewSet):queryset = Book.objects.all()serializer_class = BookModelSerializerfilter_backends = [OrderingFilter, SearchFilter]ordering_fields = ['price', 'name']search_fields = ['name', 'publish_name']

image-20240417213456133

(2)第三方过滤

  • 导包:

    • pip install django-filter
    • from django_filters.rest_framework import DjangoFilterBackend
  • 类属性:

    • filter_backends=[过滤类, ]:过滤类的地址,这里的先后顺序不影响结果,只不过一个是先过滤再排序,一个是先排序再过滤
    • filterset_fields= ['子段1', '子段2'...]:这里的字段也没有先后顺序,只是指定排序的字段可以有哪些
python">from django_filters.rest_framework import DjangoFilterBackendclass BookAPIView(ReadOnlyModelViewSet):queryset = Book.objects.all()serializer_class = BookModelSerializerfilter_backends = [DjangoFilterBackend]filterset_fields = ['price', 'publish_name']

image-20240417214858539

(3)自定义过滤类

  • 自定义的难度虽然大,但是这确实使用最多的

    • 需要写的类继承BaseFilterBackend
    • 重写filter_queryset方法
    • 并返回过滤以后的queryset对象
  • 示例要求:

    • 这里以价格或者书名进行过滤,可以两个同时给,可以不给,可以指定一个
    • 书名模糊匹配,价格是指定价格
python">from rest_framework.filters import BaseFilterBackend
from django.db.models import Qclass CommonFilter(BaseFilterBackend):def filter_queryset(self, request, queryset, view):name = request.query_params.get('name')price = request.query_params.get('price')# 两个参数都有if all([name, price]):queryset = queryset.filter(Q(name__contains=name) | Q(price=price))return queryset# 只用价格elif price:queryset = queryset.filter(price=price)return queryset# 只用书名elif name:queryset = queryset.filter(name__contains=name)return queryset# 视图层
from .filter import CommonFilter
class BookAPIView(ReadOnlyModelViewSet):queryset = Book.objects.all()serializer_class = BookModelSerializerfilter_backends = [CommonFilter]

image-20240417221224582

  • 示例二:只按照价格过滤,但是价格是一个区间
python">class CommonFilter(BaseFilterBackend):def filter_queryset(self, request, queryset, view):price_g = request.query_params.get('price1')price_l = request.query_params.get('price2')# 两个参数都有才过滤if all([price_g, price_l]):queryset = queryset.filter(Q(price__gte=price_g) & Q(price__lte=price_l))return queryset# 参数不全直接返回return queryset

image-20240417222116588

【3】分页

  • pagination_class不是一个列表,所以只能

(1)基本分页

  • 继承PageNumberPagination指定类变量
    • page_size = 2 默认每页数量,可以指定size超过数量
    • page_query_param = 'page' 路由页码关键字
    • page_size_query_param = 'size' 路由每页数量关键字
    • max_page_size = 10 每页最多显示数量
python">from rest_framework.pagination import PageNumberPaginationclass CommonPagination(PageNumberPagination):page_size = 2  # 默认每页数量page_query_param = 'page'  # 路由页码关键字page_size_query_param = 'size'  # 路由每页数量关键字max_page_size = 10  # 每页显示的最大条数# 视图函数
from .pagination import CommonPaginationclass BookAPIView(ReadOnlyModelViewSet):queryset = Book.objects.all()serializer_class = BookModelSerializerpagination_class = CommonPagination

image-20240417224703000

(2)偏移分页

  • 继承LimitOffsetPagination指定类变量
    • default_limit= 2 默认每页数量,可以指定limit超过数量
    • limit_query_param = 'limit' 路由每页数量关键字
    • offset_query_param= 'offset' 路由偏移量关键字
    • max_limit = 10 每页最多显示数量
python">from rest_framework.pagination import LimitOffsetPaginationclass CommonPagination(LimitOffsetPagination):default_limit = 2  # 默认每页数量limit_query_param = 'limit'  # 路由每页数量关键字offset_query_param = 'offset'  # 路由偏移量关键字max_limit = 10  # 每页最多显示数量

image-20240417230611468

(3)游标分页

  • 优势
    • 性能优化:游标分页不需要跳过任何行,它只需要从上一页的最后一个项目开始。这意味着数据库只需要处理实际需要的数据,而不是像偏移分页那样需要处理OFFSET指定的所有数据。这种特性使得游标分页在处理大量数据时具有更高的效率。
    • 数据一致性:即使有新的数据插入,也不会影响已经浏览过的页面。这是因为每一页的数据都是基于上一页的最后一个项目,而不是基于页数。这种特性确保了用户浏览的数据始终是最新的,避免了数据不一致的问题。
    • 用户体验:游标分页允许用户连续浏览数据,提供了更好的用户体验。这是因为游标分页是根据当前查询结果的位置来动态生成分页结果,使得用户可以无缝地浏览数据库中大量的数据。
  • 继承PageNumberPagination指定类变量
    • page_size= 2 默认每页数量,可以指定size超过数量
    • cursor_query_param = 'cursor' 路由关键字
    • ordering= 10 排序字段,必须有
      • ordering= ‘-created’:created有这个字段的,按照倒叙来
python">from rest_framework.pagination import CursorPagination
class CommonPagination(CursorPagination):cursor_query_param = 'cursor'  # 路由关键字page_size = 2  # 默认每页的数量ordering = 'id'  # 排序规则

image-20240417231334246


http://www.ppmy.cn/devtools/12174.html

相关文章

为什么我的 Mac 运行缓慢以及如何使用CleanMyMac X修复它

近些年伴随着苹果生态的蓬勃发展,越来越多的用户开始尝试接触Mac电脑。然而很多人上手Mac后会发现,它的使用逻辑与Windows存在很多不同,而且随着使用时间的增加,一些奇奇怪怪的文件也会占据有限的磁盘空间,进而影响使用…

web测试基础知识

目录 web系统的基础 web概念(worldwideweb) 网络结构 发展 架构 B/S C/S P2P 工作原理 静态页面 动态页面 web客户端技术 浏览器的核心--渲染引擎 web服务器端技术 web服务器 应用服务器 集群环境 数据库 案例-URL 协议类型 主机名 端口 IP地址 分类 …

Java常见面试题总结

文章目录 1. 什么是线程和进程?2. 请简要描述线程与进程的关系,区别及优缺点?3. 什么是堆和方法区?4. 并发与并行的区别5. 同步和异步的区别6.为什么要使用多线程? 优点?(重要)7. 使用多线程可能带来什么问题?8. 如…

【C++初阶】List使用特性及其模拟实现

1. list的介绍及使用 1.1 list的介绍 1. list是可以在常数范围内在任意位置进行插入和删除的序列式容器,并且该容器可以前后双向迭代。 2. list的底层是双向链表结构,双向链表中每个元素存储在互不相关的独立节点中,在节点中通过指针指向其前…

MATLAB 数据类型

MATLAB 数据类型 MATLAB 不需要任何类型声明或维度语句。每当 MATLAB 遇到一个新的变量名,它就创建变量并分配适当的内存空间。 如果变量已经存在,那么MATLAB将用新内容替换原始内容,并在必要时分配新的存储空间。 例如, Tota…

世媒讯提供海内外媒体宣发服务,引领企业新媒体发展之路

在这个信息化的时代,软文发稿已经成为企业发展不可或缺的重要工具。随着社会的快速发展,消费者需要更多定制化、个性化的信息。利用软性推广,凭借其细致入微的信息传递,可以迅速抓住消费者的注意力,从而进一步推动企业…

【Node.js】03 —— HTTP 模块探索

🌟Node.js之HTTP模块探索✨ 🌟引言 在网络编程中,HTTP协议无处不在。在Node.js的世界里,我们可以通过内置的http模块来轻松创建HTTP服务器和客户端,实现数据的接收和发送。今天就让我们一起打开这扇门,探索…

烟雾识别图像处理:原理、应用与未来发展---豌豆云

本文详细介绍了烟雾识别图像处理的基本原理、应用领域以及未来的发展趋势。 通过深入剖析烟雾识别图像处理的关键技术和方法,帮助读者了解该领域的最新进展,为实际应用提供有价值的参考。 随着计算机视觉和人工智能技术的快速发展,烟雾识别…