Flask 两个常用方法 json.dumps 和 flask.jsonify之间的区别和用法

在本文中，我们将介绍 Flask 中的两个常用方法 json.dumps 和 flask.jsonify，并比较它们之间的区别和用法。

阅读更多：Flask 教程

json.dumps 方法

json.dumps 是 Python 中的内置方法，用于将 Python 对象转换为 JSON 字符串。在 Flask 中使用 json.dumps 可以将处理后的数据返回给客户端。

示例代码如下：

from flask import Flask, json

app = Flask(__name__)

@app.route('/')
def hello_world():
    data = {'name': 'Alice', 'age': 25}
    json_data = json.dumps(data)
    return json_data

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

上述代码中，定义了一个简单的 Flask 应用，当访问根路径时，将一个包含姓名和年龄的字典转换为 JSON 字符串，并返回给客户端。例如，返回的结果可能是 {"name": "Alice", "age": 25}。

使用 json.dumps 的优点是灵活性高，可以对复杂的数据结构进行转换。然而，缺点是需要手动设置响应头为 application/json，并且需要手动进行字符串拼接。

flask.jsonify 方法

flask.jsonify 是 Flask 提供的一个辅助函数，用于将 Python 对象转换为 JSON 格式并设置响应头为 application/json。

示例代码如下：

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/')
def hello_world():
    data = {'name': 'Alice', 'age': 25}
    return jsonify(data)

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

上述代码中，使用 jsonify 函数将一个包含姓名和年龄的字典转换为 JSON 格式，并自动设置响应头为 application/json。结果与使用 json.dumps 相同，为 {"name": "Alice", "age": 25}。

使用 flask.jsonify 的优点是简单方便，不需要手动设置响应头和进行字符串拼接。Flask 会自动为返回的数据添加响应头并进行格式转换。

区别比较

jsonify 是 flask.json 模块提供的一个辅助函数，它使用了 Flask 的 Response 类来实现 JSON 的转换和响应。而 json.dumps 则是 Python 的标准库方法。

用法上的区别：
- 使用 json.dumps 需要手动设置响应头和进行字符串拼接；
- 使用 flask.jsonify 则不需要手动设置响应头和进行字符串拼接。
返回结果的区别：
- json.dumps 返回的是一个 JSON 格式的字符串；
- flask.jsonify 返回的是一个包装好的 Response 对象，其中包含了 JSON 格式的数据和正确的响应头。

需要注意的是，如果使用 json.dumps 返回 JSON 格式的字符串，Flask 不会自动添加正确的响应头，这可能会导致客户端无法正确解析。

总结

本文介绍了 Flask 中的两个方法 json.dumps 和 flask.jsonify，并对它们的区别进行了比较。使用 json.dumps 需要手动设置响应头和进行字符串拼接，而使用 flask.jsonify 则简单方便，不需要手动设置响应头和进行字符串拼接。建议在开发 Flask 应用时使用 flask.jsonify，以提高开发效率并确保返回的数据能被正确解析。