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。

相关文章

Java 中的 @SneakyThrows 注解使用方法(简化异常处理的利与弊)

Java 中的 @SneakyThrows 注解使用方法(简化异常处理的利与弊)

《Java中的@SneakyThrows注解使用方法(简化异常处理的利与弊)》为了简化异常处理,Lombok提供了一个强大的注解@SneakyThrows,本文将详细介绍@SneakyThro... 目录1. @SneakyThrows 简介 1.1 什么是 Lombok？2. @SneakyThrows
阅读更多...
在 Spring Boot 中实现异常处理最佳实践

在 Spring Boot 中实现异常处理最佳实践

《在SpringBoot中实现异常处理最佳实践》本文介绍如何在SpringBoot中实现异常处理,涵盖核心概念、实现方法、与先前查询的集成、性能分析、常见问题和最佳实践,感兴趣的朋友一起看看吧... 目录一、Spring Boot 异常处理的背景与核心概念1.1 为什么需要异常处理？1.2 Spring B
阅读更多...
python处理带有时区的日期和时间数据

python处理带有时区的日期和时间数据

《python处理带有时区的日期和时间数据》这篇文章主要为大家详细介绍了如何在Python中使用pytz库处理时区信息,包括获取当前UTC时间,转换为特定时区等,有需要的小伙伴可以参考一下... 目录时区基本信息python datetime使用timezonepandas处理时区数据知识延展时区基本信息
阅读更多...
关于MongoDB图片URL存储异常问题以及解决

关于MongoDB图片URL存储异常问题以及解决

《关于MongoDB图片URL存储异常问题以及解决》：本文主要介绍关于MongoDB图片URL存储异常问题以及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录MongoDB图片URL存储异常问题项目场景问题描述原因分析解决方案预防措施js总结MongoDB图
阅读更多...
Python Transformers库(NLP处理库)案例代码讲解

Python Transformers库(NLP处理库)案例代码讲解

《PythonTransformers库(NLP处理库)案例代码讲解》本文介绍transformers库的全面讲解,包含基础知识、高级用法、案例代码及学习路径,内容经过组织,适合不同阶段的学习者,对... 目录一、基础知识1. Transformers 库简介2. 安装与环境配置3. 快速上手示例二、核心模
阅读更多...
一文详解Java异常处理你都了解哪些知识

一文详解Java异常处理你都了解哪些知识

《一文详解Java异常处理你都了解哪些知识》：本文主要介绍Java异常处理的相关资料,包括异常的分类、捕获和处理异常的语法、常见的异常类型以及自定义异常的实现,文中通过代码介绍的非常详细,需要的朋... 目录前言一、什么是异常二、异常的分类2.1 受检异常2.2 非受检异常三、异常处理的语法3.1 try-
阅读更多...
Python使用getopt处理命令行参数示例解析(最佳实践)

Python使用getopt处理命令行参数示例解析(最佳实践)

《Python使用getopt处理命令行参数示例解析(最佳实践)》getopt模块是Python标准库中一个简单但强大的命令行参数处理工具,它特别适合那些需要快速实现基本命令行参数解析的场景,或者需要... 目录为什么需要处理命令行参数？getopt模块基础实际应用示例与其他参数处理方式的比较常见问http
阅读更多...
Java Response返回值的最佳处理方案

Java Response返回值的最佳处理方案

《JavaResponse返回值的最佳处理方案》在开发Web应用程序时,我们经常需要通过HTTP请求从服务器获取响应数据,这些数据可以是JSON、XML、甚至是文件,本篇文章将详细解析Java中处理... 目录摘要概述核心问题：关键技术点：源码解析示例 1：使用HttpURLConnection获取Resp
阅读更多...
usb接口驱动异常问题常用解决方案

usb接口驱动异常问题常用解决方案

《usb接口驱动异常问题常用解决方案》当遇到USB接口驱动异常时，可以通过多种方法来解决，其中主要就包括重装USB控制器、禁用USB选择性暂停设置、更新或安装新的主板驱动等... usb接口驱动异常怎么办，USB接口驱动异常是常见问题，通常由驱动损坏、系统更新冲突、硬件故障或电源管理设置导致。以下是常用解决
阅读更多...
Java中Switch Case多个条件处理方法举例

Java中Switch Case多个条件处理方法举例

《Java中SwitchCase多个条件处理方法举例》Java中switch语句用于根据变量值执行不同代码块,适用于多个条件的处理,：本文主要介绍Java中SwitchCase多个条件处理的相... 目录前言基本语法处理多个条件示例1：合并相同代码的多个case示例2：通过字符串合并多个case进阶用法使用
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2