Flask笔记四之异常处理

“ 这是 Flask 系列笔记的第四篇，此系列会从 0 到 1 逐步搭建一个以 Flask 框架为基础的后台系统，文章内容均来自 Flask 官方文档。”

在系统运行中，有时候需要处理报错异常。

异常的来源可能是系统在运行中的报错，比如错误的运算的有 1/0 这种等，还有的是访问了不存在接口，又或者，我们在查验接口参数的时候，发现没有传必传参数，需要手动触发一个报错等。

这里就介绍如何在 Flask 中进行异常处理。

本篇笔记的代码都已经提交到 github 上，可使用下面的操作获取代码：

git clone https://github.com/x1204604036/flask_backend.git

1、异常处理示例

这里以请求的接口不存在为示例介绍一下异常处理流程。

处理一个异常，需要先对指定的异常进行注册，对于请求接口不存在这种请求相关的异常，Flask 里定义了一个 HTTPException 异常对其进行处理

这里我们在 app/ 下创建一个文件夹 utils，再创建一个文件 exception_handler.py：

# app/utils/exception_handler.py

from werkzeug.exceptions import HTTPException
from flask import jsonify

def init_error_exception(app):

    @app.errorhandler(HTTPException)
    def handler_http_exception(exception):
        print(exception)
        return jsonify({"code": -1, "msg": exception.description}), exception.code

这里创建了一个异常处理的函数，通过 @app.errorhandler(HTTPException) 的方式注册，在 app/__init__.py 中引入：

from flask import Flask
from app.utils.exception_handler import init_error_exception

def create_app():
    app = Flask(__name__)

    init_error_exception(app)

    return app

flask.jsonify 用来返回 json 数据给客户端，后面跟着的是 HTTP 的 status code，就是 200，500 那些表示请求状态的的状态码

这里我们用 postman 请求一个不存在的接口，就可以看到返回的信息如下：

{
    "code": -1,
    "msg": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}

status code 是 404，表示接口不存在

这样，关于 HTTP 请求的异常处理就从注册，到触发，到返回结果完成了一个闭环。

2、其他异常处理

除了上面的请求异常，可能还有一些异常，比如我们在接口里进行了 1/0 等不合法的运算，为了捕捉这种报错，我们可以如下操作：

ERROR_HTTP_CODE = 417


def init_error_exception(app):
    @app.errorhandler(Exception)
    def server_exception(exception):
        print(exception)
        return jsonify({"code": -1, "msg": "内部错误"}), ERROR_HTTP_CODE

这样，在系统里发生异常异常之后，就会被捕捉，返回给客户端 内部错误 的信息

还有一些时候，举个例子，比如在接口里，客户端没有传来一些必传的参数，我们可以手动触发一个报错，自定义报错信息和HTTP状态码，可以如下这样操作：

class UserException(Exception):
    def __init__(self, code=-1, msg="error", http_code=417):
        self.code = code
        self.msg = msg
        self.http_code = http_code

def init_error_exception(app):
    @app.errorhandler(UserException)
    def user_exception(exception):
        print(exception)
        return jsonify({"code": exception.code, "msg": exception.msg}), exception.http_code

然后我们在接口里这样调用触发异常：

raise UserException(msg="手动测试error", http_code=417)

我们可以传入 code，msg 和 http_code 参数，用于返回给前端

以上这些介绍的都是异常的处理，还可以在处理异常的时候打印日志，用于记录报错的信息，这个我们后面介绍日志的时候再介绍。

3、代码总览

以下给出前面介绍的三种异常处理的代码：

# app/utils/exception_handler.py

from werkzeug.exceptions import HTTPException
from flask import jsonify


ERROR_HTTP_CODE = 417


class UserException(Exception):
    def __init__(self, code=-1, msg="error", http_code=417):
        self.code = code
        self.msg = msg
        self.http_code = http_code

def init_error_exception(app):
    @app.errorhandler(HTTPException)
    def handler_http_exception(exception):
        print(exception)
        return jsonify({"code": -1, "msg": exception.description}), exception.code

    @app.errorhandler(Exception)
    def server_exception(exception):
        print(exception)
        return jsonify({"code": -1, "msg": "内部错误"}), ERROR_HTTP_CODE


    @app.errorhandler(UserException)
    def user_exception(exception):
        print(exception)
        return jsonify({"code": exception.code, "msg": exception.msg}), exception.http_code