直接用 json.dumps() 会出错,因 Python 原生 JSON 模块不支持 datetime、SQLAlchemy 模型等类型序列化;Marshmallow 通过 Schema 显式定义字段与格式(如 fields.DateTime、attribute 跨关系取值)解决该问题。

为什么直接用 json.dumps() 会出问题
Flask 默认用 json.dumps() 序列化响应,但它不处理嵌套对象、日期、自定义类或 SQLAlchemy 模型——直接传入会抛 TypeError: Object of type datetime is not JSON serializable 或 Object of type User is not JSON serializable。这不是 Flask 的 bug,而是 Python 原生 JSON 模块的限制。
常见踩坑点:
- 在视图里手动调用
json.dumps()+json.JSONEncoder子类,结果漏掉字段类型校验和反序列化逻辑 - 用
__dict__或vars()粗暴转字典,暴露了内部属性(如_sa_instance_state)或引发循环引用 - 多个接口共用同一模型但需要不同字段(比如 admin 接口返回邮箱,public 接口隐藏),硬编码导致重复逻辑
用 Marshmallow 定义 schema 的最小可行写法
Marshmallow 的核心是 Schema 类,它声明「数据长什么样」和「怎么进出 JSON」。别一开始就写完整验证规则,先让序列化跑通。
示例:一个带 datetime 和外键关系的 SQLAlchemy 模型
from marshmallow import Schema, fields from datetime import datetime <p>class PostSchema(Schema): id = fields.Integer() title = fields.String() created_at = fields.DateTime(format='iso') # 自动格式化 datetime author_name = fields.String(attribute='author.name') # 跨关系取值 </p>
关键点:
-
attribute参数指定源字段名,支持点号路径('author.name'),比@post_dump更轻量 -
format='iso'是最安全的时间格式,避免前端解析失败;不用format='timestamp',因为时区处理容易出错 - 不需要继承
ModelSchema(已弃用),纯Schema+ 显式字段更可控
在 Flask 视图中正确使用 dump() 和 load()
别把 schema 实例挂到全局或每次请求 new 一次。推荐在模块顶层定义,复用实例。
post_schema = PostSchema() posts_schema = PostSchema(many=True) # 注意 many=True 用于列表
视图中用法:
@app.route('/posts')
def list_posts():
posts = Post.query.all()
result = posts_schema.dump(posts) # 不是 .dumps()!
return jsonify(result)
反序列化(接收 POST 数据)必须显式调用 load() 并捕获异常:
@app.route('/posts', methods=['POST'])
def create_post():
try:
data = post_schema.load(request.get_json())
except ValidationError as err:
return jsonify({'errors': err.messages}), 400
# data 是干净的 dict,可直接传给 Post(**data)
注意:
-
dump()输入是 Python 对象,输出是 dict;dumps()才输出字符串(Flaskjsonify()内部会处理) -
load()必须加try/except,否则ValidationError会 500;错误信息在err.messages里,是嵌套字典 - 不要在 schema 里写
required=True就以为前端必填——它只在校验阶段生效,不生成 OpenAPI 文档或前端提示
绕过 ORM 层直接序列化原始查询结果
当用 db.session.execute() 或 query.values() 获取元组/命名元组时,Marshmallow 默认不认识。这时别改 schema,用 load_from 或更简单的方案:
- 用
zip(schema.fields.keys(), row)手动构 dict(适合字段少、动态 SQL) - 给命名元组加
_asdict()方法(SQLAlchemy 1.4+ 的Result.scalars().all()返回的就是普通对象) - 在 schema 中用
fields.Method处理特殊来源:
class RawPostSchema(Schema):
id = fields.Integer()
title = fields.String()
author_name = fields.Method('get_author_name')
<pre class="brush:php;toolbar:false;">def get_author_name(self, obj):
# obj 是元组,假设 author_name 在索引 2
return obj[2] if len(obj) > 2 else None
这种写法灵活,但失去字段声明的可读性。真正复杂的报表场景,建议用 Pandas + to_dict(orient='records') 配合简单 schema 后处理。
复杂点在于嵌套 schema 的 many=True 和 only/exclude 动态控制——它们不递归生效,得手动传参或写 wrapper 函数。这点很容易被忽略,直到某个接口突然漏字段才意识到。
Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!











