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。

相关文章

电脑提示xlstat4.dll丢失怎么修复? xlstat4.dll文件丢失处理办法

电脑提示xlstat4.dll丢失怎么修复? xlstat4.dll文件丢失处理办法

《电脑提示xlstat4.dll丢失怎么修复?xlstat4.dll文件丢失处理办法》长时间使用电脑，大家多少都会遇到类似dll文件丢失的情况，不过，解决这一问题其实并不复杂，下面我们就来看看xls... 在Windows操作系统中，xlstat4.dll是一个重要的动态链接库文件，通常用于支持各种应用程序
阅读更多...
SQL Server数据库死锁处理超详细攻略

SQL Server数据库死锁处理超详细攻略

《SQLServer数据库死锁处理超详细攻略》SQLServer作为主流数据库管理系统,在高并发场景下可能面临死锁问题,影响系统性能和稳定性,这篇文章主要给大家介绍了关于SQLServer数据库死... 目录一、引言二、查询 Sqlserver 中造成死锁的 SPID三、用内置函数查询执行信息1. sp_w
阅读更多...
Java对异常的认识与异常的处理小结

Java对异常的认识与异常的处理小结

《Java对异常的认识与异常的处理小结》Java程序在运行时可能出现的错误或非正常情况称为异常,下面给大家介绍Java对异常的认识与异常的处理,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参... 目录一、认识异常与异常类型。二、异常的处理三、总结 一、认识异常与异常类型。（1）简单定义-什么是
阅读更多...
Python主动抛出异常的各种用法和场景分析

Python主动抛出异常的各种用法和场景分析

《Python主动抛出异常的各种用法和场景分析》在Python中,我们不仅可以捕获和处理异常,还可以主动抛出异常,也就是以类的方式自定义错误的类型和提示信息,这在编程中非常有用,下面我将详细解释主动抛... 目录一、为什么要主动抛出异常？二、基本语法：raise关键字基本示例三、raise的多种用法1. 抛
阅读更多...
Golang 日志处理和正则处理的操作方法

Golang 日志处理和正则处理的操作方法

《Golang日志处理和正则处理的操作方法》：本文主要介绍Golang日志处理和正则处理的操作方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考... 目录1、logx日志处理1.1、logx简介1.2、日志初始化与配置1.3、常用方法1.4、配合defer
阅读更多...
springboot加载不到nacos配置中心的配置问题处理

springboot加载不到nacos配置中心的配置问题处理

《springboot加载不到nacos配置中心的配置问题处理》：本文主要介绍springboot加载不到nacos配置中心的配置问题处理,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑... 目录springboot加载不到nacos配置中心的配置两种可能Spring Boot 版本Nacos
阅读更多...
Java空指针异常NullPointerException的原因与解决方案

Java空指针异常NullPointerException的原因与解决方案

《Java空指针异常NullPointerException的原因与解决方案》在Java开发中,NullPointerException（空指针异常）是最常见的运行时异常之一,通常发生在程序尝试访问或... 目录一、空指针异常产生的原因1. 变量未初始化2. 对象引用被显式置为null3. 方法返回null
阅读更多...
python web 开发之Flask中间件与请求处理钩子的最佳实践

python web 开发之Flask中间件与请求处理钩子的最佳实践

《pythonweb开发之Flask中间件与请求处理钩子的最佳实践》Flask作为轻量级Web框架,提供了灵活的请求处理机制,中间件和请求钩子允许开发者在请求处理的不同阶段插入自定义逻辑,实现诸如... 目录Flask中间件与请求处理钩子完全指南1. 引言2. 请求处理生命周期概述3. 请求钩子详解3.1
阅读更多...
Python处理大量Excel文件的十个技巧分享

Python处理大量Excel文件的十个技巧分享

《Python处理大量Excel文件的十个技巧分享》每天被大量Excel文件折磨的你看过来！这是一份Python程序员整理的实用技巧,不说废话,直接上干货,文章通过代码示例讲解的非常详细,需要的朋友可... 目录一、批量读取多个Excel文件二、选择性读取工作表和列三、自动调整格式和样式四、智能数据清洗五、
阅读更多...
SpringBoot如何对密码等敏感信息进行脱敏处理

SpringBoot如何对密码等敏感信息进行脱敏处理

《SpringBoot如何对密码等敏感信息进行脱敏处理》这篇文章主要为大家详细介绍了SpringBoot对密码等敏感信息进行脱敏处理的几个常用方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下... 目录​1. 配置文件敏感信息脱敏​​2. 日志脱敏​​3. API响应脱敏​​4. 其他注意事项​​总结
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2