DRF渲染之异常处理

news2024/11/30 2:27:21

异常处理

【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')

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

BGP综合大实验

BGP综合大实验

实验要求 1.AS1中存在两个环回&#xff0c;一个地址是192.168.1.0/24&#xff0c;改地址不能在任何协议中宣告&#xff1b;AS3中存在两个环回&#xff0c;一个地址为192.168.2.0/24&#xff0c;该地址不能在任何协议中宣告&#xff0c;最终要求这两个环回可以ping通&#xff1b…
阅读更多...
AI绘画动漫转真人详细教程

AI绘画动漫转真人详细教程

从小到大&#xff0c;我们看过的动漫、玩过的游戏有很多很多 但我们会发现里面的角色或者人物都是二次元的 我就会好奇这些动漫人物在现实中会长什么样 而现在&#xff0c;我们通过AI绘画竟然就能还原出来他们现实中的样子 除了动漫角色和游戏人物&#xff0c;古代的画像、经典…
阅读更多...
K-AI01,K-AO01,K-BUS02和利时

K-AI01,K-AO01,K-BUS02和利时

K-AI01,K-AO01,K-BUS02和利时1.将工程师站的计算机开机&#xff1b;2.开机后鼠标双击桌面上的“maintenance tool”图标&#xff0c;K-AI01,K-AO01,K-BUS02和利时。出现如下图标&#xff1a; 按顺序点击”图标中的箭头所指的按钮&#xff0c;出现如下画面选中画面中需要强制的逻…
阅读更多...
C++语言题库（三）—— PAT

C++语言题库（三）—— PAT

目录 1. 打印点、圆、圆柱信息 2. 国际贸易统计 3. 设计一个类CRectangle 4. 定义一个时间类 5. 定义一个Date类 6. 定义一个Time类 7. 设计一个People类 8. 平均成绩 9. 计算若干个学生的总成绩及平均成绩 11. 使用面向对象的方法求长方形的周长 1. 打印点、圆、圆柱…
阅读更多...
16 华三数据中心最流行的技术 M-LAG

16 华三数据中心最流行的技术 M-LAG

STP和MTP&#xff08;第二十二课&#xff09;-CSDN博客 VRRP技术和浮动路由(第二十六课)_vrrp 浮动路由-CSDN博客 VRRP DHCP ACL NAT 网络核心路由技术综述 (第十课)-CSDN博客 04 交换机的IRF的配置-CSDN博客 1 M-LAG AI介绍 M-LAG&#xff08;Multi-Chassis Link Aggrega…
阅读更多...
57 读取/写出/读取 文件的过程的调试

57 读取/写出/读取 文件的过程的调试

前言 问题来自于文章 请教文件读写问题 请教文件读写问题 - 内核源码-Chinaunix vim 编辑文件, 实际上删除了原有的文件建立了一个新的文件? Ls –ail . 查看 inode 编号不一样了 这里主要是 调试一下 这一系列流程 测试用例 就是一个程序, 读取 1.txt 两次, 两次之间间隔…
阅读更多...
数据结构-二叉树-红黑树

数据结构-二叉树-红黑树

一、红黑树的概念 红黑树是一种二叉搜索树&#xff0c;但在每个节点上增加一个存储位表示节点的颜色&#xff0c;可以是Red或者BLACK&#xff0c;通过对任何一条从根到叶子的路径上各个节点着色方式的限制&#xff0c;红黑树确保没有一条路径会比其他路径长出两倍&#xff0c;…
阅读更多...
【C++杂货铺铺】AVL树

【C++杂货铺铺】AVL树

目录 &#x1f308;前言&#x1f308; &#x1f4c1; 概念 &#x1f4c1; 节点的定义 &#x1f4c1; 插入 &#x1f4c1; 旋转 1 . 新节点插入较高左子树的左侧---左左&#xff1a;右单旋 2. 新节点插入较高右子树的右侧---右右&#xff1a;左单旋 3. 新节点插入较高左…
阅读更多...
在vue3中，如何优雅的使用echarts之实现大屏项目

在vue3中，如何优雅的使用echarts之实现大屏项目

前置知识 效果图 使用技术 Vue3 Echarts Gasp Gasp&#xff1a;是一个 JavaScript动画库,它支持快速开发高性能的 Web 动画。在本项目中&#xff0c;主要是用于做轨迹运动 所需安装的插件 npm i echarts npm i countup.js 数字滚动特效 npm i gsap javascript动画库 np…
阅读更多...
全新时代的降临——比亚迪，助力未来出行

全新时代的降临——比亚迪，助力未来出行

近日&#xff0c;世界舞台中央聚焦&#xff0c;比亚迪登上欧洲顶级赛事赞助席位&#xff0c;让全球见证中国新能源汽车传奇崛起&#xff01;作为新能源领袖品牌&#xff0c;比亚迪现已累计销售突破730万辆&#xff0c;全球每售出五辆新能源汽车&#xff0c;便有一辆来自比亚迪。…
阅读更多...
vivado Virtex-7 配置存储器器件

vivado Virtex-7 配置存储器器件

Virtex-7 配置存储器器件 下表所示闪存器件支持通过 Vivado 软件对 Virtex -7 器件执行擦除、空白检查、编程和验证等配置操作。 本附录中的表格所列赛灵思系列非易失性存储器将不断保持更新 &#xff0c; 并支持通过 Vivado 软件对其中所列非易失性存储器 进行擦除、…
阅读更多...
【中航证券军工】北摩高科2023年报2024Q1点评：聚焦航空及军工主赛道，民机业务有望成为第二曲线

【中航证券军工】北摩高科2023年报2024Q1点评：聚焦航空及军工主赛道，民机业务有望成为第二曲线

事件 公司4月24日公告&#xff0c;2024Q1实现营收&#xff08;2.40亿元&#xff0c;同比-23.71%)&#xff0c;归母净利润&#xff08;0.73亿元&#xff0c;同比-45.63%)&#xff0c;毛利率&#xff08;62.63%&#xff0c;同比-7.22pcts)&#xff0c;净利率&#xff08;37.34%&…
阅读更多...
安装conda并搭建python环境（入门教程）

安装conda并搭建python环境（入门教程）

文章目录 1. 什么是 conda&#xff1f;1.1 Conda 与 Anaconda 的区别1.2 Conda 与 pip 的区别 2. 下载安装3. 配置并使用 conda3.1 配置下载源3.2 环境管理3.2.1 创建&#xff08;删除&#xff09;环境3.2.2 激活&#xff08;切换&#xff09;环境3.2.2 下载&#xff08;卸载&a…
阅读更多...
Sping源码（七）—ConfigurationClassPostProcessor ——@PropertySources解析

Sping源码（七）—ConfigurationClassPostProcessor ——@PropertySources解析

序言 先来简单回顾一下ConfigurationClassPostProcessor大致的一个处理流程&#xff0c;再来详细的讲解PropertySources注解的处理逻辑。 详细的步骤可参考ConfigurationClassPostProcessor这篇帖子。 流程图 从获取所有BeanDefinition -> 过滤、赋值、遍历 -> 解析 -&…
阅读更多...
常用的简单友好的工单系统（免费）- WGCAT

常用的简单友好的工单系统（免费）- WGCAT

最近在项目中&#xff0c;有工单系统的需求场景&#xff0c;所以想寻找一款轻量简单的运维工单软件&#xff0c;主要用来记录和处理工作中的一些故障、维护&#xff0c;主要用来记录设备的维护状态&#xff0c;包括服务器、主机、交换机那些 WGCAT&#xff0c;是一款简单轻量的…
阅读更多...
2024中国(重庆)人工智能展览会8月举办

2024中国(重庆)人工智能展览会8月举办

2024中国(重庆)人工智能展览会8月举办 邀请函 主办单位&#xff1a; 中国航空学会 重庆市南岸区人民政府 招商执行单位&#xff1a; 重庆港华展览有限公司 【报名I59交易会 2351交易会 9466】 展会背景&#xff1a; 2024中国航空科普大会暨第八届全国青少年无人机大赛在…
阅读更多...
macOS12安装 php8.1和apache

macOS12安装 php8.1和apache

1. 安装php 8.1 macOS12不再自带php brew tap shivammathur/php 查看可安装版本 brew search php 安装指定版本 brew install php8.1 环境配置 vim ~/.zshrc export PATH"/usr/local/opt/php8.1/bin:$PATH" export PATH"/usr/local/opt/php8.1/sbin:$PAT…
阅读更多...
Git Bash和Git GUI设置中文的方法

Git Bash和Git GUI设置中文的方法

0 前言 Git是一个分布式版本控制系统&#xff0c;可以有效、高速地处理从很小到非常大的项目版本管理。一般默认语言为英文&#xff0c;本文介绍修改Git Bash和Git GUI语言为中文的方法。 1 Git Bash设置中文方法 &#xff08;1&#xff09;鼠标右键&#xff0c;单击“Git B…
阅读更多...
每日两题 / 108. 将有序数组转换为二叉搜索树 543. 二叉树的直径（LeetCode热题100）

每日两题 / 108. 将有序数组转换为二叉搜索树 543. 二叉树的直径（LeetCode热题100）

108. 将有序数组转换为二叉搜索树 - 力扣&#xff08;LeetCode&#xff09; 每次将数组对半分&#xff0c;数组的中点作为树的节点 先选择整个数组的中点作为根节点&#xff0c;然后选择对半分后的两个子数组的中点作为根节点的左右节点… /*** Definition for a binary tre…
阅读更多...
【操作系统期末速成】​内存管理|内存的装入模块在装入内存的方式|分配管理方式|页面置换算法|页面置换

【操作系统期末速成】​内存管理|内存的装入模块在装入内存的方式|分配管理方式|页面置换算法|页面置换

&#x1f3a5; 个人主页&#xff1a;深鱼~&#x1f525;收录专栏&#xff1a;操作系统&#x1f304;欢迎 &#x1f44d;点赞✍评论⭐收藏 推荐 前些天发现了一个巨牛的人工智能学习网站&#xff0c;通俗易懂&#xff0c;风趣幽默&#xff0c;忍不住分享一下给大家。点击跳转到…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023