Django與DRF結(jié)合的全局異常處理方案詳解
前言
Django 和 DRF(django rest framawork) 的結(jié)合在 python 后臺中經(jīng)常出現(xiàn)的組合。對于異常的全局處理，我們系統(tǒng)能有一個統(tǒng)一的解決方案，在開發(fā)環(huán)境能看到比較全的異常堆棧，而在生產(chǎn)環(huán)境能更好的給用戶一個友好的提示，本文旨在提出一個統(tǒng)一個全局異常處理方案，僅供參考使用。
實現(xiàn)的目標(biāo)
如果沒有 DRF，我們只需要在 Django 中加一個中間件就可以解決全局異常的處理問題，但是 DRF 會幫我們處理一些異常并自動返回到客戶端，因此我們要協(xié)調(diào)兩者的異常處理策略。
同時我們希望能使用 Django 的 admin 進(jìn)行一些后臺的數(shù)據(jù)查看和修改，因此最好要保留 admin 的內(nèi)部異常處理行為。
本文的目標(biāo)如下：
- 保留 Django 自帶的 admin 的異常處理行為
- 攔截 DRF 的異常并進(jìn)行全局異常行為處理
- 攔截除 DRF 的異常之外的其他 Django 異常并進(jìn)行全局異常行為處理
DRF 全局異常攔截的解決思路
首先 DRF 的異常都是繼承自 APIException 這個類的，并且 DRF 跑出的異常會被 exception_handler 這個異常處理函數(shù)攔截（這個函數(shù)的位置在 /python3.7/site-packages/rest_framework/views.py中）。
我們進(jìn)一步查看這個函數(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
通過這個函數(shù)的文檔簽名我們知道，DRF 會處理所有繼承自 APIException 的異常類，并且還會額外的處理 Django 內(nèi)置的 Http404 和 PermissionDenied 異常，并將這些異常的處理結(jié)果返回到前臺。
如果不再這些處理范圍之內(nèi)，函數(shù)會返回 None，這時候會給 Django 拋出一個 500 的服務(wù)器錯誤異常。
DRF 支持單獨(dú)配置異常處理函數(shù)，因此第一步現(xiàn)在 setting 中指定自定義的異常處理函數(shù)的位置：
REST_FRAMEWORK = {
'EXCEPTION_HANDLER': 'server.exception.exception_globe.globe_exception_handler'
}
然后我們定義自己的異常處理程序：
第一步，調(diào)用 DRF 自己的異常處理函數(shù)第二步，對 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
Django 異常處理方案
從上一步的結(jié)果我們知道，DRF 處理不了的異常我們拋給了 Django，而 Django 支持通過定義中間件進(jìn)行全局異常處理，因此接下來我們只需要定一個 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 對象，因此，我們可以通過這個對象拿到用戶請求的 url，這樣，我們通過判斷 url 就可以得到那些請求是來自 Django 自帶的 admin 的。
參考代碼如下：
# 直接拋出 django admin 的異常
if str(request.path).startswith('/admin/'):
return None
總結(jié)
通過上述的配置，我們可以對完成 Django 結(jié)合 DRF 的全局異常處理，并且保留了 Django 自帶 admin 的異常處理策略。
在實際的環(huán)境中，我們可以通過環(huán)境變量進(jìn)行有選擇的日志打印和記錄。
本篇文章就到這里了，希望能夠給你帶來幫助，也希望您能夠多多關(guān)注腳本之家的更多內(nèi)容!
相關(guān)文章
Python爬蟲如何應(yīng)對Cloudflare郵箱加密
這篇文章主要介紹了Python爬蟲如何應(yīng)對Cloudflare郵箱加密,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-06-06
這篇文章主要給大家介紹了關(guān)于Python?count()函數(shù)用法的相關(guān)資料,Python?count()方法用于統(tǒng)計字符串里某個字符出現(xiàn)的次數(shù),可選參數(shù)為在字符串搜索的開始與結(jié)束位置,需要的朋友可以參考下2024-02-02
Scrapy之爬取結(jié)果導(dǎo)出為Excel的實現(xiàn)過程
這篇文章主要介紹了Scrapy之爬取結(jié)果導(dǎo)出為Excel的實現(xiàn)過程，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-12-12
這篇文章主要介紹了python conda操作方法，非常不錯，具有一定的參考借鑒價值,需要的朋友可以參考下2019-09-09
剖析Python的Tornado框架中session支持的實現(xiàn)代碼
這篇文章主要介紹了剖析Python的Tornado框架中session支持的實現(xiàn)代碼,這樣就可以使用Django等框架中大家所熟悉的session了,需要的朋友可以參考下2015-08-08
python 將數(shù)據(jù)保存為excel的xls格式(實例講解)
下面小編就為大家分享一篇python 將數(shù)據(jù)保存為excel的xls格式(實例講解)，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-05-05
python生成可執(zhí)行exe控制Microsip自動填寫號碼并撥打功能
這篇文章主要介紹了python生成可執(zhí)行exe控制Microsip自動填寫號碼并撥打,在這需要注意一個問題，必須是已經(jīng)運(yùn)行Microsip.exe文件，具體實現(xiàn)代碼跟隨小編一起看看吧2021-06-06
wxpython 最小化到托盤與歡迎圖片的實現(xiàn)方法
這篇文章主要分享一個python實例代碼，使用wxpython實現(xiàn)最小化到托盤與歡迎圖片,需要的朋友可以參考下2014-06-06
這篇文章主要介紹了python利用百度云接口實現(xiàn)車牌識別的示例，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-02-02
今天小編就為大家分享一篇Python 之 Json序列化嵌套類方式，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-02-02