【Django Rest Framework优化实践】ResponseResult、异常处理方法详解

Django专栏

• 💖 作者简介：大家好，我是Zeeland，全栈领域优质创作者。
• 📝 CSDN主页：Zeeland🔥
• 📣 我的博客：Zeeland
• 📚 Github主页: Undertone0809 (Zeeland) (github.com)
• 🎉 支持我：点赞👍+收藏⭐️+留言📝
• 📣 系列专栏：django开发手册🍁
• 💬介绍：The mixture of software dev+Iot+ml+anything🔥

Django系列专栏

• 【django开发手册】Django 中使用自定义用户模型：一个比自带 User 更强的选择
• 【django开发手册】如何使用select_related进行一次连表查询
• 【django开发手册】drf通过添加自定义字段优化DRF序列化器，轻松实现高速API
• 【django开发手册】解决admin添加外键下拉显示外键的问题
• 【Django Rest Framework优化实践】ResponseResult、异常处理方法详解
• 【DRF】深度分析枚举类型在DRF中的序列化问题及解决方案
• 【django开发手册】关于django admin添加表信息的时候外键无法为空的问题解决方案
• 【django开发手册】django admin如何显示外键对应的字段
• 【django开发手册】DRF外键模型查询没有信息？教你实现序列化返回

前言

Django Rest Framework（DRF）是一个快速构建Web API的工具包，使用DRF可以轻松地创建RESTful API，实现前后端分离开发。在实际开发中，我们经常需要统一返回结果集、全局异常处理和拦截器等操作，本篇博客将通过代码实现，为大家详细介绍如何优化DRF的ResponseResult类、全局异常处理机制以及拦截器，从而让我们的开发工作更加便捷。

Django Rest Framework优化实践

在Django Rest Framework中，我们经常需要对返回结果集进行统一处理，优化ResponseResult类可以让我们更加方便地进行数据处理。以下是对ResponseResult类进行的优化：

class ResponseCode(Enum):
    SUCCESS = 200
    CREATED = 201
    ACCEPTED = 202
    BAD_REQUEST = 400
    UNAUTHORIZED = 401
    FORBIDDEN = 403
    NOT_FOUND = 404
    SERVER_ERROR = 500


class ResponseData:
    def __init__(self, data, msg=None):
        self.data = data
        self.msg = msg or ResponseMsg.SUCCESS


class ResponseResult:
    """
    增加了一些默认的返回信息和状态码等，在使用ResponseResult类时，代码会更加简洁
    """

    def __init__(self, code=ResponseCode.SUCCESS, data=None, msg=None):
        self.code = code.value
        self.result = ResponseData(data, msg)

    def to_response(self):
        return Response(data={
            'code': self.code,
            'msg': self.result.msg,
            'data': self.result.data,
        })

除了优化ResponseResult类，全局异常处理和拦截器也是我们需要关注的重点。在异常处理方面，我们可以通过以下代码实现：

def custom_exception_handler(exc, context):
    if isinstance(exc, APIException):
        code = exc.status_code
        msg = exc.detail
        data = None
    else:
        code = ResponseCode.SERVER_ERROR
        msg = ResponseMsg.SERVER_ERROR
        data = None
    return ResponseResult(code=code, msg=msg, data=data).to_response()

这段代码将异常处理函数custom_exception_handler注册到DRF配置REST_FRAMEWORK中，用于处理DRF中产生的异常。同时，我们还需要实现一个拦截器，对抛出的异常进行捕获和处理。

class APIError(Exception):
    def __init__(self, code=None, message=None):
        self.code = code or ResponseCode.SERVER_ERROR
        self.message = message or ResponseMsg.SERVER_ERROR


class ErrorInterceptor:
    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        try:
            response = self.get_response(request)
            return response
        except APIError as api_error:
            result = {
                'code': api_error.code.value,
                'msg': api_error.message,
                'data': None,
            }
            return ResponseResult(code=api_error.code, msg=api_error.message, data=None).to_response()

在这段代码中，我们定义了一个异常类APIError和一个拦截器类ErrorInterceptor，用于捕获并处理异常。通过使用这些优化技巧，我们可以更加便捷地开发DRF应用，提高开发效率。

结语

以上便是对Django Rest Framework优化实践的总结，包括优化ResponseResult类、全局异常处理机制以及拦截器的实现方法。希望读者通过本篇博客能够对DRF应用开发有更加深入的了解，在应用开发中更加得心应手。最后，感谢您的阅读，有任何问题欢迎留言交流！