如何解决Python Flask中Decimal类型无法序列化JSON_自定义JSONEncoder

必须重写JSONEncoder,因jsonify依赖json.dumps默认不支持Decimal;需继承flask.json.JSONEncoder并重写default方法,对Decimal转float后交由父类处理,再通过app.json_encoder全局注册。

直接结论:必须重写 JSONEncoder,不能靠 int()float() 强转字段再传给 jsonify —— 那只是掩盖问题,且在精度丢失、负零、NaN 等边界场景会出错。

为什么 jsonify 会报 Object of type 'Decimal' is not JSON serializable

Flask 的 jsonify 内部调用的是 json.dumps(),而 Python 标准库的 json 模块默认只认 intfloatstr 等原生类型。decimal.Decimal 是独立实现的高精度类型,不在默认映射表里。一旦数据库查询返回含 Decimal 的元组或字典(比如 SELECT SUM(price)),jsonify 就会直接抛错。

常见错误现象:

  • 返回 HTTP 500,日志里只有 TypeError: Object of type 'Decimal' is not JSON serializable
  • 错误堆栈指向 flask/json/__init__.py 中的 dumps 调用
  • 仅在连接 MySQL/PostgreSQL 并使用原生驱动(如 pymysqlpsycopg2)时高频出现,SQLite 有时不暴露该问题(因部分驱动自动转 float

如何正确继承并注册 JSONEncoder(Flask 2.0+ 推荐方式)

从 Flask 2.0 开始,simplejson 已被移除,必须通过子类化 flask.json.JSONEncoder 并赋值给 app.json_encoder(旧版用 app.json_encoder,新版推荐 app.json.provider_class,但兼容写法仍有效)。

实操建议:

  • 定义一个新类,继承 flask.json.JSONEncoder,重写 default 方法
  • default 中只处理 decimal.Decimal,其余一律交还父类(super().default(o)),避免覆盖对 datetime 等其他类型的默认支持
  • 确保 return float(o) 而非 str(o) —— JSON number 类型需要数值,不是字符串;str(o) 会导致前端解析为字符串,破坏数值比较和计算逻辑
  • 注册时用 app.json_encoder = YourEncoder,不要漏掉这一步

示例代码:

Find JSON Path Online

Easily find JSON paths within JSON objects using our intuitive Json Path Finder

from flask import Flask
from flask.json import JSONEncoder
import decimal

class DecimalJSONEncoder(JSONEncoder):
    def default(self, o):
        if isinstance(o, decimal.Decimal):
            return float(o)
        return super().default(o)

app = Flask(__name__)
app.json_encoder = DecimalJSONEncoder

为什么不用 json.dumps(..., cls=...) 手动序列化

你当然可以绕过 jsonify,自己调用 json.dumps(data, cls=DecimalEncoder) 再包装成 Response,但这会带来三个实际问题:

  • 丢失 jsonify 自动设置的 Content-Type: application/json 和状态码处理逻辑
  • 无法复用 Flask 对嵌套对象、Noneenum 等的默认编码行为,容易引发新错误
  • 团队协作中,每个接口都得显式写 cls=...,维护成本陡增;而全局注册一次 JSONEncoder 后,所有 jsonify 调用自动生效

更关键的是:如果你用了 Flask-RESTful、Flask-JWT-Extended 等扩展,它们内部也依赖 jsonify,手动 dumps 无法覆盖这些路径。

精度与兼容性要注意的细节

float(o) 看似简单,但有隐含风险:

  • Decimal('0.1')float 后是 0.10000000000000000555...,前端 JS 解析时可能显示为 0.10000000000000000555(尤其在金融类金额展示中不可接受)
  • 若需保留小数位(如金额统一两位),应在业务层做 o.quantize(decimal.Decimal('0.01')) 后再转 float,而不是在 JSONEncoder 里硬编码格式化逻辑
  • 某些老版本 Flask(json_encoder 属性名是 json_encoder,新版(2.2+)推荐用 app.json.provider_class,但直接设 json_encoder 在当前主流版本(2.0–2.3)仍完全可用

真正容易被忽略的点:这个修复只解决 Decimal,如果数据里同时混有 datetimebytes、自定义 model 实例,default 方法必须逐个判断并处理,否则仍会崩 —— JSONEncoder.default 是唯一出口,别指望它“自动兜底”。

相关推荐:

如何在Python中使用asyncio.shield防止关键任务被取消?

asyncio.shield必须用于关键清理操作(如日志落盘、事务提交、连接关闭),防止被取消中断导致数据不一致;应只包裹协程本身(shield(coro)),而非Task,且内部子await需单独shield。 asyncio.shield什么时候必须用? 当一个asyncio.Task正在执行关...

为什么Python单例模式在多线程环境下会失效?

__new__中判空非原子操作会导致多线程重复创建实例;DCL通过无锁初判+加锁后复判解决,需配合__init__幂等防护。 __new__中的if判断不是原子操作 线程A执行到ifcls._instanceisNone时为True,刚准备调用super().__new__(cls),此时被调度挂起...

如何修复Python aiohttp请求时出现的ClientPayloadError?

ClientPayloadError表明服务端提前关闭连接,非客户端代码错误;常见于服务端超时、拒绝大响应或代理截断,需通过抓包、检查响应头、服务端日志及添加读取超时和异常处理来定位解决。 ClientPayloadError通常意味着服务端提前关闭了连接 这个错误不是客户端代码写错了,而是aioh...

如何在Python中自定义NumPy的打印格式以方便调试?

np.set_printoptions()可直接控制NumPy数组显示格式;默认格式因小数位不一致、科学计数法混用及自动截断而影响调试效率;关键参数需协同设置,如precision控制有效位数、suppress禁用科学计数法、threshold避免省略、linewidth防换行混乱、floatmod...

为什么在大型Python项目中推荐使用Monorepo环境管理?

Monorepo是应对跨子包频繁修改、版本对齐成本高、CI耗时爆炸等痛点的止损方案;需统一依赖管理、确保本地与CI环境一致,并严守子包独立测试边界。 Monorepo不是“更先进”,而是对特定规模和协作模式的项目更可控——当Python项目中出现跨子包频繁修改、版本对齐成本高、CI耗时爆炸或本地开发...

为什么Python爬虫在解析复杂表格时推荐使用Pandas库?

pandas.read_html能自动解析HTML表格并修复合并单元格、多级表头等结构,但需合理配置match、header、skiprows等参数,并处理JS渲染、数据类型、空值等问题,否则易导致列错位、类型错误等隐患。 因为pandas.read_html能直接把HTML表格转成DataFram...

为什么在Python项目中推荐使用Poetry管理包依赖?

poetryinstall与pipinstall-rrequirements.txt的本质差异在于:前者是“解析后装”,基于poetry.lock中已验证的完整依赖图确保版本兼容并自动激活专属虚拟环境;后者是“盲装”,仅按文本顺序安装、不解析依赖冲突、不隔离环境,易导致静默覆盖和全局污染。 因为pi...