DRF渲染之异常处理

已于 2024-05-17 09:05:19 修改
阅读量743 收藏 14
点赞数 14
文章标签： django
于 2024-05-11 08:45:38 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_58310590/article/details/138697106
版权

异常处理

【1 】引言

Django REST Framework 这个就是我们常常说的DRF

  1. APIView的dispatch方法：
    • 当请求到达视图时，DRF 的 APIView 类会调用 dispatch 方法来处理请求。
    • 在 dispatch 方法中，有一个关键的步骤是处理异常。如果在视图类的方法执行过程中出现了异常，DRF 会捕获这个异常，并调用 self.handle_exception(exc) 方法来处理它。
  2. handle_exception 方法：
    • handle_exception 方法用于处理异常，它首先获取异常处理函数的引用，这个函数的地址存储在配置中，通常是 settings.EXCEPTION_HANDLER。
    • 然后，handle_exception 调用这个异常处理函数，并传入两个参数：异常对象 exc 和上下文 context。
    • 异常处理函数执行后会返回一个响应对象，这个响应对象会在异常发生时返回给客户端。
  3. rest_framework.views.exception_handler 函数：
    • 这个函数是 DRF 提供的默认异常处理函数。它会检查传入的异常是否是 DRF 内置的 exceptions.APIException 类型的异常。
    • 如果是 APIException 类型的异常，这个函数会根据异常类型组装一个响应对象，并返回。
    • 如果异常不是 APIException 类型的，则返回 None，意味着这个异常不是 DRF 能处理的，需要由其他方式处理（比如由 Django 的默认异常处理机制处理）。

​ 总的来说，DRF 的异常处理机制允许你在视图类中捕获并处理异常，并提供了一个灵活的机制来定义和定制异常处理方式。

读APIView源码时，即是三大认证和视图类的方法中出现了异常，都会被try捕获，做全局异常处理：
	 response = self.handle_exception(exc)
    -只要出了异常，都会执行response = self.handle_exception(exc)

image-20240418194631016

     def handle_exception(self, exc):
        # 拿到一个函数内存地址--》配置文件中配置了
        # self.settings.EXCEPTION_HANDLER
        # 拿到这个函数：rest_framework.views.exception_handler
        exception_handler = self.get_exception_handler()
        # 执行这个函数，传入俩参数
        response = exception_handler(exc, context)
        # drf的 Response的对象
        return response
   	-rest_framework.views.exception_handler 逻辑分析
    	-判断异常是不是 drf内 exceptions.APIException的异常
        -如果是--》组装了Response返回了
        -如果不是--》返回了None
        -总结：默认drf只处理了自己的异常，django的异常，它没处理，直接前端能看到

  • 而-handle_exception 源码分析里面的重点则是

  1. 异常类型检查：
    • if isinstance(exc, (exceptions.NotAuthenticated, exceptions.AuthenticationFailed)): 这里检查异常是否是用户未认证或认证失败引起的。
  2. 认证头部信息获取：
    • auth_header = self.get_authenticate_header(self.request): 尝试获取适当的认证头部信息，用于构建响应。
    • if auth_header:: 如果成功获取了认证头部信息，则将其添加到异常对象中，否则将响应状态码设置为 403 Forbidden。
  3. 异常处理程序调用：
    • exception_handler = self.get_exception_handler(): 获取异常处理程序。
    • context = self.get_exception_handler_context(): 获取异常处理上下文。
    • response = exception_handler(exc, context): 将异常对象和上下文传递给异常处理程序，获取处理后的响应。
  4. 响应处理：
    • if response is None:: 如果异常处理程序返回了 None，表示没有提供一个适当的响应，这时会重新引发异常。
    • response.exception = True: 将响应对象的 exception 属性设置为 True，表示这个响应是由异常引起的。
    • return response: 返回处理后的响应。

​ 这些部分共同构成了异常处理器的核心功能，负责捕获、处理异常，并生成适当的响应。

总结：默认drf只处理了自己的异常，django的异常，它没处理，直接前端能看到

【 2 】简单示例

  • urls.py

from three.views import  TeyView
# 自动生成路由
from rest_framework.routers import SimpleRouter, DefaultRouter
from django.urls import path, include

# 2 实例化得到对象
# router = SimpleRouter()
router = DefaultRouter()
# 3 执行对象的方法
router.register('User', UserTokenView, 'User')
urlpatterns = [
    path('try/', TeyView.as_view()),

]
# 5 把自动生成的路由，放到 urlpatterns中
urlpatterns += router.urls

from rest_framework.views import APIView
from rest_framework.exceptions import ValidationError,AuthenticationFailed

class TeyView(APIView):
    def get(self,request):

        # drf的异常
        # 主动抛出异常！！！
        raise ValidationError('校验失败')
        # raise AuthenticationFailed('失败了这么棒！！')

        # # diango的异常
        # res = 9/0
        # return Response('zheng1casd')

image-20240418202914871

【 2 】使用步骤

全局处理，如何使用

  • 写个函数
  • 在函数中处理异常，统一返回格式
  • 在配置文件中配置：只要出了异常，执行我们自己的
  • 写完配置文件
    REST_FRAMEWORK = {
        'EXCEPTION_HANDLER': 'three.exceptions.common_exception_handler',
    }

异常处理函数

​ 创建exceptions.py文件

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


def common_exception_handler(exc, context):
    # 【1】 返回 Response： 说明是drf的一次
    # 【2】 返回None： 就不是drf的异常
    # response.datak可以拿到主体的数据
    response = exception_handler(exc, context)
    if response:
        if isinstance(response.data, dict):
            errors = response.data.get('detail', '系统正在维修，请联系站长')
        elif isinstance(response.data, list):
            errors = response.data[0]
        else:
            errors = r'请重新启动或者打自己一巴掌！！！'
        response = Response({r'code': 444, "msg": f"【drf】:{errors}"})
    else:
        # 获取报错异常的类型
        print(type(exc))
        # <class 'IndexError'>
        if response is not None:
            response.data['0'] = '你是'
        elif isinstance(exc,IndexError):
            response = Response({r'code': 499, "msg": f"IndexError数据不对"})
        else:
            errors = str(exc)
            response = Response({r'code': 404, "msg": f"【django】:{errors}"})
    return response

注意使用这个的前提就是有异常我们可以定义

from rest_framework.views import APIView
from rest_framework.exceptions import ValidationError,AuthenticationFailed,APIException

class TeyView(APIView):
    def get(self,request):

        # drf的异常
        # 主动抛出异常！！！
        # raise APIException('校验失败')
        # raise AuthenticationFailed('失败了这么棒！！')


        # # diango的异常
        # res = 9/0
        a = [1,2,3,4,5,6]
        print(a[9])
        return Response('zheng1casd')
    
    ---------------------------------------
# urls.py
from three.views import  TeyView
# 自动生成路由
from rest_framework.routers import SimpleRouter, DefaultRouter
from django.urls import path, include

# 2 实例化得到对象
# router = SimpleRouter()
router = DefaultRouter()
# 3 执行对象的方法
router.register('User', UserTokenView, 'User')
urlpatterns = [
    path('try/', TeyView.as_view()),

]
# 5 把自动生成的路由，放到 urlpatterns中
urlpatterns += router.urls

【3】自定义异常捕获

class PassException(Exception):
    def __init__(self,msg):
        self.msg=msg

因为这里并不是一个合格的PassException异常但这个是一个ZeroDivisionError所以有了点手段

from .exceptions import PassException
class TeyView(APIView):
    def get(self,request):

        # drf的异常
        # 主动抛出异常！！！
        # raise APIException('校验失败')
        # raise AuthenticationFailed('失败了这么棒！！')

        try:
            # 这里是你可能会出现除零错误的代码
            res = 1 / 0
        except ZeroDivisionError:
            # 捕获除零错误，并抛出 PassException 异常
            raise PassException('4564')

def common_exception_handler(exc, context):
	...
        else:
            ...
    else:
        if isinstance(exc, PassException):  # 检查是否是 PassException
            response = Response({'code': 499, "msg": f"PassException: {exc.msg}"})
	...
    return response

image-20240418213839426

【 4 】加强

 # 日志记录放这里即可:请求方式，请求的地址，客户端ip,用户id，时间

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


class PassException(Exception):
    def __init__(self,msg):
        self.msg=msg

def common_exception_handler(exc, context):
    # 【1】 返回 Response： 说明是drf的一次
    # 【2】 返回None： 就不是drf的异常
    # response.datak可以拿到主体的数据

    request = context.get('request')
    view = context.get('view')  # 哪个视图类出的错
    user_id = request.user.pk or '匿名用户'
    print(
        f'请求方式是：{request.method},请求地址是：{request.get_full_path()},客户端ip：{request.META.get("REMOTE_ADDR")}，用户id：{user_id}')
    print(type(exc))
    response = exception_handler(exc, context)
    if response:
        if isinstance(response.data, dict):
            errors = response.data.get('detail', '系统正在维修，请联系站长')
        elif isinstance(response.data, list):
            errors = response.data[0]
        else:
            errors = r'请重新启动或者打自己一巴掌！！！'
        response = Response({r'code': 444, "msg": f"【drf】:{errors}"})
    else:
        # 获取报错异常的类型
        print(type(exc))
        # <class 'IndexError'>
        if response is not None:
            response.data['0'] = '你是'
        elif isinstance(exc,IndexError):
            response = Response({r'code': 499, "msg": f"IndexError数据不对"})
        elif isinstance(exc,PassException):
            response = Response({r'code': 999, "msg": f"这个是PassException报错"})
        else:
            errors = str(exc)
            response = Response({r'code': 404, "msg": f"【django】:{errors}"})
    return response
  • 最终版本
from rest_framework.views import exception_handler
from rest_framework.response import Response
import logging

class PassException(Exception):
    def __init__(self,msg):
        self.msg=msg

# 创建日志记录器
logger = logging.getLogger(__name__)

def common_exception_handler(exc, context):
    # 【1】 返回 Response： 说明是drf的一次
    # 【2】 返回None： 就不是drf的异常
    # response.data可以拿到主体的数据

    request = context.get('request')
    view = context.get('view')  # 哪个视图类出的错
    user_id = request.user.pk or '匿名用户'
    # 记录请求信息到日志
    # logger.info(
    #     f'请求方式是：{request.method}, 请求地址是：{request.get_full_path()}, 客户端IP：{request.META.get("REMOTE_ADDR")}, 用户ID：{user_id}')
    print(
        f'请求方式是：{request.method},请求地址是：{request.get_full_path()},客户端ip：{request.META.get("REMOTE_ADDR")}，用户id：{user_id}，视图类：{view.__class__.__name__}')
    print(type(exc))
    response = exception_handler(exc, context)
    if response:
        if isinstance(response.data, dict):
            errors = response.data.get('detail', '系统正在维修，请联系站长')
        elif isinstance(response.data, list):
            errors = response.data[0]
        else:
            errors = r'请重新启动或者打自己一巴掌！！！'
        response = Response({r'code': 444, "msg": f"【drf】:{errors}"})
    else:
        # 获取报错异常的类型
        print(type(exc))
        # <class 'IndexError'>
        if response is not None:
            response.data['0'] = '你是'
        elif isinstance(exc,IndexError):
            response = Response({r'code': 499, "msg": f"IndexError数据不对"})
        elif isinstance(exc,PassException):
            response = Response({r'code': 999, "msg": f"这个是PassException报错"})
        else:
            errors = str(exc)
            response = Response({r'code': 404, "msg": f"【django】:{errors}"})
    return response

【 5 】模板

  • 简易版本

# 后期视图的方法，可以写成这种模板
try:
    # 核心逻辑
    if 某个条件不符合:  # 或断言
        raise NoPermissionException
    except NoPermissionException as e:
        # return Response({'code':888,'msg':'错误'})
        raise NoPermissionException('没有权限')
    except AAException as e:
        raise NoPermissionException('没有权限')
        return Response('ok')

  • 加强版本

from rest_framework.response import Response  
from rest_framework.exceptions import PermissionDenied  # 或者您自定义的 NoPermissionException  
from .exceptions import AAException  # 假设 AAException 是您自定义的异常  
  
def my_view(request):  
    try:  
        # 核心逻辑  
        if 某个条件不符合:  # 或断言  
            raise PermissionDenied('没有权限')  # 使用DRF的PermissionDenied异常  
        # 其他逻辑...  
    except PermissionDenied as e:  
        return Response({'code': 888, 'msg': str(e)}, status=403)  # 403 Forbidden  
    except AAException as e:  
        return Response({'code': 999, 'msg': 'AAException 触发的错误'}, status=400)  # 400 Bad Request 或者其他合适的状态码  
    # 其他异常处理...  
    # 视图正常执行完毕后的返回  
    return Response('ok')

m0_58310590
关注
  • 14
    点赞
  • 踩
  • 14
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
python drf基础资料
09-14
python drf基础资料
Django框架之DRF 基于mixins来封装的视图详解
09-19
今天小编就为大家分享一篇Django框架之DRF 基于mixins来封装的视图详解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
DRF学习之全局异常处理、接口文档书写
Xiao20000101的博客
04-23 1143
针对上面的源码，我们也可以自定义异常处理，DRF默认的异常处理，只处理APIException及其子类的异常，处理不了的会返回None，我们可以判断异常是否属于APIException及其子类的异常，如果是则返回错误信息，如果不是，那么我们则返回服务器错误。自定义异常处理'''需求：0 执行原来的exception_handler判断返回值是否为 None：如果是None，说明是非drf异常，自己包装一个Response如果不是None，说明是drf异常，包装一个Response。
drf框架之小总结
Allen
02-24 383
文章目录drf框架之小总结APIView的请求生命周期序列化组件一、视图类中使用序列化二、Meta配置类中的配置三、自定义校验规则四、入库方法五、自定义字段六、如果有群改操作==序列化重(难)点==：视图家族两个基类：工具类：工具视图类：视图集：路由组件：SimpleRouter权限认证 drf框架之小总结 APIView的请求生命周期 as_view()：路由配置，禁用csrf dispatch...
DRF框架之安装、接口
Allen
02-17 452
文章目录DRF框架之安装、接口接口开发阶段接口测试工具接口文档接口规范FBV => CBV：Function|Class Base ViewDRF框架的基础视图类DRF框架的安装案例：实现单查群查接口补充pip安装源永久配置安装源windowsMacOS、Linux DRF框架之安装、接口 接口(api)： 什么是接口 接口文档 接口规范 FBV => CBV：Function...
DRF之异常捕获源码分析
Chimengmeng的博客
09-19 129
【一】异常捕获介绍 Django Rest Framework(DRF)是一个用于构建Web API的强大框架，它提供了一种处理异常的机制，使开发人员能够捕获和处理各种异常情况。 DRF中的异常捕获类是用于捕获和处理这些异常的关键组件之一。 【二】异常捕获流程分析 # 全局异常处理 # 'EXCEPTION_HANDLER': 'rest_framework.views.exception_...
六、DRF框架APIView--request&response解析器&渲染器
喵酱
05-26 1019
APIView介绍：1、视图类，继承APIView2、.具备View的所有特性3、.提供了认证、授权、限流功能。
DRF学习之DRF初识
Xiao20000101的博客
04-21 779
*DRF （ Django REST framework）**是一个用于构建 Web API 的强大且灵活的工具包，基于 Django Web 框架。DRF 提供了一组用于快速开发 Web API 的工具和功能，使得构建 RESTful API 变得简单和高效。也使后端开发人员更方便的编写API接口。DRF 的设计理念是使构建 Web API 变得简单、快速且易于维护。它与 Django 框架紧密集成，为开发者提供了丰富的功能和工具，使得构建强大的 RESTful API 成为可能。
Django捕获所有异常的处理
Small_White
06-01 7803
诚然，每个人都会写bug，程序抛异常是一件很正常的事；既然异常总是会抛，那就想办法在抛出后，尽早解决才是王道。就拿Django来说，通常发生未知异常时，我们会将settings里的DEBUG=False改为True，然后盯着日志看。可谁没事老盯着日志看啊，未免也太浪费时间了；不能老是等待用户反馈异常和问题，万一用户懒得反馈了，岂不很尴尬。 需求：在异常发生时，进行异常埋点，接入开源平台Cat. 本篇是【Sentry部署+DingDing告警+Django接入】的兄弟篇，感兴趣可以了解下。 思路.
Django框架之DRF框架
克里斯蒂亚诺
11-22 2668
一、前言 1、Web应用模式 2、RESTful API规范 二、简介 二、安装与配置 三、序列化器 1、创建序列化器 2、序列化操作 1）序列化过程 2）反序列化过程 3、校验规则 1）单表字段校验 2）关联字段校验 4、优化serializer.save() 5、to_internal_value 6、to_representation 四、模型序列化器类 1、定义模型序列化器类 2、修改部分字段方法 3、模型器类重写creat/update 五、视图层views 1、APIView渲染器 2、解析器
DRF向导之请求和响应
SCUhzs
09-26 277
src 从本节我们开始真正接触rest framework的核心部分。首先我们学习一下一些必备知识。 1. Request Object ——Request对象 ​ rest framework 引入了一个继承自HttpRequest的Request对象，该对象提供了对请求的更灵活解析。request对象的核心部分是request.DATA属性，类似于request.POST, 但在使用WE...
DRF 过滤排序分页异常处理.doc
07-12
DRF 过滤排序分页异常处理.doc
DRF跨域后端解决之django-cors-headers的使用
09-19
主要介绍了DRF跨域后端解决之django-cors-headers的使用，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
学习DRF
02-25
学习DRF
基于Django的电商购物项目通过网络爬虫技术以及ORM框架获取项目商品数据
最新发布
xiugtt6141121的博客
05-16 128
这里先提供源码 , 具体思路下一期再进行解释。
Django接口卡死一直没有返回响应
Dxy1239310216的博客
05-16 534
如果接口涉及到数据库操作，可能是数据库查询导致了阻塞。检查数据库连接是否正常，以及是否有任何长时间运行的查询或锁定的表。当Django接口出现卡死且没有返回响应时，可能是由于多种原因导致的。首先检查Django的日志，看看是否有任何错误或异常被记录。这可以帮助你确定问题的根源。
基于Django的图书管理系统
m0_46657126的博客
05-15 288
本网站调用Django编写了图书管理网站，可以在后端控制书籍，前端进行书籍预览项目基于python+django+mysql进行开发。
Django视图Views
Kongfutu的博客
05-15 929
2.2)错误视图(4xx,5xX）(HttpResponseNotFound,HttpResponseForbidden,HttpResponseNotAllowed等)get_full_path（） 返回包含参数字符串的请求路径．。status code 响应状态码（2xx，3xx,4xx, 5xx）1）不使用模板，直接调用HttpResponse（），返回HttpResponse对象。POST 类似字典的参数，包含了post所有参数。GET 类似字典的参数，包含了get的所有参数。
drf序列化处理create返回错误信息
03-23
对于这个问题，我可以提供一些可能的解决方案。...最后，您可以检查您的视图函数中的错误处理代码是否正确。如果这些方法都不能解决问题，您可以考虑查看Django REST framework的文档或寻求社区的帮助。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值