寫在前面
這兩天一直在思索關(guān)于 DRF 還有哪些是項(xiàng)目必備的而且還沒有說到的基礎(chǔ)性的知識(shí)。這不昨天寫到日志相關(guān)的功能就直接想到還有異常處理相關(guān)的功能，其實(shí)在之前項(xiàng)目中初期是沒有統(tǒng)一的異常捕獲手段。可能是 DRF 自帶的異常 能滿足大多數(shù)功能，也可能是比較懶，就使用比較粗暴的方式，以狀態(tài)碼 500 的方式去拋出異常，然后在日志中可以看到所有的異常信息。這么做呢，代碼其實(shí)是不夠健壯的，前端在調(diào)用的時(shí)候莫名的 500 也是不夠友好的，所以今天就補(bǔ)充一下異常相關(guān)的知識(shí)。
DRF異常處理
1. DRF 常見的異常
- AuthenticationFailed/ NotAuthenticated 一般該異常狀態(tài)碼為"401 Unauthenticated"，主要是沒有登錄鑒權(quán)的時(shí)候會(huì)返回，可以用在自定義登錄的時(shí)候。
- PermissionDenied 一般用在鑒權(quán)時(shí)候使用，一般狀態(tài)碼為"403 Forbidden"。
- ValidationError 一般狀態(tài)碼為"400 Bad Request"，主要是 serializers 中對字段的校驗(yàn)，比如對字段類型的校驗(yàn)、字段長度的校驗(yàn)以及自定義字段格式的校驗(yàn)。
2. 自定義異常
這里對異常的定義主要的想法來自 ValidationError，統(tǒng)一異常返回的格式，方便前端統(tǒng)一處理類似異常。
自定義異常
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
# 新建 utils/custom_exception.pyclass CustomException(Exception): _default_code = 400 def __init__( self, message: str = "", status_code=status.HTTP_400_BAD_REQUEST, data=None, code: int = _default_code, ): self.code = code self.status = status_code self.message = message if data is None: self.data = {"detail": message} else: self.data = data def __str__(self): return self.message |
自定義異常處理
|
1
2
3
4
5
6
7
8
9
10
11
12
|
# utils/custom_exception.pydef custom_exception_handler(exc, context): # Call REST framework's default exception handler first, # to get the standard error response. # 這里對自定義的 CustomException 直接返回，保證系統(tǒng)其他異常不受影響 if isinstance(exc, CustomException): return Response(data=exc.data, status=exc.status) response = exception_handler(exc, context) return response |
配置自定義異常處理類
|
1
2
3
4
|
REST_FRAMEWORK = { # ... "EXCEPTION_HANDLER": "utils.custom_exception.custom_exception_handler",} |
3. 使用自定義異常
使用之前文章的接口用來測試自定義異常的處理
|
1
2
3
4
5
6
7
8
9
10
11
12
|
class ArticleViewSet(viewsets.ModelViewSet): """ 允許用戶查看或編輯的API路徑。 """ queryset = Article.objects.all() serializer_class = ArticleSerializer @action(detail=False, methods=["get"], url_name="exception", url_path="exception") def exception(self, request, *args, **kwargs): # 日志使用 demo logger.error("自定義異常") raise CustomException(data={"detail": "自定義異常"}) |
4. 驗(yàn)證結(jié)果
|
1
2
3
4
|
$ curl -H 'Accept: application/json; indent=4' -u admin:admin http://127.0.0.1:8000/api/article/exception/{ "detail": "自定義異常"} |
異常處理進(jìn)階
上面的代碼雖說是可以滿足90%的需求，但是錯(cuò)誤的定義太泛泛。難以集中定義管理錯(cuò)誤，與常見項(xiàng)目中自定義的異常比較優(yōu)點(diǎn)就是靈活，但是隨著代碼中拋出的異常越來越多加之散落在各個(gè)角落，不利于更新維護(hù)。所以下面對修改一下代碼，對異常有統(tǒng)一的定義，同時(shí)也支持自定義返回HTTP狀態(tài)碼。
1. 修改自定義異常
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
# utils/custom_exception.pyclass CustomException(Exception): # 自定義code default_code = 400 # 自定義 message default_message = None def __init__( self, status_code=status.HTTP_400_BAD_REQUEST, code: int = None, message: str = None, data=None, ): self.status = status_code self.code = self.default_code if code is None else code self.message = self.default_message if message is None else message if data is None: self.data = {"detail": self.message, "code": self.code} else: self.data = data def __str__(self): return str(self.code) + self.message |
2. 自定義更多異常
|
1
2
3
4
5
6
7
8
9
10
|
class ExecuteError(CustomException): """執(zhí)行出錯(cuò)""" default_code = 500 default_message = "執(zhí)行出錯(cuò)"class UnKnowError(CustomException): """執(zhí)行出錯(cuò)""" default_code = 500 default_message = "未知出錯(cuò)" |
3. 新增測試接口
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
class ArticleViewSet(viewsets.ModelViewSet): """ 允許用戶查看或編輯的API路徑。 """ queryset = Article.objects.all() serializer_class = ArticleSerializer @action(detail=False, methods=["get"], url_name="exception", url_path="exception") def exception(self, request, *args, **kwargs): # 日志使用 demo logger.error("自定義異常") raise CustomException(data={"detail": "自定義異常"}) @action(detail=False, methods=["get"], url_name="unknown", url_path="unknown") def unknown(self, request, *args, **kwargs): # 日志使用 demo logger.error("未知錯(cuò)誤") raise UnknownError() @action(detail=False, methods=["get"], url_name="execute", url_path="execute") def execute(self, request, *args, **kwargs): # 日志使用 demo logger.error("執(zhí)行錯(cuò)誤") raise ExecuteError() |
4. 驗(yàn)證結(jié)果
|
1
2
3
4
5
6
7
8
9
10
|
curl -H 'Accept: application/json; indent=4' -u admin:admin http://127.0.0.1:8000/api/article/unknown/{ "detail": "未知出錯(cuò)", "code": 500}$ curl -H 'Accept: application/json; indent=4' -u admin:admin http://127.0.0.1:8000/api/article/execute/{ "detail": "執(zhí)行出錯(cuò)", "code": 500} |
總結(jié)
需要注意自定義的異常處理函數(shù)需要在處理完成自定義異常后繼續(xù)執(zhí)行 rest_framework.views.exception_handler，因?yàn)檫@里的執(zhí)行仍然需要兼容已有的異常處理；下面貼一下 DRF 有關(guān)的異常處理邏輯。
該處理函數(shù)默認(rèn)處理 APIException以及 Django 內(nèi)部的 Http404 PermissionDenied，其他的異常會(huì)返回 None ，會(huì)觸發(fā) DRF 500 的錯(cuò)誤。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
def exception_handler(exc, context): """ Returns the response that should be used for any given exception. By default we handle the REST framework `APIException`, and also Django's built-in `Http404` and `PermissionDenied` exceptions. Any unhandled exceptions may return `None`, which will cause a 500 error to be raised. """ if isinstance(exc, Http404): exc = exceptions.NotFound() elif isinstance(exc, PermissionDenied): exc = exceptions.PermissionDenied() if isinstance(exc, exceptions.APIException): headers = {} if getattr(exc, 'auth_header', None): headers['WWW-Authenticate'] = exc.auth_header if getattr(exc, 'wait', None): headers['Retry-After'] = '%d' % exc.wait if isinstance(exc.detail, (list, dict)): data = exc.detail else: data = {'detail': exc.detail} set_rollback() return Response(data, status=exc.status_code, headers=headers) return None |
參考資料
Django REST framework 異常文檔
Django 異常文檔
到此這篇關(guān)于Django REST framework 異常處理的文章就介紹到這了,更多相關(guān)Django REST framework 異常內(nèi)容請搜索服務(wù)器之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持服務(wù)器之家！
原文鏈接：https://juejin.cn/post/6976496971368366116
