当前位置:首页 > 文章列表 > 文章 > python教程 > Flask自定义JSON返回实现方法

Flask自定义JSON返回实现方法

2026-05-06 11:53:49 0浏览 收藏
本文深入解析了在 Flask 中正确返回 JSON 数据的关键要点:直接使用 json.dumps() 会导致前端解析失败或 TypeError,因其仅生成字符串而未设置必要的 Content-Type: application/json 响应头;而推荐使用的 jsonify() 虽能自动处理 headers、状态码和编码,却对数据类型有严格限制——仅支持基本 Python 类型,无法序列化自定义类或 datetime 等对象,一旦传入便会抛出“Object is not JSON serializable”错误,文章还点明了常见误用场景与调试技巧,帮你避开生产环境中的典型坑。

Python编写Flask API如何返回自定义JSON_使用jsonify格式化响应数据

为什么直接用 json.dumps() 返回 JSON 会出错

Flask 默认响应体是字符串,json.dumps() 虽然生成了 JSON 字符串,但没设置 Content-Type: application/json,前端可能解析失败,或 Flask 自带的调试器报 TypeError: The view function did not return a valid response。

常见错误现象:返回内容看着像 JSON(比如有花括号),但浏览器 Network 面板里 Response Headers 没有 Content-Type: application/json,fetch 的 .json() 报 Unexpected token。

  • 必须用 jsonify(),它自动设好 headers、状态码和编码
  • jsonify() 只接受 dict、list、str、int、float、bool、None,不支持自定义类或 datetime 对象(会抛 TypeError: Object of type X is not JSON serializable)
  • 传入单个非字典对象(如 jsonify([1,2,3]))是合法的,但 Flask 旧版本(app.config['JSONIFY_PRETTYPRINT_REGULAR'] = False

jsonify() 怎么处理嵌套数据和空值

它对 None、True、False、数字、字符串都原样转,但不会帮你过滤字段或扁平化结构。如果你传一个带 datetime 的 dict,会直接崩。

使用场景:API 返回用户信息时,数据库查出的 ORM 对象常含 created_at(datetime 类型)、is_active(bool)、profile(嵌套 dict)——这些不能直接喂给 jsonify()。

  • 先手动转换:用 isoformat() 处理 datetime,例如 "created_at": user.created_at.isoformat()
  • 避免传整个 ORM 实例,只构造所需字段的 dict,比如 {"id": u.id, "name": u.name, "joined": u.joined_at.isoformat()}
  • jsonify() 对 None 值保留为 null,符合 JSON 规范,无需额外处理

如何返回带状态码和自定义 headers 的 JSON 响应

jsonify() 本身不支持直接设 status 或 headers,但可以链式调用 .status_code 和 .headers.set() —— 这是 Flask 的响应对象机制决定的。

性能影响:每次调用 jsonify() 都新建一个 Response 实例,但开销极小,不用优化;重点是别在循环里反复 jsonify 同一份数据。

  • 改状态码:return jsonify({"error": "not found"}).status_code = 404(注意:赋值写法在老版本 Flask 中不生效,推荐用元组形式)
  • 更稳妥写法:return jsonify({"msg": "ok"}), 201(元组第二项是 status code)
  • 加 headers:resp = jsonify({"data": [...]}) → resp.headers["X-Api-Version"] = "v2" → return resp
  • 不要用 make_response(jsonify(...)) 套两层,冗余且易出错

遇到中文乱码或特殊字符怎么处理

默认情况下,jsonify() 会把中文转成 Unicode 转义(如 "\u4f60\u597d"),不是 bug,是 JSON 标准行为。但有些前端(尤其老版 iOS WebView)解析不稳。

兼容性影响:Python 3.8+ + Flask 2.0+ 默认禁用 ASCII 转义,中文直出;若你看到 \uXXXX,大概率是 Flask 版本低或显式设置了 app.config['JSON_AS_ASCII'] = True。

  • 强制中文不转义:app.config['JSON_AS_ASCII'] = False(推荐放在 app 初始化后)
  • 如果用了 jsonify() 还是乱码,检查是否在 response 后又手动调了 .encode('utf-8') —— jsonify() 已返回 UTF-8 编码的 bytes,重复 encode 会破坏
  • 路径参数或 query string 里的中文不影响 jsonify(),那是 request 解析阶段的事
事情说清了就结束。最常被忽略的是 datetime 和 list 的序列化限制,还有误以为 jsonify() 能接任意 Python 对象——它只认基础类型,别的得自己剥一层。

好了,本文到此结束,带大家了解了《Flask自定义JSON返回实现方法》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多文章知识!

Vue项目如何正确引入CSS文件Vue项目如何正确引入CSS文件
上一篇
Vue项目如何正确引入CSS文件
Go语言装饰器模式实现与示例解析
下一篇
Go语言装饰器模式实现与示例解析
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • PubMedQA数据集详解:生物医学问答基准、功能与应用指南
    PubMedQA
    深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
    263次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    312次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    294次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    270次使用
  • MMBench详解:多模态大模型基准测试、功能特点与使用指南
    MMBench
    MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
    87次使用