本文主要是介绍DRF渲染之异常处理，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！
异常处理
【1 】引言
Django REST Framework 这个就是我们常常说的DRF
- APIView的dispatch方法：
- 当请求到达视图时，DRF 的
APIView类会调用dispatch方法来处理请求。 - 在
dispatch方法中，有一个关键的步骤是处理异常。如果在视图类的方法执行过程中出现了异常，DRF 会捕获这个异常，并调用self.handle_exception(exc)方法来处理它。
- 当请求到达视图时，DRF 的
- handle_exception 方法：
handle_exception方法用于处理异常，它首先获取异常处理函数的引用，这个函数的地址存储在配置中，通常是settings.EXCEPTION_HANDLER。- 然后，
handle_exception调用这个异常处理函数，并传入两个参数：异常对象exc和上下文context。 - 异常处理函数执行后会返回一个响应对象，这个响应对象会在异常发生时返回给客户端。
- rest_framework.views.exception_handler 函数：
- 这个函数是 DRF 提供的默认异常处理函数。它会检查传入的异常是否是 DRF 内置的
exceptions.APIException类型的异常。 - 如果是
APIException类型的异常，这个函数会根据异常类型组装一个响应对象，并返回。 - 如果异常不是
APIException类型的，则返回None，意味着这个异常不是 DRF 能处理的，需要由其他方式处理（比如由 Django 的默认异常处理机制处理）。
- 这个函数是 DRF 提供的默认异常处理函数。它会检查传入的异常是否是 DRF 内置的
总的来说，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的异常，它没处理，直接前端能看到
- 异常类型检查：
if isinstance(exc, (exceptions.NotAuthenticated, exceptions.AuthenticationFailed)):这里检查异常是否是用户未认证或认证失败引起的。
- 认证头部信息获取：
auth_header = self.get_authenticate_header(self.request): 尝试获取适当的认证头部信息，用于构建响应。if auth_header:: 如果成功获取了认证头部信息，则将其添加到异常对象中，否则将响应状态码设置为 403 Forbidden。
- 异常处理程序调用：
exception_handler = self.get_exception_handler(): 获取异常处理程序。context = self.get_exception_handler_context(): 获取异常处理上下文。response = exception_handler(exc, context): 将异常对象和上下文传递给异常处理程序，获取处理后的响应。
- 响应处理：
if response is None:: 如果异常处理程序返回了None，表示没有提供一个适当的响应，这时会重新引发异常。response.exception = True: 将响应对象的exception属性设置为True，表示这个响应是由异常引起的。return response: 返回处理后的响应。
这些部分共同构成了异常处理器的核心功能，负责捕获、处理异常，并生成适当的响应。
总结：默认drf只处理了自己的异常，django的异常，它没处理，直接前端能看到
【 2 】简单示例
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渲染之异常处理的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！
