Django REST 异常处理详解


Posted in Python onJuly 15, 2020

异常

异常处理…允许错误处理在程序结构的中心或者高层级的地方被清晰有条理的组织起来。

Exceptions… allow error handling to be organized cleanly in a central or high-level place within the program structure. — Doug Hellmann, Python Exception Handling Techniques

Rest框架视图中的异常处理

Exception handling in REST framework views

REST框架的视图处理了各种异常,并正确地返回了错误响应。

REST framework's views handle various exceptions, and deal with returning appropriate error responses.

被处理的异常有:

Rest框架内部抛出的APIException的子类。

Django的Http404异常。

Django的PermissionDenied异常

针对每种情况,REST框架将返回一个包含了正确的状态码和content-type的响应。响应体包含了任何关于错误本身的额外细节。

大部分的错误响应将在响应体中包含了一个detail的键。

例如下面请求:

DELETE http://api.example.com/foo/bar HTTP/1.1

Accept: application/json

你还可能接收到一个错误响应,表明对该资源DELETE方法不允许的。

HTTP/1.1 405 Method Not Allowed
Content-Type: application/json
Content-Length: 42

{"detail": "Method 'DELETE' not allowed."}

校验错误的处理有些轻微的不同,它会把字段的名字作为键包含进来。如果校验错误没有被指定到一个特定的字段,那么它会使用non_field_errors作为键,或者是你在setting文件中设定的NON_FIELD_ERRORS_KEY任意字符串的值。

任何校验错误将类似下面的形式:

HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 94

{"amount": ["A valid integer is required."], "description": ["This field may not be blank."]}

自定义异常处理

你可以实现你的自定义异常处理。可以通过创建一个异常处理函数将API视图中抛出的异常转换成响应对象。这样一来,你就可以控制你的API使用的错误响应格式。

这个异常处理函数必须传入两个参数,第一个是要处理的异常,第二个是一个包含了任何额外上下文信息(例如当前被处理的视图)的字典。该异常处理函数要么返回一个Response对象,要么在异常无法处理的时候返回None。如果返回了None,异常将会被重新抛出,最后Django会返回一个标准的HTTP 500 ‘服务器错误'的响应。

例如,你可能希望保证所有的错误响应体中都包含了HTTP状态码,像这样:

HTTP/1.1 405 Method Not Allowed
Content-Type: application/json
Content-Length: 62

{"status_code": 405, "detail": "Method 'DELETE' not allowed."}

为了更改响应的格式,你可以编写如下的自定义异常处理函数:

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.
 response = exception_handler(exc, context)

 # Now add the HTTP status code to the response.
 if response is not None:
 response.data['status_code'] = response.status_code

 return response

参数context没有被默认的异常处理器使用,但是如果你需要更多的信息,例如你想获得当前被处理的视图,它就能给你援助之手了。通过context['view']就可以获取当前视图。

同时你必须在你的settings中配置异常处理器,显式地给EXCEPTION_HANDLER设置你期望的值,例如:

REST_FRAMEWORK = {
 'EXCEPTION_HANDLER': 'my_project.my_app.utils.custom_exception_handler'
}

如果没有指定,'EXCEPTION_HANDLER‘默认使用的是REST框架提供的标准的异常处理器:

REST_FRAMEWORK = {
 'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
}

注意一点,异常处理器仅仅在响应是由抛出的异常产生时被调用。如果由视图直接返回的响应,它将不会被调用,例如HTTP_400_BAD_REQUEST响应是在序列化校验失败时由generic视图返回的,此时异常处理器就不会被调用。

API 引用

APIException

Signature: APIException()

所有在APIView类中或者@api_view抛出的异常的基类。

为了提供自定义异常,自定义个类,继承自APIException,并设置.status_code和.default_detail属性。

例如,如果你的API依赖第三方服务,这个服务有时候可能会不可用,你或许可以考虑为”503 Service Unavailable”HTTP响应码实现一个异常类,你可以这么做:

from rest_framework.exceptions import APIException

class ServiceUnavailable(APIException):
 status_code = 503
 default_detail = 'Service temporarily unavailable, try again later.'

ParseError

Signature: ParseError(detail=None)

在访问request.data的时候,如果请求包含了非法的数据,就会抛出该错误。

默认,该异常返回”400 Bad Request”状态码。

AuthenticationFailed

Signature: AuthenticationFailed(detail=None)

当请求包含了错误的认证信息的时候抛出。

Raised when an incoming request includes incorrect authentication.

默认情况下,该异常返回401 Unauthenticated,但是也有可能返回403 Forbidden,这取决于使用的认证模式。详细内容参考authentication documentation

NotAuthenticated

Signature: NotAuthenticated(detail=None)

当未认证的请求权限验证失败时抛出。

默认情况下,该异常返回401 Unauthenticated,但是也有可能返回403 Forbidden,这取决于使用的认证模式。详细内容参考authentication documentation

PermissionDenied

Signature: PermissionDenied(detail=None)

当一个经认证的请求在权限校验失败时抛出。

默认返回403 Forbidden

NotFound

Signature: NotFound(detail=None)

当给定的URL不存在时抛出。该异常等效于标准的DjangoHttp404异常。

默认返回404 Not Found.

MethodNotAllowed

Signature: MethodNotAllowed(method, detail=None)

在视图中没有与请求匹配的处理方法时抛出。

默认返回405 Method Not Allowed

NotAcceptable

Signature: NotAcceptable(detail=None)

当请求的接受头不满足任何可用的渲染器时抛出。

默认返回406 Not Acceptable

UnsupportedMediaType

Signature: UnsupportedMediaType(media_type, detail=None)

当访问request.data时,没有解析器来处理请求数据的内容类型时抛出。

默认返回415 Unsupported Media Type

Throttled

Signature: Throttled(wait=None, detail=None)

当请求超过最大限制时抛出。

默认返回429 Too Many Requests

ValidationError

Signature: ValidationError(detail)

ValidationError跟其他的APIException类稍微有些不同:

The ValidationError exception is slightly different from the other APIException classes:

detail参数是强制的,非可选。

detail参数可以是错误细节的列表或者字典,也可以是一个内嵌的数据结构。

约定中,你应该导入序列化器模块并使用完整描述的ValidationError格式,这是为了跟Django的内置检验错误区分开来。例如.raise serializers.ValidationError('This field must be an integer value.')

ValidationError类应该通过验证器类为序列化器和字段校验使用。它也会在调用serializer.is_valid方法,并指定了raise_exception时被抛出。

serializer.is_valid(raise_exception=True)

在generic视图中使用raise_exception=True标记,意味着你可以在你的API中全局复写校验错误响应的格式。如果你要这么做,建议你使用一个自定义的异常,上文有描述。

默认情况下,该异常返回400 Bad Request

更多阅读官方原文链接

以上这篇Django REST 异常处理详解就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python中的__SLOTS__属性使用示例
Feb 18 Python
Python中用Decorator来简化元编程的教程
Apr 13 Python
python获取外网IP并发邮件的实现方法
Oct 01 Python
python实现校园网自动登录的示例讲解
Apr 22 Python
详解Python中的type和object
Aug 15 Python
零基础使用Python读写处理Excel表格的方法
May 02 Python
python选取特定列 pandas iloc,loc,icol的使用详解(列切片及行切片)
Aug 06 Python
Python操作Excel工作簿的示例代码(\*.xlsx)
Mar 23 Python
python opencv 实现读取、显示、写入图像的方法
Jun 08 Python
pytorch VGG11识别cifar10数据集(训练+预测单张输入图片操作)
Jun 24 Python
python解释器安装教程的方法步骤
Jul 02 Python
Python .py生成.pyd文件并打包.exe 的注意事项说明
Mar 04 Python
使用OpenCV实现道路车辆计数的使用方法
Jul 15 #Python
django restframework serializer 增加自定义字段操作
Jul 15 #Python
浅谈django不使用restframework自定义接口与使用的区别
Jul 15 #Python
浅析Python 条件控制语句
Jul 15 #Python
python中如何设置代码自动提示
Jul 15 #Python
PyTorch实现重写/改写Dataset并载入Dataloader
Jul 14 #Python
python实现将中文日期转换为数字日期
Jul 14 #Python
You might like
PHP模板引擎Smarty内建函数详解
2016/04/11 PHP
PHP7多线程搭建教程
2017/04/21 PHP
javascript脚本编程解决考试分数统计问题
2008/10/18 Javascript
javaScript parseInt字符转化为数字函数使用小结
2009/11/05 Javascript
Bootstrap每天必学之弹出框(Popover)插件
2016/04/25 Javascript
JQuery 的跨域方法推荐_可跨任何网站
2016/05/18 Javascript
jQuery动态生成Bootstrap表格
2016/11/01 Javascript
如何防止INPUT按回车自动提交表单FORM
2016/12/06 Javascript
javascript中apply/call和bind的使用
2017/02/15 Javascript
关于页面刷新vuex数据消失问题解决方案
2017/07/03 Javascript
JS闭包的几种常见形式实例详解
2017/09/16 Javascript
小程序测试后台服务的方法(ngrok)
2019/03/08 Javascript
vue 弹窗时 监听手机返回键关闭弹窗功能(页面不跳转)
2019/05/10 Javascript
Vue向后台传数组数据,springboot接收vue传的数组数据实例
2020/11/12 Javascript
Python中对列表排序实例
2015/01/04 Python
Python中的多重装饰器
2015/04/11 Python
在Python中输入一个以空格为间隔的数组方法
2018/11/13 Python
将pip源更换到国内镜像的详细步骤
2019/04/07 Python
python列表推导式入门学习解析
2019/12/02 Python
python 使用cx-freeze打包程序的实现
2020/03/14 Python
如何用 Python 制作 GitHub 消息助手
2021/02/20 Python
CSS3实现闪烁动画效果的方法
2015/02/09 HTML / CSS
HTML5 canvas 基本语法
2009/08/26 HTML / CSS
Nuts.com:优质散装,批发坚果、干果和巧克力等
2017/03/21 全球购物
英国经典球衣网站:Classic Football Shirts
2017/05/20 全球购物
洛杉矶生活休闲而精致的基础品牌:Mika Jaymes
2018/01/07 全球购物
国际礼品店:GiftsnIdeas
2018/05/03 全球购物
Shell如何接收变量输入
2012/09/24 面试题
优秀的2014年两会精神解读
2014/03/17 职场文书
大学生党员自我评价范文
2014/04/09 职场文书
文明美德伴我成长演讲稿
2014/05/12 职场文书
小学校园之星事迹材料
2014/05/16 职场文书
派出所所长先进事迹
2014/05/19 职场文书
春秋淹城导游词
2015/02/11 职场文书
MySQL中InnoDB存储引擎的锁的基本使用教程
2021/05/26 MySQL
利用Python实现模拟登录知乎
2022/05/25 Python