DRF渲染之异常处理

异常处理

【1 】引言

Django REST Framework 这个就是我们常常说的DRF

  1. APIView的dispatch方法
    • 当请求到达视图时,DRF 的 APIView 类会调用 dispatch 方法来处理请求。
    • dispatch 方法中,有一个关键的步骤是处理异常。如果在视图类的方法执行过程中出现了异常,DRF 会捕获这个异常,并调用 self.handle_exception(exc) 方法来处理它。
  2. handle_exception 方法
    • handle_exception 方法用于处理异常,它首先获取异常处理函数的引用,这个函数的地址存储在配置中,通常是 settings.EXCEPTION_HANDLER
    • 然后,handle_exception 调用这个异常处理函数,并传入两个参数:异常对象 exc 和上下文 context
    • 异常处理函数执行后会返回一个响应对象,这个响应对象会在异常发生时返回给客户端。
  3. rest_framework.views.exception_handler 函数
    • 这个函数是 DRF 提供的默认异常处理函数。它会检查传入的异常是否是 DRF 内置的 exceptions.APIException 类型的异常。
    • 如果是 APIException 类型的异常,这个函数会根据异常类型组装一个响应对象,并返回。
    • 如果异常不是 APIException 类型的,则返回 None,意味着这个异常不是 DRF 能处理的,需要由其他方式处理(比如由 Django 的默认异常处理机制处理)。

​ 总的来说,DRF 的异常处理机制允许你在视图类中捕获并处理异常,并提供了一个灵活的机制来定义和定制异常处理方式。

读APIView源码时,即是三大认证和视图类的方法中出现了异常,都会被try捕获,做全局异常处理:
	 response = self.handle_exception(exc)
    -只要出了异常,都会执行response = self.handle_exception(exc)
    
    

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

     def handle_exception(self, exc):
        # 拿到一个函数内存地址--》配置文件中配置了
        # self.settings.EXCEPTION_HANDLER
        # 拿到这个函数:rest_framework.views.exception_handler
        exception_handler = self.get_exception_handler()
        # 执行这个函数,传入俩参数
        response = exception_handler(exc, context)
        # drf的 Response的对象
        return response
   	-rest_framework.views.exception_handler 逻辑分析
    	-判断异常是不是 drf内 exceptions.APIException的异常
        -如果是--》组装了Response返回了
        -如果不是--》返回了None
        -总结:默认drf只处理了自己的异常,django的异常,它没处理,直接前端能看到
  • 而-handle_exception 源码分析里面的重点则是

  1. 异常类型检查:
    • if isinstance(exc, (exceptions.NotAuthenticated, exceptions.AuthenticationFailed)): 这里检查异常是否是用户未认证或认证失败引起的。
  2. 认证头部信息获取:
    • auth_header = self.get_authenticate_header(self.request): 尝试获取适当的认证头部信息,用于构建响应。
    • if auth_header:: 如果成功获取了认证头部信息,则将其添加到异常对象中,否则将响应状态码设置为 403 Forbidden。
  3. 异常处理程序调用:
    • exception_handler = self.get_exception_handler(): 获取异常处理程序。
    • context = self.get_exception_handler_context(): 获取异常处理上下文。
    • response = exception_handler(exc, context): 将异常对象和上下文传递给异常处理程序,获取处理后的响应。
  4. 响应处理:
    • if response is None:: 如果异常处理程序返回了 None,表示没有提供一个适当的响应,这时会重新引发异常。
    • response.exception = True: 将响应对象的 exception 属性设置为 True,表示这个响应是由异常引起的。
    • return response: 返回处理后的响应。

​ 这些部分共同构成了异常处理器的核心功能,负责捕获、处理异常,并生成适当的响应。

总结:默认drf只处理了自己的异常,django的异常,它没处理,直接前端能看到

【 2 】简单示例

  • urls.py

from three.views import  TeyView
# 自动生成路由
from rest_framework.routers import SimpleRouter, DefaultRouter
from django.urls import path, include

# 2 实例化得到对象
# router = SimpleRouter()
router = DefaultRouter()
# 3 执行对象的方法
router.register('User', UserTokenView, 'User')
urlpatterns = [
    path('try/', TeyView.as_view()),

]
# 5 把自动生成的路由,放到 urlpatterns中
urlpatterns += router.urls
from rest_framework.views import APIView
from rest_framework.exceptions import ValidationError,AuthenticationFailed

class TeyView(APIView):
    def get(self,request):

        # drf的异常
        # 主动抛出异常!!!
        raise ValidationError('校验失败')
        # raise AuthenticationFailed('失败了这么棒!!')

        # # diango的异常
        # res = 9/0
        # return Response('zheng1casd')

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

【 2 】使用步骤

全局处理,如何使用

  • 写个函数
  • 在函数中处理异常,统一返回格式
  • 在配置文件中配置:只要出了异常,执行我们自己的
  • 写完配置文件
    REST_FRAMEWORK = {
        'EXCEPTION_HANDLER': 'three.exceptions.common_exception_handler',
    }

异常处理函数

​ 创建exceptions.py文件

from rest_framework.views import exception_handler
from rest_framework.response import Response


def common_exception_handler(exc, context):
    # 【1】 返回 Response: 说明是drf的一次
    # 【2】 返回None: 就不是drf的异常
    # response.datak可以拿到主体的数据
    response = exception_handler(exc, context)
    if response:
        if isinstance(response.data, dict):
            errors = response.data.get('detail', '系统正在维修,请联系站长')
        elif isinstance(response.data, list):
            errors = response.data[0]
        else:
            errors = r'请重新启动或者打自己一巴掌!!!'
        response = Response({r'code': 444, "msg": f"【drf】:{errors}"})
    else:
        # 获取报错异常的类型
        print(type(exc))
        # <class 'IndexError'>
        if response is not None:
            response.data['0'] = '你是'
        elif isinstance(exc,IndexError):
            response = Response({r'code': 499, "msg": f"IndexError数据不对"})
        else:
            errors = str(exc)
            response = Response({r'code': 404, "msg": f"【django】:{errors}"})
    return response

注意使用这个的前提就是有异常我们可以定义

from rest_framework.views import APIView
from rest_framework.exceptions import ValidationError,AuthenticationFailed,APIException

class TeyView(APIView):
    def get(self,request):

        # drf的异常
        # 主动抛出异常!!!
        # raise APIException('校验失败')
        # raise AuthenticationFailed('失败了这么棒!!')


        # # diango的异常
        # res = 9/0
        a = [1,2,3,4,5,6]
        print(a[9])
        return Response('zheng1casd')
    
    ---------------------------------------
# urls.py
from three.views import  TeyView
# 自动生成路由
from rest_framework.routers import SimpleRouter, DefaultRouter
from django.urls import path, include

# 2 实例化得到对象
# router = SimpleRouter()
router = DefaultRouter()
# 3 执行对象的方法
router.register('User', UserTokenView, 'User')
urlpatterns = [
    path('try/', TeyView.as_view()),

]
# 5 把自动生成的路由,放到 urlpatterns中
urlpatterns += router.urls

【3】自定义异常捕获

class PassException(Exception):
    def __init__(self,msg):
        self.msg=msg

因为这里并不是一个合格的PassException异常但这个是一个ZeroDivisionError所以有了点手段

from .exceptions import PassException
class TeyView(APIView):
    def get(self,request):

        # drf的异常
        # 主动抛出异常!!!
        # raise APIException('校验失败')
        # raise AuthenticationFailed('失败了这么棒!!')

        try:
            # 这里是你可能会出现除零错误的代码
            res = 1 / 0
        except ZeroDivisionError:
            # 捕获除零错误,并抛出 PassException 异常
            raise PassException('4564')
def common_exception_handler(exc, context):
	...
        else:
            ...
    else:
        if isinstance(exc, PassException):  # 检查是否是 PassException
            response = Response({'code': 499, "msg": f"PassException: {exc.msg}"})
	...
    return response

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

【 4 】加强

 # 日志记录放这里即可:请求方式,请求的地址,客户端ip,用户id,时间
from rest_framework.views import exception_handler
from rest_framework.response import Response


class PassException(Exception):
    def __init__(self,msg):
        self.msg=msg

def common_exception_handler(exc, context):
    # 【1】 返回 Response: 说明是drf的一次
    # 【2】 返回None: 就不是drf的异常
    # response.datak可以拿到主体的数据

    request = context.get('request')
    view = context.get('view')  # 哪个视图类出的错
    user_id = request.user.pk or '匿名用户'
    print(
        f'请求方式是:{request.method},请求地址是:{request.get_full_path()},客户端ip:{request.META.get("REMOTE_ADDR")},用户id:{user_id}')
    print(type(exc))
    response = exception_handler(exc, context)
    if response:
        if isinstance(response.data, dict):
            errors = response.data.get('detail', '系统正在维修,请联系站长')
        elif isinstance(response.data, list):
            errors = response.data[0]
        else:
            errors = r'请重新启动或者打自己一巴掌!!!'
        response = Response({r'code': 444, "msg": f"【drf】:{errors}"})
    else:
        # 获取报错异常的类型
        print(type(exc))
        # <class 'IndexError'>
        if response is not None:
            response.data['0'] = '你是'
        elif isinstance(exc,IndexError):
            response = Response({r'code': 499, "msg": f"IndexError数据不对"})
        elif isinstance(exc,PassException):
            response = Response({r'code': 999, "msg": f"这个是PassException报错"})
        else:
            errors = str(exc)
            response = Response({r'code': 404, "msg": f"【django】:{errors}"})
    return response
  • 最终版本
from rest_framework.views import exception_handler
from rest_framework.response import Response
import logging

class PassException(Exception):
    def __init__(self,msg):
        self.msg=msg

# 创建日志记录器
logger = logging.getLogger(__name__)

def common_exception_handler(exc, context):
    # 【1】 返回 Response: 说明是drf的一次
    # 【2】 返回None: 就不是drf的异常
    # response.data可以拿到主体的数据

    request = context.get('request')
    view = context.get('view')  # 哪个视图类出的错
    user_id = request.user.pk or '匿名用户'
    # 记录请求信息到日志
    # logger.info(
    #     f'请求方式是:{request.method}, 请求地址是:{request.get_full_path()}, 客户端IP:{request.META.get("REMOTE_ADDR")}, 用户ID:{user_id}')
    print(
        f'请求方式是:{request.method},请求地址是:{request.get_full_path()},客户端ip:{request.META.get("REMOTE_ADDR")},用户id:{user_id},视图类:{view.__class__.__name__}')
    print(type(exc))
    response = exception_handler(exc, context)
    if response:
        if isinstance(response.data, dict):
            errors = response.data.get('detail', '系统正在维修,请联系站长')
        elif isinstance(response.data, list):
            errors = response.data[0]
        else:
            errors = r'请重新启动或者打自己一巴掌!!!'
        response = Response({r'code': 444, "msg": f"【drf】:{errors}"})
    else:
        # 获取报错异常的类型
        print(type(exc))
        # <class 'IndexError'>
        if response is not None:
            response.data['0'] = '你是'
        elif isinstance(exc,IndexError):
            response = Response({r'code': 499, "msg": f"IndexError数据不对"})
        elif isinstance(exc,PassException):
            response = Response({r'code': 999, "msg": f"这个是PassException报错"})
        else:
            errors = str(exc)
            response = Response({r'code': 404, "msg": f"【django】:{errors}"})
    return response

【 5 】模板

  • 简易版本

# 后期视图的方法,可以写成这种模板
try:
    # 核心逻辑
    if 某个条件不符合:  # 或断言
        raise NoPermissionException
    except NoPermissionException as e:
        # return Response({'code':888,'msg':'错误'})
        raise NoPermissionException('没有权限')
    except AAException as e:
        raise NoPermissionException('没有权限')
        return Response('ok')
  • 加强版本

from rest_framework.response import Response  
from rest_framework.exceptions import PermissionDenied  # 或者您自定义的 NoPermissionException  
from .exceptions import AAException  # 假设 AAException 是您自定义的异常  
  
def my_view(request):  
    try:  
        # 核心逻辑  
        if 某个条件不符合:  # 或断言  
            raise PermissionDenied('没有权限')  # 使用DRF的PermissionDenied异常  
        # 其他逻辑...  
    except PermissionDenied as e:  
        return Response({'code': 888, 'msg': str(e)}, status=403)  # 403 Forbidden  
    except AAException as e:  
        return Response({'code': 999, 'msg': 'AAException 触发的错误'}, status=400)  # 400 Bad Request 或者其他合适的状态码  
    # 其他异常处理...  
    # 视图正常执行完毕后的返回  
    return Response('ok')

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

mikefile函数与实用模板

文章目录 0.概述1.函数调用语法2.字符串处理函数2.1 subst&#xff08;字符串替换函数&#xff09;2.2 patsubst&#xff08;模式字符串替换函数&#xff09;2.3 strip&#xff08;去空格函数&#xff09;2.4 findstring&#xff08;查找字符串函数&#xff09;2.5 filter&…

Aigtek:电压放大器的选型标准是什么

选型电压放大器时&#xff0c;需要考虑多个因素&#xff0c;以确保选择适合特定应用需求的设备。电压放大器该怎么选择&#xff0c;下面安泰电子来介绍电压放大器常见的选型标准。 增益要求&#xff1a;首先需要确定所需的增益水平。根据输入信号的幅度和输出信号的要求&#x…

只需3步,使用Stable Diffusion无限生成AI数字人视频(附安装包)

基本方法 搞一张照片&#xff0c;搞一段语音&#xff0c;合成照片和语音&#xff0c;同时让照片中的人物动起来&#xff0c;特别是头、眼睛和嘴。 语音合成 语音合成的方法很多&#xff0c;也比较成熟了&#xff0c;大家可以选择自己方便的&#xff0c;直接录音也可以&#…

【ZZULI数据结构实验】压缩与解码的钥匙:赫夫曼编码应用

&#x1f4c3;博客主页&#xff1a; 小镇敲码人 &#x1f49a;代码仓库&#xff0c;欢迎访问 &#x1f680; 欢迎关注&#xff1a;&#x1f44d;点赞 &#x1f442;&#x1f3fd;留言 &#x1f60d;收藏 &#x1f30f; 任尔江湖满血骨&#xff0c;我自踏雪寻梅香。 万千浮云遮碧…

大文件传输的好帮手Libarchive:功能强大的开源归档文件处理库

在数字化时代&#xff0c;文件的存储和传输对于企业的日常运作至关重要。但是&#xff0c;服务器中的压缩文件往往无法直接查看或预览&#xff0c;这给用户带来了不便。为了解决这一问题&#xff0c;在线解压功能的开发变得尤为重要。接下来&#xff0c;小编将介绍一个能够实现…

了解集合与数据结构(java)

什么是数据结构? 数据结构就是 数据结构, 功能就是描述和组织数据 比如我有10万个QQ号, 我来组织, 有很多种组织方法, 比如链表, 树, 堆, 栈等等. 假如QQ号要查找数据, 有种数据结构查找数据速度很快, 我们就用它 加入QQ号要进行删除数据, 有种数据结构删除速度很快, 我们…

Spring Cloud Alibaba 网关 Gateway 集成(7)

项目的源码地址 Spring Cloud Alibaba 工程搭建&#xff08;1&#xff09; Spring Cloud Alibaba 工程搭建连接数据库&#xff08;2&#xff09; Spring Cloud Alibaba 集成 nacos 以及整合 Ribbon 与 Feign 实现负载调用&#xff08;3&#xff09; Spring Cloud Alibaba Ribbo…

【Web】CTFSHOW 月饼杯 题解(全)

目录 web1_此夜圆 web2_故人心 web3_莫负婵娟 web1_此夜圆 拿到源码&#xff0c;一眼字符串逃逸 本地测一测&#xff0c;成功弹出计算器 <?phpclass a {public $uname;public $password;public function __wakeup(){system(calc);} }function filter($string){retur…

【北京迅为】《iTOP-3588从零搭建ubuntu环境手册》-第5章 安装SSH

RK3588是一款低功耗、高性能的处理器&#xff0c;适用于基于arm的PC和Edge计算设备、个人移动互联网设备等数字多媒体应用&#xff0c;RK3588支持8K视频编解码&#xff0c;内置GPU可以完全兼容OpenGLES 1.1、2.0和3.2。RK3588引入了新一代完全基于硬件的最大4800万像素ISP&…

【深度学习Labelme】使用Segment Anything Model (SAM)快速打标,labelme多边形转yolo txt框看看对不对

文章目录 windows安装环境打开labelme自动保存勾选上&#xff0c;保存图片数据不要勾选选SAM精准模型&#xff0c;然后打开图片路径&#xff0c;然后点击创建AI多边形&#xff1a;鼠标点击确认物体控制点&#xff0c;确认完成后&#xff0c;双击鼠标完成选取&#xff0c;并给上…

Django 静态文件管理与部署指南

title: Django 静态文件管理与部署指南 date: 2024/5/10 17:38:36 updated: 2024/5/10 17:38:36 categories: 后端开发 tags: WebOptCDN加速DjangoCompressWebpackStaticDeployCICD-ToolsSecStatic 第一章&#xff1a;介绍 Django 静态文件的概念和重要性 在 Web 开发中&a…

解读计数器算法:原理、Java实现与优劣分析

计数器算法的介绍 计数器算法的基本原理是通过一个计数器来记录事件的发生次数。每当一个特定的事件发生时&#xff0c;计数器的值就会增加一。当需要检查这个事件发生的次数时&#xff0c;只需要查看计数器的当前值即可。这种方法简单直观&#xff0c;易于理解和实现。 想象…

Docker + Django跨域解决方案

什么是Django Django 是一个开源的高级 Python Web 框架&#xff0c;它鼓励快速开发并遵循可重用和可维护的实践。Django 是在 MTV&#xff08;模型-模板-视图&#xff09;模式的基础上设计的&#xff0c;这个模式类似于但不同于 MVC&#xff08;模型-视图-控制器&#xff09;模…

雷森托尔环保科技有限公司见证2024杭州数字供应链装备展潮流

参展企业介绍 青岛雷森托尔环保科技有限公司创建于2018年&#xff0c;位于山东青岛&#xff0c;现注册资本3000万。公司主营生产模压木托盘、化工木托盘、大型设备木包装、出口木托盘、酒柜木酒架等&#xff0c;公司拥有技术人员6人&#xff0c;均为包装设计专业毕业&#xff0…

智慧公厕管理系统的四层架构:感知层、传输层、平台层和应用层

智慧公厕管理系统是一种利用先进技术实现智能化管理和优化厕所体验的创新解决方案。该系统采用复杂的架构&#xff0c;涵盖了多个应用子系统&#xff0c;致力于提高公厕的卫生状况、资源利用效率、安全性以及用户体验。本文将以智慧公厕源头实力厂家广州中期科技有限公司&#…

element el-date-picker组件 输入输出格式为时间戳

<!-- 时间戳 --><el-date-pickerv-model"time"value-format"timestamp"type"date"placeholder"选择日期"/>// 把 value-format"timestamp" 加入 就可以实现时间戳格式

【数学】泰勒公式

目录 引言 一、泰勒公式 1.泰勒公式及推导 &#xff08;1&#xff09;推导 &#xff08;2&#xff09;公式 2.泰勒中值定理 &#xff08;1&#xff09;定理1&#xff08;佩亚诺余项&#xff09; &#xff08;2&#xff09;定理2&#xff08;拉格朗日余项&#xff09; …

前端动画requestAnimationFrame

window.requestAnimationFrame() 告诉浏览器——你希望执行一个动画&#xff0c;并且要求浏览器在下次重绘之前调用指定的回调函数更新动画。该方法需要传入一个回调函数作为参数&#xff0c;该回调函数会在浏览器下一次重绘之前执行。 备注&#xff1a; 若你想在浏览器下次重绘…

GRU模块:nn.GRU层

摘要&#xff1a; 如果需要深入理解GRU的话&#xff0c;内部实现的详细代码和计算公式就比较重要&#xff0c;中间的一些过程及中间变量的意义需要详细关注。只有这样&#xff0c;才能准备把握这个模块的内涵和意义&#xff0c;设计初衷和使用方式等等。所以&#xff0c;仔细研…

实现流程化办公,可了解一下可视化报表开源

当前&#xff0c;实现流程化办公早已成为众多中小企业的发展目标和趋势。可以借助什么样的软件平台实现这一目标&#xff1f;低代码技术平台拥有可视化操作界面、够灵活、易维护等优势特点&#xff0c;在助力企业实现流程化办公、数字化转型方面具有重要的应用价值和推动作用。…