Django與DRF結合的全域性例外處理方案詳解

2022-02-23 13:06:27

前言

Django 和 DRF(django rest framawork) 的結合在 python 後臺中經常出現的組合。對於異常的全域性處理，我們系統能有一個統一的解決方案，在開發環境能看到比較全的異常堆疊，而在生產環境能更好的給使用者一個友好的提示，本文旨在提出一個統一個全域性例外處理方案，僅供參考使用。

實現的目標

如果沒有 DRF，我們只需要在 Django 中加一箇中介軟體就可以解決全域性異常的處理問題，但是 DRF 會幫我們處理一些異常並自動返回到使用者端，因此我們要協調兩者的例外處理策略。

同時我們希望能使用 Django 的 admin 進行一些後臺的資料檢視和修改，因此最好要保留 admin 的內部例外處理行為。

本文的目標如下：

保留 Django 自帶的 admin 的例外處理行為
攔截 DRF 的異常並進行全域性異常行為處理
攔截除 DRF 的異常之外的其他 Django 異常並進行全域性異常行為處理

DRF 全域性異常攔截的解決思路

首先 DRF 的異常都是繼承自 APIException 這個類的，並且 DRF 跑出的異常會被 exception_handler 這個例外處理函數攔截（這個函數的位置在 /python3.7/site-packages/rest_framework/views.py中）。

我們進一步檢視這個函數的原始碼：

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

通過這個函數的檔案簽名我們知道，DRF 會處理所有繼承自 APIException 的異常類，並且還會額外的處理 Django 內建的 Http404 和 PermissionDenied 異常，並將這些異常的處理結果返回到前臺。

如果不再這些處理範圍之內，函數會返回 None，這時候會給 Django 丟擲一個 500 的伺服器錯誤異常。

DRF 支援單獨設定例外處理函數，因此第一步現在 setting 中指定自定義的例外處理函數的位置：

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'server.exception.exception_globe.globe_exception_handler'
}

然後我們定義自己的例外處理程式：

第一步，呼叫 DRF 自己的例外處理函數第二步，對 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 則直接觸發上面的 ExceptionGlobeMiddleware
    return response

Django 例外處理方案

從上一步的結果我們知道，DRF 處理不了的異常我們拋給了 Django，而 Django 支援通過定義中介軟體進行全域性例外處理，因此接下來我們只需要定一個 Django 全域性例外處理的中介軟體，並將中介軟體設定到 setting 檔案中的 MIDDLEWARE 陣列即可。

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)

值得注意的是，我們可以在中介軟體的處理常式中拿到 request 物件，因此，我們可以通過這個物件拿到使用者請求的 url，這樣，我們通過判斷 url 就可以得到那些請求是來自 Django 自帶的 admin 的。

參考程式碼如下：

# 直接丟擲 django admin 的異常
if str(request.path).startswith('/admin/'):
    return None

總結

通過上述的設定，我們可以對完成 Django 結合 DRF 的全域性例外處理，並且保留了 Django 自帶 admin 的例外處理策略。

在實際的環境中，我們可以通過環境變數進行有選擇的紀錄檔列印和記錄。

本篇文章就到這裡了，希望能夠給你帶來幫助，也希望您能夠多多關注it145.com的更多內容!

Django與DRF結合的全域性例外處理方案詳解

目錄

前言

實現的目標

DRF 全域性異常攔截的解決思路

Django 例外處理方案

總結

熱門文章