六、Django rest framework自定义返回数据格式

参考 Django rest framework自定义返回数据格式

一、简介

drf 默认返回的异常格式是这样的

{
    "username": [
        "该字段是必填项。"
    ],
    "password": [
        "该字段是必填项。"
    ]
}

但是在实际工作中、这样的数据不利于前端的渲染，一般是这样的格式返回(有错误的时候)

{
    "msg": "username该字段是必填项。",
    "code": 0,
    "data": ""
}

正确的时候

{
    "msg": "success",
    "code": 1,
    "data": {
        "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTU4NjMxMDk5NCwianRpIjoiZTkzZDlhYzZhMWM5NDQ2NTgyN2ZkMzJmNWYzNDVlNjIiLCJ1c2VyX2lkIjoxfQ.Nca8X5AClJxVuDK1-wxJBFZI9WzXt2UL3bytyRckqTU",
        "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNTg1NjE5Nzk0LCJqdGkiOiI0NjZkMzk2ZThiMjU0MDQxYTE5OWJjZTc5MjRjNDc2ZiIsInVzZXJfaWQiOjF9.9oaLarHvtT8Zo9dV312Y5fE9HtkTp9Uxrx4WWo_8etg",
        "username": "hahn",
        "user_id": 1
    }
}

想要弄成这样的效果需要自定义drf异常返回和自定义数据返回格式
在settings.py中
EXCEPTION_HANDLER对应的是你文件夹路径

# drf配置
REST_FRAMEWORK = {
    # 全局配置异常模块
    'EXCEPTION_HANDLER': 'utils.exception.custom_exception_handler',
    # 修改默认返回JSON的renderer的类
    'DEFAULT_RENDERER_CLASSES': (
        'utils.rendererresponse.customrenderer',
    ),
}

二、设置异常返回

这里我是utils文件夹里面新建了exception.py文件
这里可以根据你的需求修改、我这个只是参考，具体解释看注释

# 自定义异常处理
from rest_framework.views import exception_handler
from rest_framework.views import Response
from rest_framework import status


# 将仅针对由引发的异常生成的响应调用异常处理程序。它不会用于视图直接返回的任何响应
#需要在setting中配置这个异常处理方法,并且异常返回的respose对象还会传到默认返回的json的renderer类中，在setting中drf配置中的DEFAULT_RENDERER_CLASSES
# 如果未声明，会采用默认的方式，如下
#
# REST_FRAMEWORK = {
#     'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
# }
# 下面是我配置的已经自定义的处理
# REST_FRAMEWORK = {
#     # 全局配置异常模块
#     'EXCEPTION_HANDLER': 'utils.exception.custom_exception_handler',
#     # 修改默认返回JSON的renderer的类
#     'DEFAULT_RENDERER_CLASSES': (
#         'utils.rendererresponse.customrenderer',
#     ),
# }
def custom_exception_handler(exc, context):
    # 先调用REST framework默认的异常处理方法获得标准错误响应对象
    response = exception_handler(exc, context)
    #print(exc)  #错误原因   还可以做更详细的原因，通过判断exc信息类型
    #print(context)  # 错误信息
    # print('1234 = %s - %s - %s' % (context['view'], context['request'].method, exc))
    #print(response)


    #如果response响应对象为空，则设置message这个key的值，并将状态码设为500
    #如果response响应对象不为空，则则设置message这个key的值，并将使用其本身的状态码
    if response is None:
        return Response({
            'message': '服务器错误:{exc}'.format(exc=exc)
        }, status=status.HTTP_500_INTERNAL_SERVER_ERROR, exception=True)

    else:
        # print('123 = %s - %s - %s' % (context['view'], context['request'].method, exc))
        return Response({
            'message': '服务器错误:{exc}'.format(exc=exc),
        }, status=response.status_code, exception=True)

    return response

三、设置自定义返回数据结构

这里我是在utils文件夹里面新建了rendererresponse.py文件
这里可以根据你的需求修改、我这个只是参考，解释看注释

'''
自定义返回处理
'''

# 导入控制返回的JSON格式的类
from rest_framework.renderers import JSONRenderer


class customrenderer(JSONRenderer):
    # 重构render方法
    def render(self, data, accepted_media_type=None, renderer_context=None):
        if renderer_context:
          
            #print(renderer_context)
            #print(renderer_context["response"].status_code)

            # 响应的信息，成功和错误的都是这个
            #成功和异常响应的信息，异常信息在前面自定义异常处理中已经处理为{'message': 'error'}这种格式
            #print(data)

            # 如果返回的data为字典
            if isinstance(data, dict):
                #响应信息中有message和code这两个key，则获取响应信息中的message和code，并且将原本data中的这两个key删除，放在自定义响应信息里
                #响应信息中没有则将msg内容改为请求成功 code改为请求的状态码
                msg = data.pop('message', '请求成功')
                code = data.pop('code', renderer_context["response"].status_code)
            #如果不是字典则将msg内容改为请求成功 code改为请求的状态码
            else:
                msg = '请求成功'
                code = renderer_context["response"].status_code

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

请求正确返回格式

请求错误返回格式