博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Django-restframework 之 Exceptions分析
阅读量:6969 次
发布时间:2019-06-27

本文共 4906 字,大约阅读时间需要 16 分钟。

废话不多说,且看分析

一般在程序最外层统一对异常进行处理

一、Exceptions

1.REST框架中视图中异常处理

视图处理不同的异常,然后返回合适的异常响应。

处理的异常包括:
- REST内部抛出的APIException的子类
- Django’s Http404异常
- Django’s PermissionDenied异常
在每一个情况中,REST框架都会返回带有合适状态码和content-type的对象。响应主体包括关于错误的附加详细信息,大多数错误响应对象主体都包含一个‘detail’

DELETE http://api.example.com/foo/bar HTTP/1.1Accept: application/json# 接收到的错误信息可能为HTTP/1.1 405 Method Not AllowedContent-Type: application/jsonContent-Length: 42{"detail": "Method 'DELETE' not allowed."}

数据验证错误有部分地方不同,response将会包含字段的名字.如果验证错误没有指定一个特别的字段,将会使用‘non_field_errors’键,或者无论什么字符串都会被设置为NON_FIELD_ERRORS_KEY的值

# 验证错误返回信息HTTP/1.1 400 Bad RequestContent-Type: application/jsonContent-Length: 94{"amount": ["A valid integer is required."], "description": ["This field may not be blank."]}

2.自定义异常处理

您可以通过创建一个处理程序函数来实现定制的异常处理,该函数可以将API视图中出现的异常转换为响应对象。这允许您控制API所使用的错误响应的样式。

该函数必须接受一对参数,第一个是要处理的异常,第二个是包含任何额外上下文的字典,例如当前正在处理的视图。异常处理函数要么返回响应对象,要么返回Response,如果异常不能处理,就返回None。如果处理程序返回None,那么异常将被重新提高,而Django将返回一个标准的HTTP 500“server error”响应。

HTTP/1.1 405 Method Not AllowedContent-Type: application/jsonContent-Length: 62{"status_code": 405, "detail": "Method 'DELETE' not allowed."}

为了改变响应对象的样式,可以自定义一个异常处理函数:

from rest_framework.views import exception_handlerdef custom_exception_handler(exc, context):    # Call REST framework's default exception handler first,    # to get the standard error response.    # 调用REST异常处理函数,获得标准的异常响应对象    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’]),则可能有用。

异常处理函数也必须在设置文件中配置:

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

如果没有指定’EXCEPTION_HANDLER’,默认由REST的标准异常处理。

注意:异常处理只会处理通过raise抛出的异常。努会处理由视图直接返回的异常响应,例如HTTP_400_BAD_REQUEST响应。因为其是验证失败后,由通用视图直接返回的。

二、接口指南

1.APIException

所有APIView和 @api_view内部抛出的异常基类

为了提供一个自定义的异常,需要:
1. 继承APIException
2. 设置.status_code,.default_detail,default_code属性。
比如说有时,你的API依靠的第三方服务无法使用时,需要实现一个 “503 Service Unavailable” HTTP异常:

from rest_framework.exceptions import APIExceptionclass ServiceUnavailable(APIException):    status_code = 503    default_detail = 'Service temporarily unavailable, try again later.'    default_code = 'service_unavailable'
  1. 检查API异常
    有大量属性可以检查API异常的状态。可以使用它们为项目建立一个自定义的异常处理程序。
    需要的属性和方法有:
    • .detail:返回错误的文本描述信息
    • .get_codes():返回错误代码的标识符
    • .get_full_details(),返回文本描述和代码标识符
      在大多数情况下,错误的详细信息 detail 比较简单

    print(exc.detail)

    You do not have permission to perform this action.
    print(exc.get_codes())
    permission_denied
    print(exc.get_full_details())
    {'message':'You do not have permission to perform this action.','code':'permission_denied'}

在验证错误中,错误的detail要么是一个列表,要么是一个字典

>>> print(exc.detail){"name":"This field is required.","age":"A valid integer is required."}>>> print(exc.get_codes()){"name":"required","age":"invalid"}>>> print(exc.get_full_details()){"name":{"message":"This field is required.","code":"required"},"age":{"message":"A valid integer is required.","code":"invalid"}}

2. ParseError

Signature: ParseError(detail=None, code=None)

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

默认情况下,这个异常会生成一个状态码为“400 Bad Request”的响应。

3. AuthenticationFailed

Signature: AuthenticationFailed(detail=None, code=None)

当接受到的请求包含不正确的认证信息时抛出。

默认情况下,这个异常会生成状态码为“401 Unauthenticated”的响应,但是它也可能生成“403 Forbidden”响应,这取决于使用的身份验证方案。

4. NotAuthenticated

Signature: NotAuthenticated(detail=None, code=None)

当一个未认证请求在进行权限检查时抛出。

默认情况下,这个异常会生成状态码为“401 Unauthenticated”的响应,但是它也可能生成“403 Forbidden”响应,这取决于使用的身份验证方案。

5.PermissionDenied

Signature: PermissionDenied(detail=None, code=None)

认证请求进行权限检查失败后抛出。

默认情况下生成状态码为”403 Forbidden”的响应对象。

6.NotFound

Signature: NotFound(detail=None, code=None)

当一个资源不在给定的url中抛出,和django中的Http404异常等价。

默认情况下响应状态码为 “404 Not Found”

7.MethodNotAllowed

Signature: MethodNotAllowed(method, detail=None, code=None)

当传入请求发生时,不会映射到视图上的处理程序方法。

默认情况下,这个异常会生成HTTP状态码为 “405 Method Not Allowed”的响应。

8. NotAcceptable

Signature: NotAcceptable(detail=None, code=None)

当传入请求中的Accept请求头不被任何可用的renderer满足时抛出,默认生成的响应对象状态码为”406 Not Acceptable”

9.UnsupportedMediaType

Signature: UnsupportedMediaType(media_type, detail=None, code=None)

如果没有合适的parser用于解析请求的content type类型时抛出

默认生成的响应对象状态码为”415 Unsupported Media Type”

10.Throttled

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

在限流检查失败后抛出

默认生成的响应对象状态码为”429 Too Many Requests”

11.ValidationError

Signature: ValidationError(detail, code=None)

验证错误与其他APIException异常的区别:

- detail:必须有,列表或者字典,或者嵌套的数据结构
一般需要导入ValidationError,例如raise serializers.ValidationError(‘This field must be an integer value.’)
ValidationError应该被用于序列化或者字段验证中。也会被serializer.is_valid()的raise_exception调用。

serializer.is_valid(raise_exception=True)

在通用视图中使用raise_exception=True,意味着你可以重写API接口中的全局验证错误响应对象。为此,你需要使用自定义的异常处理。

默认生成的响应对象状态码为”400 Bad Request”

转载于:https://www.cnblogs.com/opensars/p/9492146.html

你可能感兴趣的文章
详解zabbix安装部署(Server端篇)
查看>>
阿里云负载不支持 WebSocket 协议与 WSS 和 Nginx 配置问题
查看>>
获取Android屏幕尺寸、控件尺寸、状态栏/通知栏高度、导航栏高度
查看>>
Android开之在非UI线程中更新UI
查看>>
redis分布式锁小试
查看>>
007 爬虫(Scrapy库的使用)
查看>>
014——VUE中v-if语法在网站注册中的实际应用
查看>>
docker常用命令
查看>>
vlan与交换机端口模式Access,Hybrid,Trunk
查看>>
Skyline开发3-没有注册类0x80040154
查看>>
CentOS6.5 添加开机自启动脚本
查看>>
使用 Python SimpleHTTPServer 快速共享文件
查看>>
Google SEO信息年终总结
查看>>
Windows不能用鼠标双击运行jar文件怎么办?
查看>>
数据库中IN和EXISTS的区别
查看>>
3.11 程序改错
查看>>
Python基本数据类型详细介绍(转)
查看>>
自动调整linux系统时间和时区与Internet时间同步
查看>>
Spring Boot启动流程详解(一)
查看>>
接口数据一致性校验工具
查看>>