Django RestFramework 全局异常处理

REST framework定义的异常

  • APIException 所有异常的父类
  • ParseError 解析错误
  • AuthenticationFailed 认证失败
  • NotAuthenticated 尚未认证
  • PermissionDenied 权限决绝
  • NotFound 未找到
  • MethodNotAllowed 请求方式不支持
  • NotAcceptable 要获取的数据格式不支持
  • Throttled 超过限流次数
  • ValidationError 校验失败

1定义异常处理类

from django.http import JsonResponse
from rest_framework.views import exception_handler as drf_exception_handler
import logging
from django.db import DatabaseError
from redis.exceptions import RedisError
import traceback

# 获取在配置文件中定义的logger,用来记录日志
logger = logging.getLogger('django')


def exception_handler(exc, context):
    """
    自定义异常处理
    :param exc: 异常
    :param context: 抛出异常的上下文(包含request请求对象和view视图对象)
    :return: Response响应对象
    """
    # 调用drf框架原生的异常处理方法
    
    response = drf_exception_handler(exc, context)
    if response is not None:
    	logger.info('REST_FRAMEWORK处理异常')
    	# 使用自定义封装好的方法处理数据格式并返回给前端
        return response_util.success(response)

    view = context['view']
    # 打印异常类以及异常的文本信息
    logger.error('[%s] %s' % (view, exc))
    returnData = {
        'code': 500,
        'msg': '服务器错误',
        'data': ""
    }
    # 捕获其他异常,直接返回 500
    if isinstance(exc, DatabaseError) or isinstance(exc, RedisError):
        # 数据库异常,使用traceback.format_exc()可以像系统报错没拦截那样子打印详细错误信息又不会导致程序停止
        logger.error(f'其他未知错误:{traceback.format_exc()}')
        # 使用django原生的响应对象返回,不能用DRF框架的响应对象
        return JsonResponse(data=returnData, status=500)
    else:
        # 打印错误详细信息
        logger.error(f'其他未知错误:{traceback.format_exc()}')
        # 使用django原生的响应对象返回,不能用DRF框架的响应对象
        return JsonResponse(data=returnData, status=500)

2 注册DRF框架中默认的错误处理为自己定义的类

在settings.py文件中定义

REST_FRAMEWORK = {
    # 异常处理
    'EXCEPTION_HANDLER': 'meiduo_service.utils.excepitons.exception_handler',
}

修改django默认处理了错误对象类似,将错误处理对象改为用中间件即可,处理的逻辑思路一样,不过类以及设置方法不一样而已

### Django 中抛出和处理异常的方法 #### 定义自定义异常处理器 为了更好地控制应用程序中的错误响应,在 `yourapp/utils.py` 文件中定义了一个名为 `custom_exception_handler` 的函数。此函数接收两个参数:一个是引发的异常实例 (`exc`),另一个是上下文字典 (`context`)。该函数首先调用了默认的异常处理器并获取其返回的结果。如果存在有效的响应,则修改响应的内容为预设字符串,并最终返回这个经过定制化的 HTTP 响应对象[^1]。 ```python from django.http import HttpResponse from rest_framework.views import exception_handler as drf_default_handler def custom_exception_handler(exc, context): # 调用DRF自带的异常处理程序得到初始响应 response = drf_default_handler(exc, context) if response is not None: # 修改响应体内容 response.data['status_code'] = response.status_code response.data['message'] = "An error occurred." return response ``` #### 使用标准库抛出自定义异常 除了上述全局级别的异常捕获外,还可以利用 Python 内置的标准库来创建特定业务逻辑下的异常类。例如: ```python class MyCustomError(Exception): """当某些条件不满足时触发""" pass raise MyCustomError('This is a custom message.') ``` 对于更复杂的Web应用来说,可能还需要考虑API层面的异常管理。REST framework 提供了一套完善的机制用于统一管理和序列化不同类型的HTTP状态码及其对应的消息描述。 #### API视图内的局部异常捕捉 在编写基于类的视图(Class-based Views) 或者 函数式视图(Function-Based Views) 期间,可以在适当的位置加入 try-except 结构来进行针对性更强的小范围异常拦截工作。 ```python from rest_framework.response import Response from rest_framework import status try: some_operation_that_might_fail() except ValueError as e: return Response({"error": str(e)}, status=status.HTTP_400_BAD_REQUEST) else: return Response(data={"success": True}, status=status.HTTP_200_OK) finally: cleanup_resources() # 清理资源操作总是被执行 ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值