django restframework 如何自定义统一响应和异常的返回格式

manitoHan

已于 2023-11-23 11:21:36 修改

阅读量637

点赞数 4

分类专栏： django 文章标签： django python 后端

于 2023-11-22 14:33:58 首次发布

本文链接：https://blog.csdn.net/hyfand1/article/details/134552481

版权

django 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

工作中有需要统一 drf 的json返回正常响应和异常响应的格式

如正常响应统一为

{
  'code': 200,
  'msg': msg,
  'data': data
}

异常响应统一为

{
  'code': 0,
  'msg': msg
}

解决方案

自定义异常处理类

from rest_framework.response import Response
from rest_framework.views import exception_handler
from rest_framework import status


def custom_exception_handler(exc, context):
    res = exception_handler(exc, context)
    if res:
        # 说明是drf的异常，它处理了
        if isinstance(res.data, dict):
            detail = res.data.pop('detail', 'error')
        else:
            detail = res.data[0]
        return Response({'code': 0, 'msg': detail}, status=res.status_code)
    # 说明是其它异常，它没有处理
    return Response({
        'code': 0,
        'msg': str(exc)
    }, status=status.HTTP_500_INTERNAL_SERVER_ERROR)

自定义json渲染器来统一响应格式

from rest_framework.renderers import JSONRenderer


class CustomRenderer(JSONRenderer):
    def render(self, data, accepted_media_type=None, renderer_context=None):
        if renderer_context:
            if isinstance(data, dict):
                msg = data.pop('msg', 'success')
                code = data.pop('code', renderer_context["response"].status_code)
            else:
                msg = 'success'
                code = renderer_context["response"].status_code

            # 自定义返回数据格式
            ret = {
                'code': 200,
                'msg': msg,
                'data': data,
            }
            if code == 0:
                ret.pop('data')
            return super().render(ret, accepted_media_type, renderer_context)
        else:
            return super().render(data, accepted_media_type, renderer_context)

在setting中注册自定义的异常处理类和 json 渲染类

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        'utils.custom_render.CustomRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ),
    'EXCEPTION_HANDLER': 'utils.custom_exception.custom_exception_handler',
}