flask項目統一捕獲異常並自定義異常信息

背景：

     在日常編寫了一些flask項目，主要用於測試方面的mock場景，但迭代到后期發現有時候會拋出各種亂七八糟的異常或者直接500且沒有任何異常信息，這種情況一般都是某個代碼塊沒有用try來進行異常捕獲；又或者是api的地址編寫有誤，直接拋出404了，這類提示都很不友好，故結合網上的教材，進行了針對異常的統一捕獲並自動以了異常信息，用於接口回顯，這樣相對來說，對於使用者友好一些

 

errorhandler

errorhandler捕捉當前app或藍圖的狀態碼，並進行自定制處理

下面是一份示例代碼，admin是一個藍本或者app，發生404錯誤或500錯誤，會返回一個Json對象給請求段

from flask import jsonify
from . import admin
@admin.errorhandler(404)
def error_404(error):
    """這個handler可以catch住所有abort(404)以及找不到對應router的處理請求"""
    response = dict(status=0, message="404 Not Found")
    return jsonify(response), 404
@admin.errorhandler(Exception)
def error_500(error):
    """這個handler可以catch住所有的abort(500)和raise exeception."""
    response = dict(status=0, message="500 Error")
    return jsonify(response), 400
class MyError(Exception):
    """自定義錯誤類"""
    pass
@admin.errorhandler(MyError)
def MyErrorHandle(error):
    response = dict(status=0, message="400 Error")
    return jsonify(response), 400

 

app_errorhandler

app_errorhandler捕捉全局狀態碼，並進行自定制異常處理

在藍本中編寫錯誤處理程序有點不同，如果使用errorhandler修飾器，那么只有藍本中的錯誤才會觸發。如果想注冊全局的錯誤處理程序，要用app_errorhandler

from . import auth
@auth.app_errorhandler(404)
def error_404(error):
    response = dict(status=0, message="404 Not Found")
    return jsonify(response), 404

 

實踐 

以下代碼為我自己項目中的實現：

首先新建一個error.py文件

import json
from flask import Blueprint, Response

exception = Blueprint('exception',__name__)

@exception.app_errorhandler(404)
def error_404(error):
    """這個handler可以catch住所有abort(404)以及找不到對應router的處理請求"""
    res = {"status": 404, "message": "404錯誤,找不到對應router"}
    return Response(json.dumps(res), mimetype='application/json')

@exception.app_errorhandler(405)
def error_405(error):
    """這個handler可以catch住所有abort(405)以及請求方式有誤的請求"""
    res = {"status": 405, "message": "請求方式有誤"}
    return Response(json.dumps(res), mimetype='application/json')

# @exception.app_errorhandler(Exception)
# def error_500(error):
#     """這個handler可以catch住所有的abort(500)和raise exeception."""
#     res = {"status": 500, "message": "系統內部錯誤"}
#     return Response(json.dumps(res), mimetype='application/json')

class MyError(Exception):
    """自定義錯誤類"""
    pass

 

然后在flask啟動文件中新增如下代碼：

# 導入error.py文件中的exception藍圖
from error import exception
from flask import Flask, request, Response


app = Flask(__name__)
# 注冊藍圖，並指定其對應的前綴（url_prefix）
app.register_blueprint(exception, url_prefix='/error')
# 以下可以寫業務代碼


if __name__ == '__main__':
    app.run(host='0.0.0.0', port=8089, debug=False, threaded=True)

 

補充說明

　　當我們不是使用的工廠模式創建app時，app.errorhandler(401)，即可捕捉全局401狀態；若使用了create_app方式創建app，則無法進行捕捉，若想捕捉，可以在藍圖中寫，如admin.errorhandler(401)，即捕捉admin藍圖下所有401狀態碼，admin.app_errorhandler(401)，則是捕捉的全局的401狀態碼，即其他藍圖中的401狀態，也會被捕捉，進行處理

 

 

文章來源：

https://www.cnblogs.com/huchong/p/9205651.html