Flask + Connexion 中安全打印请求与响应日志的实践方案

星墨小哥_1026

星墨小哥_1026

2026-05-06

477人浏览

原创

Flask + Connexion 中安全打印请求与响应日志的实践方案

在使用 Connexion(v2.13.0)托管 Swagger UI 时,直接通过 after_request 打印响应体易导致 Swagger UI 资源加载失败;本文提供一种兼容性强、不破坏中间件链的替代方案——基于装饰器的按需日志记录。

在使用 connexion(v2.13.0)托管 swagger ui 时,直接通过 `after_request` 打印响应体易导致 swagger ui 资源加载失败;本文提供一种兼容性强、不破坏中间件链的替代方案——基于装饰器的按需日志记录。

当在 Connexion 应用中尝试通过 Flask 的 before_request / after_request 全局钩子统一打印请求与响应载荷时,常会遇到一个隐蔽但关键的问题:Swagger UI 的静态资源(如 /swagger.json、/ui/ 下的 HTML/JS/CSS)或重定向响应(如根路径跳转到 /ui/)会被 response.get_data() 提前消费——这将导致响应流被读取并关闭,后续 WSGI 层无法再次读取 body,最终使 Swagger UI 白屏或报 500 错误。

根本原因在于:response.get_data()(尤其是 as_text=False)会调用底层 response.response 迭代器并耗尽其内容,而 Connexion v2 的响应处理链依赖原始响应对象完成最终渲染与传输。一旦 body 被提前读取,response 将变为不可重复读状态,破坏了框架内部流程。

✅ 推荐解决方案:轻量级路由级日志装饰器
该方式规避全局钩子副作用,仅对明确需要调试的 API 路由生效,完全兼容 Swagger UI:

from functools import wraps
import json
import logging
from flask import request, g

logger = logging.getLogger(__name__)

def log_request_response(pretty_print=True):
    """装饰器:打印指定路由的请求与响应(仅 JSON 路由推荐)"""
    def decorator(f):
        @wraps(f)
        def decorated_function(*args, **kwargs):
            # 1. 记录请求
            method = request.method
            path = request.path
            logger.debug(f"[{method}] {path} — Request received")

            if method not in ('GET', 'HEAD') and request.is_json:
                try:
                    data = request.get_json()
                    body_str = json.dumps(data, separators=(',', ':')) if not pretty_print else json.dumps(data, indent=2)
                    logger.debug(f"→ Request Body: {body_str}")
                except Exception as e:
                    logger.debug(f"→ Request Body (raw): {request.get_data(as_text=True)[:200]}... [parse failed: {e}]")

            # 2. 执行原函数
            response = f(*args, **kwargs)

            # 3. 记录响应(安全方式:仅对 JSON 响应解析,避免读取非 JSON body)
            if hasattr(response, 'get_json') and callable(response.get_json):
                try:
                    json_data = response.get_json()
                    if json_data is not None:
                        body_str = json.dumps(json_data, separators=(',', ':')) if not pretty_print else json.dumps(json_data, indent=2)
                        logger.debug(f"← Response Body: {body_str}")
                except Exception as e:
                    logger.debug(f"← Response Body parse failed: {e}")

            return response
        return decorated_function
    return decorator

? 使用示例(在 Connexion 的 api.yml 对应的 Python 函数上添加):

@log_request_response(pretty_print=False)  # 关闭缩进以节省日志空间
def create_user(body):
    return {'id': 123, 'name': body.get('name')}, 201

@log_request_response(pretty_print=True)
def get_users():
    return [{'id': 1, 'name': 'Alice'}], 200

⚠️ 注意事项:

  • *不建议对 Swagger UI 路由(如 /, /swagger.json, `/ui/`)启用该装饰器** —— 它们返回的是字符串、HTML 或二进制资源,非 JSON,强行解析会出错且无意义;
  • 若需监控所有请求(含非 JSON),可改用 flask.logging 或 WSGI 中间件(如自定义 ProxyMiddleware),但复杂度显著上升;
  • request.get_data() 在装饰器中调用是安全的,因其发生在视图函数执行前,且不会干扰后续响应生成;
  • Connexion v2.13.0 + Flask 2.2.5 组合下,此方案已验证可稳定运行,不影响 Swagger UI 加载与交互。

? 总结:在受限于旧版 Connexion 的项目中,放弃“一刀切”的全局钩子,转而采用精准可控的装饰器模式,是兼顾可观测性与稳定性的务实选择。它既满足调试需求,又彻底规避了因响应体提前读取引发的 UI 崩溃问题。

全能打印神器
全能打印神器

全能打印神器是一款非常好用的打印软件,可以在电脑、手机、平板电脑等设备上使用。支持无线打印和云打印,操作非常简单,使用起来也非常方便,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1751

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4484

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1709

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

26377

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3207

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3207

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1183

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2503

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.7万人学习