如何在Flask中进行异常处理实例解析

更新时间：2023年11月22日 11:23:55 作者：Hunter

这篇文章主要为大家介绍了如何在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

记得要在 app/__init__.py 中引入初始化处理哦

以上就是如何在Flask中进行异常处理实例解析的详细内容，更多关于Flask异常处理的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Flask
异常

python轻松查到删除自己的微信好友
这篇文章主要介绍了python脚本快速查看自己被多少微信好友删除的方法，感兴趣的小伙伴们可以参考一下
2016-01-01
python第三方库easydict的使用实例详解
在 Python 中当我们需要访问字典中的元素的时候，我们需要使用类似 a['example'] 的形式来进行使用，这个时候就可以使用 easydict 这个模块了，今天通过本文给大家讲解python第三方库easydict的使用，感兴趣的朋友跟随小编一起看看吧
2022-11-11
Python中的推导式使用详解
这篇文章主要介绍了Python中的推导式使用详解,本文分别讲解了列表推导式、字典推导式、集合推导式使用实例,需要的朋友可以参考下
2015-06-06
详解Python的三种可变参数
这篇文章主要介绍了Python的三种可变参数，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-05-05
Django中的cookie和session
这篇文章主要介绍了Django中的cookie和session实例详解，本文给大家介绍的非常详细，具有一定的参考借鉴价值,需要的朋友可以参考下
2019-08-08
python中将一个全部为int的list 转化为str的list方法
下面小编就为大家分享一篇python中将一个全部为int的list 转化为str的list方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2018-04-04
浅析Python字符串索引、切片、格式化
除了数字，Python中最常见的数据类型就是字符串，无论那种编程语言，字符串无处不在。本文将为大家详细介绍Python中字符串的使用方法，需要的朋友可以参考一下
2021-12-12
Pycharm安装第三方库失败解决方案
这篇文章主要介绍了Pycharm安装第三方库失败解决方案,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-11-11
python读取注册表中值的方法
在Python的标准库中，_winreg.pyd可以操作Windows的注册表，另外第三方的win32库封装了大量的Windows API，使用起来也很方便。不过这里介绍的是使用_winreg操作注册表，毕竟是Python自带的标准库，无需安装第三方库
2013-04-04
详解python之多进程和进程池(Processing库)
本篇文章主要介绍了详解python之多进程和进程池(Processing库)，非常具有实用价值，需要的朋友可以参考下
2017-06-06