• drf-过滤、排序、异常处理、自封装Response


    过滤

    过滤就是根据路由url?后的信息过滤出符合?后条件的数据而非全部,比如…/?name=weer就是只查name是weer的数据,其余不返回。

    1. 1、安装:pip3 install django-filter
    2. 2、注册:在settings.py中的app中注册'django-filter'
    3. 3、使用
    4. 全局配置:还是在REST_FRAMEWORK中写:
    5. 'DEFAULT_FILTER_BACKENDS':['django_filters.rest_framework.DjangoFilterBackend']
    6. 然后在需要使用的视图类中写:
    7. filter_fields = ('name', ) # 指定可过滤字段,一般都用在查中
    8. 局部配置也是在视图类下配置filter_backends = […],同方法嘛

    排序

    就是将查出来的数据按某某排序展示,比如按价格升序、按id降序

    是依赖于django-filter实现的,所以前面安装过这不再书写了

    也是可全局使用和局部使用

    此介绍局部使用:

    1. views.py
    2. from rest_framework.filters import OrderingFilter
    3. class BookView(ListAPIView):
    4. queryset = models.Book.objects.all()
    5. serializer_class = BookSerializer
    6. filter_backends = [OrderingFilter]
    7. ordering_fields = ('id', 'price') # 指定可用排序字段
    8. # 使用时路由url中?后应带固定关键字比如ordering=id,支持降序就是加负号-比如/?ordering=-price就是按价格降序展示

    异常处理

    通过前面的经验,当我们写项目的时候出现错误,drf或Django会自动帮你处理错误并返回你它自己设置的错误信息或页面。但在实际项目开发中,我们写接口文档会根据自己公司的要求来自定义错误信息,并且一般都返回字典json格式,里面包括什么状态码、出错信息、headers啊等,而不是像Django给你出现的如下页面错误信息:

    drf中的自动帮你处理错误信息的方法在rest_framework.views.exception_handler中:

    1. def exception_handler(exc, context):
    2. # exc就是异常信息对象, context可以取出视图函数来
    3. if isinstance(exc, Http404):
    4. exc = exceptions.NotFound()
    5. elif isinstance(exc, PermissionDenied):
    6. exc = exceptions.PermissionDenied()
    7. if isinstance(exc, exceptions.APIException):
    8. headers = {}
    9. if getattr(exc, 'auth_header', None):
    10. headers['WWW-Authenticate'] = exc.auth_header
    11. if getattr(exc, 'wait', None):
    12. headers['Retry-After'] = '%d' % exc.wait
    13. if isinstance(exc.detail, (list, dict)):
    14. data = exc.detail
    15. else:
    16. data = {'detail': exc.detail}
    17. set_rollback()
    18. return Response(data, status=exc.status_code, headers=headers)
    19. return None
    20. """
    21. 研究源码可以看到,drf自动帮你处理了404、是否允许访问,还有APIException错误信息,
    22. 另一个返回结果None就很灵性,意味着该异常处理不全,返回None的交给了Django处理,
    23. 因此展示那种错误页面
    24. """

    因此我们需要写自己的异常处理方法,一是为了统一错误信息返回格式,二是为了记录错误日志

    当然,像APIException错误这种,drf已然帮我们写好了,为此我们可以直接用

    我是新建的my_exception_handler.py:

    1. from rest_framework.views import exception_handler
    2. from rest_framework.views import Response
    3. from rest_framework import status
    4. def my_exception_handler(exc, content):
    5. response = exception_handler(exc, content) # 沿用exception_handler处理方法 返回None时就是写我们自己的,没有返回None时就是对APIException处理了的
    6. if not response:
    7. # 写自己的异常处理逻辑 按需求来
    8. # 以下为示例
    9. return Response(data={'code':104,'msg':str(exc)}, status=status.HTTP_400_BAD_REQUEST)
    10. else:
    11. # 这返回的是drf内置的处理错误信息,如APIException的
    12. return Response(data={'code':101,'msg':response.data.get('detail')}, status=status.HTTP_403_FORBIDDEN)

    然后去REST_FRAMEWORK中全局配置,没有局部配

    'EXCEPTION_HANDLER':'app01.my_exception_handler.my_exception_handler'

    对应着来之后只要出现异常都返回类似这种格式的了:

    自封装Response对象

    虽然drf提供的Response对象已经包含了很多功能,比如data, status,template_name, headers,exception,content_type这种,但其可扩展性还是不高,需要结合项目需求来,比如要加一个token字段跟在其后便没有办法,因此也是在实际开发中,我们都需要自己封装一个Response对象,不过继承了原生Response对象而已,以实现更多需求

    下为一个简单示例↓

    1. class APIResponse(Response):
    2. def __init__(self,code=200,msg='成功',data=None, status=None,headers=None,**kwargs):
    3. dic = {'code':code, 'msg':msg}
    4. dic.update(kwargs)
    5. super().__init__(data=dic,status=status,headers=headers)

    以后我们一般都使用自己的Response对象,因为要啥功能自己配就行了。

  • 相关阅读:
    简述linux系统中软件包管理系统
    浅谈App的启动优化
    git diff相关命令
    如何设计静态资源缓存方案
    毕业前写了20万行代码,让我从成为同学眼里的面霸
    GPT引领前沿与应用突破之GPT4科研实践技术与AI绘图
    分别从中序、后续中组成二叉树(likou106)
    GB/T28181-2016基于RTP的视音频数据封装和技术实现
    【Python】通过Fourier变换实现频域滤波
    数据结构与算法-第六章 图的应用 拓扑排序
  • 原文地址:https://blog.csdn.net/ITlearner007/article/details/134005638