您好,登錄后才能下訂單哦!
小編給大家分享一下如何使用Django與DRF實(shí)現(xiàn)全局異常處理方案,相信大部分人都還不怎么了解,因此分享這篇文章給大家參考一下,希望大家閱讀完這篇文章后大有收獲,下面讓我們一起去了解一下吧!
如果沒(méi)有 DRF,我們只需要在 Django 中加一個(gè)中間件就可以解決全局異常的處理問(wèn)題,但是 DRF 會(huì)幫我們處理一些異常并自動(dòng)返回到客戶端,因此我們要協(xié)調(diào)兩者的異常處理策略。
同時(shí)我們希望能使用 Django 的 admin 進(jìn)行一些后臺(tái)的數(shù)據(jù)查看和修改,因此最好要保留 admin 的內(nèi)部異常處理行為。
本文的目標(biāo)如下:
保留 Django 自帶的 admin 的異常處理行為
攔截 DRF 的異常并進(jìn)行全局異常行為處理
攔截除 DRF 的異常之外的其他 Django 異常并進(jìn)行全局異常行為處理
首先 DRF 的異常都是繼承自 APIException
這個(gè)類的,并且 DRF 跑出的異常會(huì)被 exception_handler
這個(gè)異常處理函數(shù)攔截(這個(gè)函數(shù)的位置在 /python3.7/site-packages/rest_framework/views.py
中)。
我們進(jìn)一步查看這個(gè)函數(shù)的源碼:
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
通過(guò)這個(gè)函數(shù)的文檔簽名我們知道,DRF 會(huì)處理所有繼承自 APIException
的異常類,并且還會(huì)額外的處理 Django 內(nèi)置的 Http404
和 PermissionDenied
異常,并將這些異常的處理結(jié)果返回到前臺(tái)。
如果不再這些處理范圍之內(nèi),函數(shù)會(huì)返回 None
,這時(shí)候會(huì)給 Django 拋出一個(gè) 500 的服務(wù)器錯(cuò)誤異常。
DRF 支持單獨(dú)配置異常處理函數(shù),因此第一步現(xiàn)在 setting 中指定自定義的異常處理函數(shù)的位置:
REST_FRAMEWORK = { 'EXCEPTION_HANDLER': 'server.exception.exception_globe.globe_exception_handler' }
然后我們定義自己的異常處理程序:
第一步,調(diào)用 DRF 自己的異常處理函數(shù)第二步,對(duì) DRF 攔截的異常進(jìn)行處理第三步,將其他異常拋給 Django 處理
def globe_exception_handler(exc, context): """ Below is the global exception handler of drf Http404 / PermissionDenied / APIException """ # Call REST framework's default exception handler response = exception_handler(exc, context) request = context['request'] # Exceptions form DRF and Django built-in `Http404` and `PermissionDenied` if response is not None: if isinstance(response.data, list): msg = '; '.join(response.data) elif isinstance(response.data, str): msg = response.data else: msg = 'Sorry, we make a mistake (* ̄︶ ̄)!' ex_data = { "msg": msg, "error_code": 1000, "request": request.path } return JsonResponse(data=ex_data, status=response.status_code) # Exceptions from others # 如果 response 為 None 則直接觸發(fā)上面的 ExceptionGlobeMiddleware return response
從上一步的結(jié)果我們知道,DRF 處理不了的異常我們拋給了 Django,而 Django 支持通過(guò)定義中間件進(jìn)行全局異常處理,因此接下來(lái)我們只需要定一個(gè) Django 全局異常處理的中間件,并將中間件配置到 setting 文件中的 MIDDLEWARE 數(shù)組即可。
try: from django.utils.deprecation import MiddlewareMixin # Django 1.10.x except ImportError: MiddlewareMixin = object # Django 1.4.x - Django 1.9.x class ExceptionGlobeMiddleware(MiddlewareMixin): """ Below is the global exception handler of django """ def process_exception(self, request, exception): # 直接拋出 django admin 的異常 if str(request.path).startswith('/admin/'): return None # 捕獲其他異常,直接返回 500 ex_data = { "msg": "Sorry, we make a mistake (* ̄︶ ̄)!", "error_code": 1000, "request": request.path } return JsonResponse(data=ex_data, status=500)
值得注意的是,我們可以在中間件的處理函數(shù)中拿到 request
對(duì)象,因此,我們可以通過(guò)這個(gè)對(duì)象拿到用戶請(qǐng)求的 url,這樣,我們通過(guò)判斷 url 就可以得到那些請(qǐng)求是來(lái)自 Django 自帶的 admin 的。
參考代碼如下:
# 直接拋出 django admin 的異常 if str(request.path).startswith('/admin/'): return None
以上是“如何使用Django與DRF實(shí)現(xiàn)全局異常處理方案”這篇文章的所有內(nèi)容,感謝各位的閱讀!相信大家都有了一定的了解,希望分享的內(nèi)容對(duì)大家有所幫助,如果還想學(xué)習(xí)更多知識(shí),歡迎關(guān)注億速云行業(yè)資訊頻道!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。