DRF渲染之异常处理

2024-05-12 22:04
文章标签 异常 处理 渲染 drf

本文主要是介绍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_handlerexception_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,AuthenticationFailedclass 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 Responsedef 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,APIExceptionclass TeyView(APIView):def get(self,request):# drf的异常# 主动抛出异常！！！# raise APIException('校验失败')# raise AuthenticationFailed('失败了这么棒！！')# # diango的异常# res = 9/0a = [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 / 0except ZeroDivisionError:# 捕获除零错误，并抛出 PassException 异常raise PassException('4564')

def common_exception_handler(exc, context):...else:...else:if isinstance(exc, PassException):  # 检查是否是 PassExceptionresponse = 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 Responseclass PassException(Exception):def __init__(self,msg):self.msg=msgdef 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 loggingclass 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 NoPermissionExceptionexcept 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')

这篇关于DRF渲染之异常处理的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/983859。

相关文章

无人叉车3d激光slam多房间建图定位异常处理方案-墙体画线地图切分方案

无人叉车3d激光slam多房间建图定位异常处理方案-墙体画线地图切分方案

墙体画线地图切分方案 针对问题：墙体两侧特征混淆误匹配，导致建图和定位偏差，表现为过门跳变、外月台走歪等 ·解决思路：预期的根治方案IGICP需要较长时间完成上线，先使用切分地图的工程化方案，即墙体两侧切分为不同地图，在某一侧只使用该侧地图进行定位 方案思路 切分原理：切分地图基于关键帧位置，而非点云。 理论基础：光照是直线的，一帧点云必定只能照射到墙的一侧，无法同时照到两侧实践考虑：关
阅读更多...
【生成模型系列（初级）】嵌入（Embedding）方程——自然语言处理的数学灵魂【通俗理解】

【生成模型系列（初级）】嵌入（Embedding）方程——自然语言处理的数学灵魂【通俗理解】

【通俗理解】嵌入（Embedding）方程——自然语言处理的数学灵魂 关键词提炼 #嵌入方程 #自然语言处理 #词向量 #机器学习 #神经网络 #向量空间模型 #Siri #Google翻译 #AlexNet 第一节：嵌入方程的类比与核心概念【尽可能通俗】 嵌入方程可以被看作是自然语言处理中的“翻译机”，它将文本中的单词或短语转换成计算机能够理解的数学形式，即向量。 正如翻译机将一种语言
阅读更多...
Thymeleaf：生成静态文件及异常处理java.lang.NoClassDefFoundError: ognl/PropertyAccessor

Thymeleaf：生成静态文件及异常处理java.lang.NoClassDefFoundError: ognl/PropertyAccessor

我们需要引入包： <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-thymeleaf</artifactId></dependency><dependency><groupId>org.springframework</groupId><artifactId>sp
阅读更多...
深入理解数据库的 4NF：多值依赖与消除数据异常

深入理解数据库的 4NF：多值依赖与消除数据异常

在数据库设计中， "范式" 是一个常常被提到的重要概念。许多初学者在学习数据库设计时，经常听到第一范式（1NF）、第二范式（2NF）、第三范式（3NF）以及 BCNF（Boyce-Codd范式）。这些范式都旨在通过消除数据冗余和异常来优化数据库结构。然而，当我们谈到 4NF（第四范式）时，事情变得更加复杂。本文将带你深入了解 多值依赖 和 4NF，帮助你在数据库设计中消除更高级别的异常。 什么是
阅读更多...
消除安卓SDK更新时的“https://dl-ssl.google.com refused”异常的方法

消除安卓SDK更新时的“https://dl-ssl.google.com refused”异常的方法

消除安卓SDK更新时的“https://dl-ssl.google.com refused”异常的方法   消除安卓SDK更新时的“https://dl-ssl.google.com refused”异常的方法 [转载]原地址：http://blog.csdn.net/x605940745/article/details/17911115 消除SDK更新时的“
阅读更多...
jenkins 插件执行shell命令时，提示“Command not found”处理方法

jenkins 插件执行shell命令时，提示“Command not found”处理方法

首先提示找不到“Command not found，可能我们第一反应是查看目标机器是否已支持该命令，不过如果相信能找到这里来的朋友估计遇到的跟我一样，其实目标机器是没有问题的通过一些远程工具执行shell命令是可以执行。奇怪的就是通过jenkinsSSH插件无法执行，经一番折腾各种搜索发现是jenkins没有加载/etc/profile导致。 【解决办法】： 需要在jenkins调用shell脚
阅读更多...
JVM 常见异常及内存诊断

JVM 常见异常及内存诊断

栈内存溢出 栈内存大小设置：-Xss size 默认除了window以外的所有操作系统默认情况大小为 1MB，window 的默认大小依赖于虚拟机内存。 栈帧过多导致栈内存溢出 下述示例代码，由于递归深度没有限制且没有设置出口，每次方法的调用都会产生一个栈帧导致了创建的栈帧过多，而导致内存溢出(StackOverflowError)。 示例代码： 运行结果： 栈帧过大导致栈内存
阅读更多...
明明的随机数处理问题分析与解决方案

明明的随机数处理问题分析与解决方案

明明的随机数处理问题分析与解决方案 引言问题描述解决方案数据结构设计具体步骤伪代码C语言实现详细解释读取输入去重操作排序操作输出结果复杂度分析 引言 明明生成了N个1到500之间的随机整数，我们需要对这些整数进行处理，删去重复的数字，然后进行排序并输出结果。本文将详细讲解如何通过算法、数据结构以及C语言来解决这个问题。我们将会使用数组和哈希表来实现去重操作，再利用排序算法对结果
阅读更多...
8. 自然语言处理中的深度学习：从词向量到BERT

8. 自然语言处理中的深度学习：从词向量到BERT

引言 深度学习在自然语言处理（NLP）领域的应用极大地推动了语言理解和生成技术的发展。通过从词向量到预训练模型（如BERT）的演进，NLP技术在机器翻译、情感分析、问答系统等任务中取得了显著成果。本篇博文将探讨深度学习在NLP中的核心技术，包括词向量、序列模型（如RNN、LSTM），以及BERT等预训练模型的崛起及其实际应用。 1. 词向量的生成与应用 词向量（Word Embedding）
阅读更多...
使用协程实现高并发的I/O处理

使用协程实现高并发的I/O处理

文章目录 1. 协程简介1.1 什么是协程？1.2 协程的特点1.3 Python 中的协程 2. 协程的基本概念2.1 事件循环2.2 协程函数2.3 Future 对象 3. 使用协程实现高并发的 I/O 处理3.1 网络请求3.2 文件读写 4. 实际应用场景4.1 网络爬虫4.2 文件处理 5. 性能分析5.1 上下文切换开销5.2 I/O 等待时间 6. 最佳实践6.1 使用 as
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2