为什么Python Flask中SQLAlchemy的查询结果无法直接序列化?

云浩吖_9717

云浩吖_9717

2026-06-11

675人浏览

原创

SQLAlchemy查询结果需转为字典等基础类型才能JSON序列化,因ORM对象含_sa_instance_state等非序列化属性;推荐用model_to_dict()过滤清洗,或row._mapping适配不同查询结果,避免JSONEncoder.default全局误用。

为什么python flask中sqlalchemy的查询结果无法直接序列化?

因为 SQLAlchemy 的查询结果(无论是 User 实例还是 Query 返回的元组)不是原生 Python 基础类型,而 json.dumps() 和 flask.jsonify() 只认 dict、list、str、int、float、bool、None 这几种。ORM 对象自带状态管理、延迟加载属性、内部元数据(如 _sa_instance_state),这些全都不在 JSON 序列化白名单里。

to_dict() 方法最直接,但字段要手动列全

给模型加一个 to_dict() 是最快能跑通的方式,但它隐含几个实际坑:

  • 每次新增字段都得同步改 to_dict(),容易漏 —— 尤其是后期加了 DateTime、Decimal 或外键关联字段时
  • datetime 类型会直接报 TypeError: Object of type datetime is not JSON serializable,得手动转成字符串
  • 如果模型用了 db.relationship(),默认不会包含关联对象,但如果你误写了 self.posts 进去,又没处理懒加载,可能触发额外查询甚至循环引用
  • 字段名硬编码,重构列名时容易不一致

示例写法(带基础类型防护):

def to_dict(self):
    return {
        "id": self.id,
        "app_key": self.app_key,
        "secret": self.secret,
        "created_at": self.created_at.isoformat() if self.created_at else None,
    }

用 __dict__ + 过滤比手写 to_dict() 更省事,但有陷阱

很多人第一反应是用 obj.__dict__,它确实自动包含所有实例属性,但必须过滤掉 SQLAlchemy 的内部字段,否则会出错:

  • _sa_instance_state 是必删项,不删就报错
  • query、query_class、metadata 这些类属性也会混进来,需排除
  • 延迟加载字段(如未访问过的 user.profile)在 __dict__ 里可能是 sqlalchemy.orm.attributes.InstrumentedAttribute,不能直接序列化
  • None 值本身可序列化,但某些前端框架对 null 处理不友好,常需要转空字符串或默认值

安全过滤写法(推荐封装成工具函数):

def model_to_dict(obj):
    d = {k: v for k, v in obj.__dict__.items() if not k.startswith('_') and k != 'metadata'}
    # 清洗常见非序列化类型
    for k, v in d.items():
        if hasattr(v, 'isoformat'):  # datetime/date
            d[k] = v.isoformat()
        elif isinstance(v, Decimal):
            d[k] = float(v)
        elif v is None:
            d[k] = ""
    return d

query.all() 返回的是对象列表,但 db.session.query(User.id, User.name) 返回的是元组

这是最容易被忽略的兼容性断点:两种查询返回结构完全不同,不能共用同一套序列化逻辑。

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

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

下载
  • User.query.all() → [<user>, <user>]</user></user>,每个元素是 ORM 实例,可用 to_dict() 或 model_to_dict()
  • db.session.query(User.id, User.name).all() → [(1, 'Alice'), (2, 'Bob')],每个元素是 sqlalchemy.util._collections.result 或普通元组,得用 row._mapping(新版本)或 row._asdict()(旧版本),或者手动解包
  • 混合查询(如 db.session.query(User, Post.title))返回的是元组,第一个元素是 User 实例,第二个是字符串,必须分别处理

统一处理建议(适配新旧 SQLAlchemy):

def query_result_to_list(result):
    if not result:
        return []
    first = result[0]
    if hasattr(first, '_mapping'):  # SQLAlchemy 1.4+
        return [dict(row._mapping) for row in result]
    elif hasattr(first, '_asdict'):  # SQLAlchemy 1.3-
        return [row._asdict() for row in result]
    else:  # ORM 实例列表
        return [model_to_dict(row) for row in result]

别碰 json.JSONEncoder.default —— 它救不了所有场景

有人写自定义 JSONEncoder 拦截所有对象,看似一劳永逸,但实际问题更多:

  • 它无法区分“这个 datetime 是模型字段”还是“这个 datetime 是我手动塞进 dict 的上下文时间”,容易误转
  • 遇到嵌套对象(比如模型里有个 dict 字段,里面又含 datetime),default 不递归处理,照样崩
  • 一旦启用全局 app.json_encoder = MyEncoder,所有 jsonify() 都走这套逻辑,连你返回的纯字典、第三方库返回的对象也可能被意外重写
  • 调试困难:错误堆栈里看不到具体哪一行触发了 default,只看到最终失败位置

真正需要它的场景极少,比如你明确只要把所有 Decimal 统一转 float,且确认没有其他复杂类型 —— 否则优先用前三种方式。

最麻烦的其实是混合查询和懒加载字段的组合:你以为只查了 id 和 name,结果某个字段的 getter 触发了关联表查询,还带着未初始化的 InstrumentedAttribute。这种时候,靠序列化层兜底不如在查询时就用 load_only() 或 defer() 显式控制字段加载范围。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1811

4

python能做什么
python能做什么

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

2023.07.25

4804

7

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

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

2023.07.31

1769

3

python教程
python教程

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

2023.08.03

28557

23

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

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

2023.08.04

3427

5

python eval
python eval

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

2023.08.04

3447

5

scratch和python区别
scratch和python区别

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

2023.08.11

1223

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2663

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程