TypeError: Object of type ‘Decimal‘ is not JSON serializable

错误

TypeError: Object of type ‘Decimal’ is not JSON serializable

场景

该错误是在Python3中使用Flask的报错，之前代码是运行正常的，时过几年后再次安装部署，确出现问题。

分析

经过分析发现依旧是版本依赖导致的更新问题。最近在维护老项目过程中发现这个问题太复杂，尤其是在Python和JS项目尤其明显。

该问题的核心问题是Flask使用的json库不支持解析Decimal对象，原来代码是通过simplejson实现的。

从下面调用日志可以看出flask调用了系统的json库：
File “/usr/local/lib/python3.6/site-packages/flask/json/init.py”, line 321, in jsonify
dumps(data, indent=indent, separators=separators) + ‘\n’,
File “/usr/local/lib/python3.6/site-packages/flask/json/init.py”, line 179, in dumps
rv = _json.dumps(obj, kwargs)
File "/usr/local/lib/python3.6*/json***/init.py", line 238, in dumps
**kw).encode(obj)
File “/usr/local/lib/python3.6/json/encoder.py”, line 199, in encode
chunks = self.iterencode(o, _one_shot=True)
File “/usr/local/lib/python3.6/json/encoder.py”, line 257, in iterencode
return _iterencode(o, 0)

初步结论

系统库不支持对Decimal类型的序列化。

原因分析

程序运行版本：
Flask 1.0.2 版本历史
itsdangerous 2.0.1 版本历史
从Flask日志中可以看出：Flask 2.0.0 开始不再支持使用simplejson，实际好像更早，实际情况是1.1.2版本开始就不支持了，参考这儿。

经过检查发现Flask版本还是可以工作的，检查发现Falsk使用simplejson依赖itsdangerous库，而源代码requirements.txt没有指定itsdangerous 版本！

经过确认，发现本地安装了最新的itsdangerous 2.0.1库，通过itsdangerous 的版本历史发现，itsdangerous 库在2.0开始不再支持simplejson库！

为何不使用simplejson是因为高手们认为simplejson不比内置json库好，如果需要使用，给出的解决方案是：

from simplejson import JSONEncoder

app.json_encoder = JSONEncoder

至此，问题根因是程序员没有指定开发时刻的itsdangerous 版本，导致的问题。

问题解决

既然问题是因为依赖库版本升级导致无法运行，那么替换合适的库即可。此问题是因为Flask在1.0版本的时候是会使用simplejson的，在2.0之后，停止使用simplejson，且itsdangerous也是一样。因此无论是Flask版本还是itsdangerous版本在1.0时代写的代码，到2.0时代就会出问题。

既然是老代码，就尽量不修改代码了，在requirements.txt中添加

Flask==1.0.2
itsdangerous ==1.02

再通过pip3安装一下即可。

PS：最近在维护老代码过程中，发现对守墓的程序员来说，这是一个噩梦，尤其是开发人员对版本依赖的管理不规范（Java的依赖是绝对的，好像好一点，想Python的自动依赖，Node.js的模糊依赖），或者代码库升级过程中考虑不够仔细，都会导致老代码无法运行。随着项目使用的在线库越来越多，如果版本依赖出现问题，就会很难烦心。有没有好办法管理呢？欢迎留言讨论，谢谢！