Django REST framework 异常处理-巨人网络通讯

Django REST framework 异常处理

写在前面

这两天一直在思索关于 DRF 还有哪些是项目必备的而且还没有说到的基础性的知识。这不昨天写到日志相关的功能就直接想到还有异常处理相关的功能，其实在之前项目中初期是没有统一的异常捕获手段。可能是 DRF 自带的异常能满足大多数功能，也可能是比较懒，就使用比较粗暴的方式，以状态码 500 的方式去抛出异常，然后在日志中可以看到所有的异常信息。这么做呢，代码其实是不够健壮的，前端在调用的时候莫名的 500 也是不够友好的，所以今天就补充一下异常相关的知识。

DRF异常处理

1. DRF 常见的异常

AuthenticationFailed/ NotAuthenticated 一般该异常状态码为"401 Unauthenticated"，主要是没有登录鉴权的时候会返回，可以用在自定义登录的时候。
PermissionDenied 一般用在鉴权时候使用，一般状态码为"403 Forbidden"。
ValidationError 一般状态码为"400 Bad Request"，主要是 serializers 中对字段的校验，比如对字段类型的校验、字段长度的校验以及自定义字段格式的校验。

2. 自定义异常

这里对异常的定义主要的想法来自 ValidationError，统一异常返回的格式，方便前端统一处理类似异常。

自定义异常

# 新建 utils/custom_exception.py

class CustomException(Exception):
    _default_code = 400

    def __init__(
        self,
        message: str = "",
        status_code=status.HTTP_400_BAD_REQUEST,
        data=None,
        code: int = _default_code,
    ):

        self.code = code
        self.status = status_code
        self.message = message
        if data is None:
            self.data = {"detail": message}
        else:
            self.data = data

    def __str__(self):
        return self.message

自定义异常处理

# utils/custom_exception.py
from rest_framework.views import exception_handler

def custom_exception_handler(exc, context):
    # Call REST framework's default exception handler first,
    # to get the standard error response.
    
    # 这里对自定义的 CustomException 直接返回，保证系统其他异常不受影响
    if isinstance(exc, CustomException):
        return Response(data=exc.data, status=exc.status)
    response = exception_handler(exc, context)
    return response

配置自定义异常处理类

REST_FRAMEWORK = {
    # ...
    "EXCEPTION_HANDLER": "utils.custom_exception.custom_exception_handler",
}

3. 使用自定义异常

使用之前文章的接口用来测试自定义异常的处理

class ArticleViewSet(viewsets.ModelViewSet):
    """
    允许用户查看或编辑的API路径。
    """
    queryset = Article.objects.all()
    serializer_class = ArticleSerializer

    @action(detail=False, methods=["get"], url_name="exception", url_path="exception")
    def exception(self, request, *args, **kwargs):
        # 日志使用 demo
        logger.error("自定义异常")
        raise CustomException(data={"detail": "自定义异常"})

4. 验证结果

$ curl -H 'Accept: application/json; indent=4' -u admin:admin http://127.0.0.1:8000/api/article/exception/
{
    "detail": "自定义异常"
}

异常处理进阶

上面的代码虽说是可以满足90%的需求，但是错误的定义太泛泛。难以集中定义管理错误，与常见项目中自定义的异常比较优点就是灵活，但是随着代码中抛出的异常越来越多加之散落在各个角落，不利于更新维护。所以下面对修改一下代码，对异常有统一的定义，同时也支持自定义返回HTTP状态码。

1. 修改自定义异常

# utils/custom_exception.py

class CustomException(Exception):
    # 自定义code
    default_code = 400
    # 自定义 message
    default_message = None

    def __init__(
            self,
            status_code=status.HTTP_400_BAD_REQUEST,
            code: int = None,
            message: str = None,
            data=None,
    ):
        self.status = status_code
        self.code = self.default_code if code is None else code
        self.message = self.default_message if message is None else message

        if data is None:
            self.data = {"detail": self.message, "code": self.code}
        else:
            self.data = data

    def __str__(self):
        return str(self.code) + self.message

2. 自定义更多异常

class ExecuteError(CustomException):
    """执行出错"""
    default_code = 500
    default_message = "执行出错"


class UnKnowError(CustomException):
    """执行出错"""
    default_code = 500
    default_message = "未知出错"

3. 新增测试接口

class ArticleViewSet(viewsets.ModelViewSet):
    """
    允许用户查看或编辑的API路径。
    """
    queryset = Article.objects.all()
    serializer_class = ArticleSerializer

    @action(detail=False, methods=["get"], url_name="exception", url_path="exception")
    def exception(self, request, *args, **kwargs):
        # 日志使用 demo
        logger.error("自定义异常")
        raise CustomException(data={"detail": "自定义异常"})

    @action(detail=False, methods=["get"], url_name="unknown", url_path="unknown")
    def unknown(self, request, *args, **kwargs):
        # 日志使用 demo
        logger.error("未知错误")
        raise UnknownError()

    @action(detail=False, methods=["get"], url_name="execute", url_path="execute")
    def execute(self, request, *args, **kwargs):
        # 日志使用 demo
        logger.error("执行错误")
        raise ExecuteError()

4. 验证结果

curl -H 'Accept: application/json; indent=4' -u admin:admin http://127.0.0.1:8000/api/article/unknown/
{
    "detail": "未知出错",
    "code": 500
}
$ curl -H 'Accept: application/json; indent=4' -u admin:admin http://127.0.0.1:8000/api/article/execute/
{
    "detail": "执行出错",
    "code": 500
}

总结

需要注意自定义的异常处理函数需要在处理完成自定义异常后继续执行 rest_framework.views.exception_handler，因为这里的执行仍然需要兼容已有的异常处理；下面贴一下 DRF 有关的异常处理逻辑。

该处理函数默认处理 APIException以及 Django 内部的 Http404 PermissionDenied，其他的异常会返回 None ，会触发 DRF 500 的错误。

def exception_handler(exc, context):
    """
    Returns the response that should be used for any given exception.

    By default we handle the REST framework `APIException`, and also
    Django's built-in `Http404` and `PermissionDenied` exceptions.

    Any unhandled exceptions may return `None`, which will cause a 500 error
    to be raised.
    """
    if isinstance(exc, Http404):
        exc = exceptions.NotFound()
    elif isinstance(exc, PermissionDenied):
        exc = exceptions.PermissionDenied()

    if isinstance(exc, exceptions.APIException):
        headers = {}
        if getattr(exc, 'auth_header', None):
            headers['WWW-Authenticate'] = exc.auth_header
        if getattr(exc, 'wait', None):
            headers['Retry-After'] = '%d' % exc.wait

        if isinstance(exc.detail, (list, dict)):
            data = exc.detail
        else:
            data = {'detail': exc.detail}

        set_rollback()
        return Response(data, status=exc.status_code, headers=headers)

    return None