drf之排序、过滤、分页、异常处理

最新推荐文章于 2024-11-08 13:38:09 发布
最新推荐文章于 2024-11-08 13:38:09 发布
阅读量142 收藏
点赞数
分类专栏： drf 文章标签： django python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_44779250/article/details/132739382
版权

1 排序

排序只用于查询所有的接口

必须写在继承：GenericAPIView 类的视图类中才行

步骤
  1. 导入模块from rest_framework.filters import OrderingFilter
  2. 在视图类中配置熟悉filter_backends = [OrderingFilter]
  3. 写可以排序的字段ordering_fields=['id','user_type']
  4. 使用：
    1. 用户类型升序排：http://127.0.0.1:8000/user/?ordering=user_type
    2. 用户类型降序排:http://127.0.0.1:8000/user/?ordering=-user_type
    3. 先按用户类型升序排，如果用户类型一样，再按id降序排:http://127.0.0.1:8000/user/?ordering=user_type,-id

2 过滤

过滤只用于查询所有的接口

使用过滤必须继承GenericAPIView

使用方式：
1.drf内置
2.第三方模块
3.自定义

2.1.1 drf内置

drf内置的过滤方法只能用于模糊匹配

步骤：

  1. 导入模块from rest_framework.filters import SearchFilter
  2. 在需要过滤的视图类中添加
    filter_backends = [SearchFilter]
    search_fields = ['xxx','yyy'] 里面填写可能需要通过过滤的字段，一定要在表中存在的
  3. 查询方式：http://127.0.0.1:8000/books/?search=4
    模糊匹配： 只要xxx中有4或yyy中有4都能搜出来
from rest_framework.filters import SearchFilter, OrderingFilter
from django_filters.rest_framework import DjangoFilterBackend

class BookAllView(ViewSetMixin, ListCreateAPIView):
    # permission_classes = []
    filter_backends = [SearchFilter]
    filterset_fields = ['name','price']
    queryset = Book.objects.all()
    serializer_class = BookSerializer

2.1.2 第三方模块

能精准匹配，使用Django-filter模块

步骤：

  1. 安装模块
  2. 导入类from django_filters.rest_framework import DjangoFilterBackend
  3. 在需要过滤的视图类中添加
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['xxx','yyy']
  4. 使用方法 http://127.0.0.1:8000/books/?name=小王子
from django_filters.rest_framework import DjangoFilterBackend

class BookAllView(ViewSetMixin, ListCreateAPIView):
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['name','price']
    queryset = Book.objects.all()
    serializer_class = BookSerializer

2.1.3 自定义

  1. 导入类from rest_framework.filters import BaseFilterBackend
  2. 自定义一个类，继承BaseFilterBackend，并写一个方法filter_queryset
  3. 在方法中写基于queryset进行过滤
  4. 在视图类中注册filter_backends = [MyFilter]
  5. 使用方法同第三方模块使用
### 在过滤类中
from rest_framework.filters import BaseFilterBackend
from django.db.models import Q


class MyFilter(BaseFilterBackend):
    def filter_queryset(self, request, queryset, view):
        # 基于queryset进行过滤，后过滤后返回即可
        name = request.query_params.get('name')
        price = request.query_params.get('price')

        # 当两个都存在时匹配满足其一的条件即可
        if name and price:
            queryset = queryset.filter(Q(name__contains=name) | Q(price__contains=price))
        if name:
            queryset = queryset.filter(name__contains=name)
        if price:
            queryset = queryset.filter(price__contains=price)
        return queryset

## 在视图类中
from .filter import MyFilter

class BookAllView(ViewSetMixin, ListCreateAPIView):
    # permission_classes = []
    filter_backends = [MyFilter]
    # filterset_fields = ['name','price']
    queryset = Book.objects.all()
    serializer_class = BookSerializer

2.2 继承APIView写过滤和排序

class BookView(ViewSetMixin, APIView):
    def list(self, request, *args, **kwargs):
        name = request.query_params.get('name')
        price = request.query_params.get('price')
        queryset = Book.objects.all()
        if name:
            queryset = queryset.filter(name__contains=name)
        if price:
            queryset = queryset.filter(price__contains=price)
        ser = BookSerializer(instance=queryset, many=True)
        return Response(ser.data)

2.3 继承GenericAPIView写过滤类

在视图类中
from rest_framework.generics import GenericAPIView
from rest_framework.viewsets import ViewSetMixin
from .filter import MyFilter
class BookView(ViewSetMixin, GenericAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    filter_backends = [MyFilter]
    def list(self,request):
        obj_list = self.filter_queryset(self.get_queryset())
        ser = self.get_serializer(instance=obj_list,many=True)
        return Response(ser.data)
在过滤类中
from rest_framework.filters import BaseFilterBackend
from django.db.models import Q


class MyFilter(BaseFilterBackend):
    def filter_queryset(self, request, queryset, view):
        # 基于queryset进行过滤，后过滤后返回即可
        name = request.query_params.get('name')
        price = request.query_params.get('price')

        # 当两个都存在时匹配满足其一的条件即可
        if name and price:
            queryset = queryset.filter(Q(name__contains=name) | Q(price__contains=price))
        if name:
            queryset = queryset.filter(name__contains=name)
        if price:
            queryset = queryset.filter(price__contains=price)
        return queryset

3 分页

只针对于 查询所有接口

分页展现形式：
web ： 下一页，下一页
小程序，app：上拉加载更多

必须继承 GenericAPIView

3.1 分页类

分页有不同的展现形式，写类继承不同的父类有不同的效果

  1. PageNumberPagination，能够自定义当前页数
  2. LimitOffsetPagination，从某一页开始多少条数据，能够上一页下一页
  3. CursorPagination，只能上一页和下一页，常用于app
PageNumberPagination
from rest_framework.pagination import PageNumberPagination


class CommonPageNumberPagination(PageNumberPagination):
    # 展现形式
    # http://api.example.org/accounts/?page=4
    # http://api.example.org/accounts/?page=4&page_size=100

    # 重写几个类属性
    page_size = 3  # 每页显示多少条
    page_query_param = 'page'  # 指定第几页的key值 page=4
    max_page_size = 5  # 每页最多显示几条
    page_size_query_param = 'size'
    # 可以指定每页显示多少条，超过最多数量时max_page_size显示
LimitOffsetPagination
from rest_framework.pagination import LimitOffsetPagination


class CommonLimitOffsetPagination(LimitOffsetPagination):
    # http://api.example.org/accounts/?limit=4   # 从开始取4条
    # http://api.example.org/accounts/?offset=4&limit=5  从第4条开始，取5条

    default_limit = 2  # 默认每页显示几条
    limit_query_param = 'limit'  # 每页显示多少条的查询条件
    offset_query_param = 'offset'  # 从第几条开始取数据
    max_limit = 5  # limit最多取5条
CursorPagination
from rest_framework.pagination import CursorPagination

class CommonCursorPagination(CursorPagination):
    # 查询条件，用不到，需要有
    cursor_query_param = 'cursor'
    page_size = 2  # 每页显示几条
    # 按id排序 这个必须是表中字段
    ordering = 'id'

3.2 视图类：继承GenericAPIView使用

在视图类中如何使用写好的分页呢？

from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin
from .page import CommonCursorPagination

class BookView(GenericViewSet,ListModelMixin):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    pagination_class = CommonCursorPagination

3.3 视图类：继承APIView使用

from rest_framework.viewsets import ViewSetMixin
from rest_framework.views import APIView
from .page import CommonCursorPagination
class BookView(ViewSetMixin, APIView):
    def list(self,request,*args,**kwargs):
        book_list = Book.objects.all()
        pagination = CommonCursorPagination()
        page = pagination.paginate_queryset(book_list,request)
        ser = BookSerializer(instance=page,many=True)
        return Response(ser.data)

4 异常处理

drf全局异常处理，他会把drf的异常处理掉，统一返回格式，但是django原生的和python的都不会处理

我们要做的，无论什么异常，都返回固定格式

4.1 使用步骤

  1. 写一个报错执行的函数，里面传两个参数exc、context
    exc：错误对象
    context:是一个包含有关异常上下文信息的字典
    异常捕获context被传递给异常处理程序，以便在捕获和处理异常时使用这些信息。这使得可以根据异常的类型和上下文信息来实现自定义的异常处理行为。
  2. 执行一下原来处理drf异常的函数
    导入from rest_framework.views import exception_handler
    并执行，放回用变量存储起来
  3. 判断是否是drf的错误，如果是步骤2中的变量不为空
  4. 两种结果各自返回格式
  5. 在配置文件中导入这个函数，只要报错就会走这个函数
    以后只要出了异常，都会走这个函数
    REST_FRAMEWORK = {
	    	'EXCEPTION_HANDLER': 'app01.exceptions.common_exception', 
		}
函数
from rest_framework.views import exception_handler
from rest_framework.response import Response

def common_exception(exc, context):
    # 执行一下原来的exception_handler---》它能处理drf的异常，我就不用处理了
    res = exception_handler(exc, context)

    if not res:
        return Response({'code': 999, 'msg': '非drf错误，错误信息是：%s' % str(exc)})
    else:
        return Response({'code': 888, 'msg': 'drf错误，错误信息是：' + res.data.get('detail')})
我每天都好饿
关注
专栏目录
DRF 过滤排序分页异常处理
weixin_45566993的博客
04-07 1283
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/course/detail/35475 目录* DRF 过滤排序分页异常处理 + 过滤 - 内置过滤类 - 第三方过滤 - 自定义过滤类 - 源码分析 + 排序 + 分页 - PageNumberPagination，基本分页 - LimitOffsetPagination，偏移分页 - CursorPaginati
七，DRF 过滤-排序-分页-异常处理
奔波儿屁的朋友圈
05-04 370
一 过滤Filtering 对于列表数据可能需要根据字段进行过滤，我们可以通过添加django-fitlter扩展来增强支持。 pip install django-filter 在配置文件中增加过滤后端的设置： # 注册 INSTALLED_APPS = [ ... 'django_filters', # 需要注册应用， ] # 全局配，或者局部配 REST_FRAMEWORK = { ... 'DEFAULT_FILTER_BACKENDS': ('django_fi
DRF过滤排序分页及异常处理
Yietong的博客
10-10 1144
APIException 所有异常的父类ParseError 解析错误AuthenticationFailed 认证失败NotAuthenticated 尚未认证PermissionDenied 权限决绝NotFound 未找到MethodNotAllowed 请求方式不支持NotAcceptable 要获取的数据格式不支持Throttled 超过限流次数ValidationError 校验失败。
drf : 过滤 排序 分页
felix的博客
04-11 330
目录过滤和排序过滤，内置的过滤，必须继承GenericAPIView，才会有这个类属性。views.py排序过滤和排序组合第三方过滤第三方过滤查询多个自定义过滤器分页基本分页，使用频率高：PageNumberPagination偏移分页: LimitOffsetPaginationCursorPagination,一般用作体量非常大或者手机端的查询。总结：PageNumberPagination...
DRF之过滤 排序 分页
weixin_52441428的博客
05-07 1418
DRF之过滤 排序 分页
django-drf 过滤 排序 分页 全局异常 封装Response
m0_60463187的博客
01-02 395
1 读APIView源码时，即是三大认证和视图类的方法中出现了异常，都会被try捕获，做全局异常处理。{code:100,msg:成功,result:[{},{}]}2 捕获到，统一处理，处理成固定格式—》给前端是统一的。3 无论是否出异常，给前端格式都是统一的。{code:100,msg:成功}
七：drf-过滤排序异常处理分页
wmyzzz
11-14 405
目录一：过滤Filtering二：排序三：异常使用方式案例：处理关于数据库的异常四：分页 一：过滤Filtering 使用总结： 1. 安装-pip install django-filter 2. 注册-在APP中注册 3. 全局配，或者局部配 4. 视图类 对于列表数据可能需要根据字段进行过滤，我们可以通过添加django-fitlter扩展来增强支持。 pip install django-filter 在配置文件中增加过滤后端的设置： INSTALLED_APPS = [ ..
DRF 查询(排序、过滤、分页)
weixin_48183870的博客
04-23 2026
在restful规范中，有提到查询地址中可以带条件，默认排序条件是pk即：表示按照价格从低到高排序表示按照价格从高到低排序表示价格从低到高，同价格的情况下，在名字以低到高排序自定义的难度虽然大，但是这确实使用最多的需要写的类继承重写方法并返回过滤以后的queryset对象这里以价格或者书名进行过滤，可以两个同时给，可以不给，可以指定一个书名模糊匹配，价格是指定价格# 两个参数都有# 只用价格# 只用书名elif name:# 视图层示例二：只按照价格过滤，但是价格是一个区间。
DRF 自定义 过滤、排序、分页 返回数据
qq_52300718的博客
08-18 706
通过 PageNumberPagination、LimitOffsetPagination、CursorPagination、返回的JSON数据中PageNumberPagination：不会携带总页数LimitOffsetPagination：不会携带总页数CursorPagination：不会返回总记录数据 以及 总页数针对以上情况我们只能重写 list 方法，查询数据并且自己配置分页返回的数据，比如返回的状态码等，以下为 PageNumberPagination 分页类为例。
DRF过滤排序分页
al6nlee的博客
11-03 186
目录过滤DRF过滤使用种类：内置过滤类第三方自定义排序分页基本分页：PageNumberPagination偏移分页：LimitOffsetPagination游标分页：CursorPagination分页总结异常处理过滤 DRF过滤使用种类： 内置过滤类 导入：from rest_framework.filters import SearchFilter 前提条件：使用内置过滤...
DRF 过滤排序分页异常处理.doc
07-12
DRF 过滤排序分页异常处理 DRF（Django Rest Framework）是一款基于 Django 的 RESTful API 框架，提供了丰富的功能来处理过滤、排序、分页和异常处理。本文将详细介绍 DRF 中的过滤、排序、分页和异常处理。 过滤...
"DRF过滤、排序、分页及异常处理完全指南
在使用DRF时，经常会涉及到对数据进行过滤、排序和分页的操作，同时也需要处理异常情况。本文将详细介绍在DRF中如何使用过滤、排序、分页，以及对异常情况的处理。 过滤是指在查询数据的接口中，根据特定的条件对...
【Django】视图函数
最新发布
Holenxr的博客
11-08 568
因为在urls.py文件中的urlpatterns有两个url路径，所以Django不知道返回哪个url的响应，导致了报错，这时我们只要访问http://127.0.0.1:8000/Simple/即可返回simpleView视图函数的响应。接下来访问http://127.0.0.1:8000/SimpleRender/即可访问到Hello World.html文件。没错，在同步视图函数前加async即可变为异步视图函数，其他东西没区别。注意：每个视图函数需要有个参数，该参数名通常是request。
【Django】创建应用
Holenxr的博客
11-08 942
简单了解了Django框架，现在我们开始创建一个Django项目，这里我们使用的是PyCharm，打开Pycharm创建我们第一个Django项目，如下图所示：这里我们选择了Project venv，表示在项目创建虚拟环境，大家可以根据需求选择Base conda或Custom environment，点击create后，如下图所示：我们主要用到的文件有settings.py、urls.py、models.py、views.py文件。
『Django』APIView视图扩展，实现不同的请求方式
weixin_39415598的博客
11-07 453
之前讲DRF时都是用GET请求来讲解，其实DRF还提供了POSTPUTDELETE等方法。只要在视图函数前面加一个装饰器说明一下可支持的请求方法即可。
基于 Python 的 Django 框架开发的电影推荐系统
小小宾的博客
11-01 766
Python、Django、Layui、requests、MySQL/SQLite3、数据分析、协同过滤算法、ECharts。
『Django』初识DRF
weixin_39415598的博客
11-07 440
上一讲《『Django』初识前后端分离》https://mp.weixin.qq.com/s/kvhX8pePKbrS7z9fncT0mA 介绍了在Django中如何给前端写接口。如果有跟着动手做的工友一定会发现，这样写接口实在太麻烦了，还容易出错。显然大家都意识到这个问题，于是就有了。是一个用于快速构建 Web APIs 的强大工具包。它基于Django框架，为开发者提供了一套简洁且灵活的方式来构建RESTful风格的API。DRF。
如何在 Django 中生成 Excel 文件并上传至 FastDFS
XMYX-0
11-08 671
从数据库中获取提示词数据。生成包含多个工作表的 Excel 文件，每个工作表保存一个提示词的名称和详情。上传生成的 Excel 文件到 FastDFS 并获取文件 URL。将文件 URL 保存到数据库中的任务记录中。这种方法不仅能处理批量数据，还能灵活地将文件上传到分布式文件系统，实现高效的文件管理。
计算机毕业设计django+大模型租房推荐系统 租房可视化 租房大屏可视化 租房爬虫 spark 58同城租房爬虫 房源推荐系统
全网粉丝10W+、全栈领域优质创作者、掘金、阿里云等社区博客专家、专注于全栈领域和毕业项目实战
10-31 1466
计算机毕业设计django+大模型租房推荐系统 租房可视化 租房大屏可视化 租房爬虫 spark 58同城租房爬虫 房源推荐系统
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值