Numpy 将用户构造的JSON编码器传递到Flask的jsonify函数

在flask的web应用程序中，JSON化响应数据是一个常见的操作。 Flask自带jsonify函数，可以将Python对象转换为JSON格式输出，但是对于某些特殊的对象，我们需要自定义JSON编码器才能让这些对象被正确地转换为JSON格式。

在本文中，我们将介绍如何将自己编写的JSON编码器传递给Flask的jsonify函数，以更好地应对复杂情况。

阅读更多：Numpy 教程

什么是JSON编码器

JSON编码器是将Python对象转换为JSON格式的函数。在默认情况下，JSON模块会将Python对象转换为JSON格式。但是，如果我们定义了一些自定义对象，JSON编码器可能无法正确地将它们转换为JSON格式。

例如，在处理numpy数组时，如果我们只使用默认的JSON编码器，将会得到一些不可读的结果，如下面的代码所示：

import numpy as np
from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/')
def hello_world():
    a = np.array([1, 2, 3])
    return jsonify(a)

if __name__ == '__main__':
    app.run()

我们得到了以下输出：

{
  "shape": [
    3
  ],
  "strides": null,
  "data": "AQAAAAIAAAABAAAAAQAAAA==",
  "typestr": "<i8",
  "descr": [
    [
      "",
      "<i8"
    ]
  ],
  "itemsize": 8,
  "aligned": true
}

这显然不是我们想要的结果。为了解决这个问题，我们需要定义一个能够正确处理numpy数组的JSON编码器。

如何编写自己的JSON编码器

为了编写自己的JSON编码器，我们需要了解Python的JSON模块。JSON模块提供了两个相关的函数：

dump(obj, fp, …, **kwargs)：将Python对象转换为JSON格式，然后将其写入文件对象fp中。
dumps(obj, …, **kwargs)：将Python对象转换为JSON格式的字符串。

在默认情况下，JSON模块提供了一些默认的编码器，可以将Python中的大部分对象转换为JSON格式。如果你需要支持自定义对象，你需要定义编码器，即继承json.JSONEncoder类，重写它的default()方法。

例如，以下是一个支持numpy数组的自定义JSON编码器：

import json
import numpy as np

class NumpyEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, np.ndarray):
            return obj.tolist()
        return json.JSONEncoder.default(self, obj)

在这个自定义编码器中，我们通过检查对象是否为numpy数组来处理numpy数组。如果是numpy数组，则将其转换为列表。否则，使用默认的JSON编码器来处理对象。

如何将自定义JSON编码器传递给Flask的jsonify函数

在Flask中，我们可以使用装饰器的方式将自定义JSON编码器传递给jsonify函数。具体来说，我们需要使用jsonify的自定义装饰器，即flask.json.JSONEncoder的子类。

使用以下代码将自定义编码器注册到flask应用程序中：

from flask.json import JSONEncoder

app = Flask(__name__)
app.json_encoder = NumpyEncoder

我们定义了一个自定义使用NumpyEncoder的JSON编码器，并将其附加到flask应用程序实例上。这样，在我们的程序中就可以正确地将numpy数组输出到JSON格式中。

import numpy as np
from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/')
def hello_world():
    a = np.array([1, 2, 3])
    return jsonify(a)

if __name__ == '__main__':
    app.run()

这时候程序的输出应该如下所示：