Django與DRF結合的全局異常處理方案詳解
前言
Django 和 DRF(django rest framawork) 的結合在 python 后臺中經常出現(xiàn)的組合。對于異常的全局處理，我們系統(tǒng)能有一個統(tǒng)一的解決方案，在開發(fā)環(huán)境能看到比較全的異常堆棧，而在生產環(huán)境能更好的給用戶一個友好的提示，本文旨在提出一個統(tǒng)一個全局異常處理方案，僅供參考使用。
實現(xiàn)的目標
如果沒有 DRF，我們只需要在 Django 中加一個中間件就可以解決全局異常的處理問題，但是 DRF 會幫我們處理一些異常并自動返回到客戶端，因此我們要協(xié)調兩者的異常處理策略。
同時我們希望能使用 Django 的 admin 進行一些后臺的數(shù)據(jù)查看和修改，因此最好要保留 admin 的內部異常處理行為。
本文的目標如下：
- 保留 Django 自帶的 admin 的異常處理行為
- 攔截 DRF 的異常并進行全局異常行為處理
- 攔截除 DRF 的異常之外的其他 Django 異常并進行全局異常行為處理
DRF 全局異常攔截的解決思路
首先 DRF 的異常都是繼承自 APIException 這個類的，并且 DRF 跑出的異常會被 exception_handler 這個異常處理函數(shù)攔截（這個函數(shù)的位置在 /python3.7/site-packages/rest_framework/views.py中）。
我們進一步查看這個函數(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 內置的 Http404 和 PermissionDenied 異常，并將這些異常的處理結果返回到前臺。
如果不再這些處理范圍之內，函數(shù)會返回 None，這時候會給 Django 拋出一個 500 的服務器錯誤異常。
DRF 支持單獨配置異常處理函數(shù)，因此第一步現(xiàn)在 setting 中指定自定義的異常處理函數(shù)的位置：
REST_FRAMEWORK = {
'EXCEPTION_HANDLER': 'server.exception.exception_globe.globe_exception_handler'
}
然后我們定義自己的異常處理程序：
第一步，調用 DRF 自己的異常處理函數(shù)第二步，對 DRF 攔截的異常進行處理第三步，將其他異常拋給 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 異常處理方案
從上一步的結果我們知道，DRF 處理不了的異常我們拋給了 Django，而 Django 支持通過定義中間件進行全局異常處理，因此接下來我們只需要定一個 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
總結
通過上述的配置，我們可以對完成 Django 結合 DRF 的全局異常處理，并且保留了 Django 自帶 admin 的異常處理策略。
在實際的環(huán)境中，我們可以通過環(huán)境變量進行有選擇的日志打印和記錄。
本篇文章就到這里了，希望能夠給你帶來幫助，也希望您能夠多多關注腳本之家的更多內容!
相關文章
這篇文章主要介紹了python統(tǒng)計cpu利用率的方法,涉及Python中win32pdh模塊的使用技巧,需要的朋友可以參考下2015-06-06
這篇文章主要介紹了利用Python繪制多種風玫瑰圖，風玫瑰是由氣象學家用于給出如何風速和風向在特定位置通常分布的簡明視圖的圖形工具，下文繪制實現(xiàn)詳情，需要的小伙伴可以參考一下2022-05-05
在本篇文章里小編給大家整理了一篇關于Python高級架構模式知識點總結內容，有興趣的朋友們可以學習參考下。2021-08-08
python使用requests.post方法傳遞form-data類型的Excel數(shù)據(jù)的示例代碼
這篇文章介紹了python使用requests.post方法傳遞form-data類型的Excel數(shù)據(jù)的示例代碼,某些post接口,需要發(fā)送multipart/form-data類型的數(shù)據(jù),如何使用python requests來模擬這種類型的請求發(fā)送呢?補充講解了python使用requests post請求發(fā)送form-data類型數(shù)據(jù),一起看看吧2024-01-01
這篇文章主要介紹了Python中os模塊功能與用法,總結分析了Python os模塊基本功能、內置函數(shù)、使用方法及相關操作注意事項,需要的朋友可以參考下2020-02-02
這篇文章主要介紹了python多線程抓取天涯帖子內容示例,需要的朋友可以參考下2014-04-04
今天小編就為大家分享一篇關于Python生成器的使用方法和示例代碼，小編覺得內容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2019-03-03
這篇文章主要為大家介紹了Python中re模塊常用方法，并對這些常用方法進行總結分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助2021-09-09
Python 統(tǒng)計列表中重復元素的個數(shù)并返回其索引值的實現(xiàn)方法
這篇文章主要介紹了Python 統(tǒng)計列表中重復元素的個數(shù)并返回其索引值,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-05-05
scrapy爬蟲:scrapy.FormRequest中formdata參數(shù)詳解
這篇文章主要介紹了scrapy爬蟲:scrapy.FormRequest中formdata參數(shù)詳解，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-04-04