Django REST framework异常捕获的全局配置

默认情况下,DRF框架通过内置的 exception_handler 方法,处理了如下异常:

Http404
PermissionDenied
DRF框架异常

* APIException - DRF 框架异常的父类,以下为它的子类
NotFound 未找到
PermissionDenied 权限拒绝
ParseError 解析错误
AuthenticationFailed 认证失败
NotAuthenticated 尚未认证
MethodNotAllowed 请求方式不支持
Throttled 超过限流次数
ValidationError 校验失败
NotAcceptable 要获取的数据格式不支持
如果 exception_handler 方法处理异常成功,则返回一个Response对象,否则返回None

如果发生了上面的这些异常,DRF框架的excaption_handler函数可以自动捕获异常,然后进行处理,返回Response对象。如果不是上面的这些异常,则处理不了,返回None。

那我们在生产环境中,需要把全部异常捕获,输入到日志中。而且我们也不希望给错误页面给用户看到,这时候应该怎么办呢?

这时候可以针对 DRF 框架没有处理的一些特殊的异常,进行全局的异常处理。

from rest_framework.views import exception_handler as drf_exception_handler
import logging
from django.db import DatabaseError
from redis.exceptions import RedisError
from rest_framework.response import Response
from rest_framework import status

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

def exception_handler(exc, context):
    """
    自定义异常处理
    :param exc: 异常
    :param context: 抛出异常的上下文
    :return: Response响应对象
    """
    # 调用drf框架原生的异常处理方法
    response = drf_exception_handler(exc, context)

    if response is None:
        view = context['view']
        if isinstance(exc, DatabaseError) or isinstance(exc, RedisError):
            # 数据库异常
            logger.error('[%s] %s' % (view, exc))
            response = Response({'message': '服务器内部错误'}, status=status.HTTP_507_INSUFFICIENT_STORAGE)

    return response

配置文件中添加

REST_FRAMEWORK = {
    # 异常处理
    'EXCEPTION_HANDLER': 上述文件的路径,
}

你可能感兴趣的:(Django REST framework异常捕获的全局配置)