讲师中心 微信公众号
AI工具推荐 视频效率加速

Flask怎么返回统一的API标准响应体_Python自定义Response类与装饰器封装

秋浩大大_6185

秋浩大大_6185

发布时间:2026-04-17 11:16:14

|

843人浏览过

|

来源于php中文网

原创

Flask默认jsonify()不够用,因其仅将字典转为JSON且状态码固定为200,无法统一添加code、message、data等业务字段,也不支持全局错误码规范或ORM模型序列化,易导致前端解析失败或TypeError。

flask怎么返回统一的api标准响应体_python自定义response类与装饰器封装

Flask 默认的 jsonify() 为什么不够用

因为 jsonify() 只做一层包装:把字典转成 JSON 响应,状态码固定为 200,没法统一加 code、message、data 这类业务字段,更不支持全局错误码规范或请求耗时统计。一旦接口要对接前端 SDK 或接入网关,字段不一致就会触发解析失败。

常见错误现象:TypeError: Object of type 'CustomModel' is not JSON serializable —— 这说明你直接往 jsonify() 里塞了 ORM 模型实例,而没做序列化预处理。

  • 所有成功响应必须含 code=0、message="success"、data(可为空)
  • 失败响应统一走 code=非0、message 描述错误原因,data 可选(如表单校验失败时返回具体字段错误)
  • 避免在每个视图函数里重复写 return jsonify({"code": 0, "message": "...", "data": ...})

自定义 Response 类继承 flask.Response

不是重写 jsonify,而是让响应体生成逻辑下沉到类构造中,同时兼容 Flask 的响应链路(比如能被 make_response() 包裹、支持 headers 设置)。

关键点在于重载 __init__(),并调用 super().__init__() 传入序列化后的 bytes;同时提供类方法 success() 和 fail() 作为工厂入口:

立即学习“Python免费学习笔记(深入)”;

from flask import Response
import json
<p>class ApiResponse(Response):
@classmethod
def success(cls, data=None, message="success", code=0, **kwargs):
body = {"code": code, "message": message, "data": data}
body.update(kwargs)
return cls(
response=json.dumps(body, ensure_ascii=False),
status=200,
mimetype="application/json; charset=utf-8"
)</p><pre class="brush:php;toolbar:false;">@classmethod
def fail(cls, code=-1, message="error", data=None, status=200):
    body = {"code": code, "message": message, "data": data}
    return cls(
        response=json.dumps(body, ensure_ascii=False),
        status=status,
        mimetype="application/json; charset=utf-8"
    )

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载

注意:status 默认设为 200,不是 4xx/5xx —— 大部分内部业务错误仍走 HTTP 200,靠 code 区分;真要发 400/500,才显式传参覆盖 status。

用装饰器统一包装视图函数返回值

装饰器比中间件更适合这个场景:它只干预明确标记为 API 的路由,不影响静态文件、模板渲染等其他响应类型;且能天然捕获视图函数抛出的异常(比如数据库查询失败),避免裸奔 500。

核心逻辑是拦截返回值,识别是否已是 ApiResponse 实例(避免重复包装),否则自动套一层 success();再用 @app.errorhandler 补全异常路径:

from functools import wraps
<p>def api_result(f):
@wraps(f)
def decorated_function(*args, *<em>kwargs):
try:
rv = f(</em>args, **kwargs)
if isinstance(rv, ApiResponse):
return rv
return ApiResponse.success(data=rv)
except Exception as e:</p><h1>这里可按异常类型映射业务 code,例如 ValidationError → code=1001</h1><pre class="brush:php;toolbar:false;">        return ApiResponse.fail(code=-1, message=str(e), status=200)
return decorated_function

全局异常兜底(可选)

@app.errorhandler(404) def not_found(e): return ApiResponse.fail(code=404, message="not found", status=200)

使用时只需在路由函数上加 @api_result,函数返回原始数据(字典、列表、ORM 对象等),装饰器会自动序列化并包壳。但要注意:如果视图里已手动返回 ApiResponse 实例(比如主动返回错误),装饰器会跳过二次包装。

序列化 ORM 模型时容易漏掉的坑

装饰器里的 ApiResponse.success(data=rv) 直接对 rv 调用 json.dumps(),若 rv 是 SQLAlchemy 模型实例,默认会报 TypeError。不能依赖 Flask-SQLAlchemy 自带的 __dict__(含私有属性和循环引用)。

  • 最简方案:在视图函数里手动转字典,例如 user.to_dict()(需模型自己实现)
  • 推荐方案:用 pydantic 定义输出 Schema,在装饰器中判断类型后自动转换:if isinstance(rv, BaseModel): rv = rv.model_dump()
  • 千万别在 ApiResponse 类里无差别调用 vars() 或 model_to_dict() —— 会污染通用响应类,且无法处理嵌套关系
  • 时间字段默认转成字符串,避免 datetime 序列化失败;json.dumps(..., default=str) 是底线兜底,但不推荐作为主力方案

统一响应不是加个装饰器就完事,真正的复杂点藏在数据源头:模型怎么出、字段怎么筛、空值怎么处理、分页怎么嵌套——这些都得在视图层或 DTO 层提前收口,Response 类只负责“装盒”,不负责“装什么”。

热门AI工具

更多
Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

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

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

1851

2023.07.20

python能做什么
python能做什么

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

4964

2023.07.25

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

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

1789

2023.07.31

python教程
python教程

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

29857

2023.08.03

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

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

3547

2023.08.04

python eval
python eval

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

3567

2023.08.04

scratch和python区别
scratch和python区别

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

1223

2023.08.11

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

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

616

2023.08.10

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

100

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn