首先运行如下代码:
from flask import Flask, jsonify
app = Flask(__name__)
tasks = [
{
'id': 1,
'title': u'订阅 python_mastery 专栏',
'description': u'专栏Link: https://xiaozhuanlan.com/python_mastery'
},
{
'id': 2,
'title': u'订阅 pythonml 专栏',
'description': u'专栏Link: https://xiaozhuanlan.com/pythonml'
}
]
@app.route('/api/v1.0/tasks', methods=['GET'])
def get_tasks():
return jsonify({'tasks': tasks})
if __name__ == '__main__':
app.run(port=8888, debug=True, host='0.0.0.0')
通过请求 http://localhost:8888/api/v1.0/tasks 发现返回json数据,那为啥不用python自带的json模块返回json数据呢?
其实是一样
其实,jsonify 在处理数据过程中,对数据做 JSON 序列化处理时,用的是 itsdangerous 模块里的 JSON ,让我们看一下,这个模块里的 JSON 是如何引入的(ps:此处源码来源未找到)
try:
import simplejson as json
except ImportError:
import json
它会先尝试引入simplejson,如果没有安装这个模块,则引入 Python 原生模。
在Flask框架中,引入过程如下
from itsdangerous import json as _json
对于数据的序列化处理,用的正是 _json
Content-Type 的差别
前面讲到,jsonify 和 json 是殊途同归,那么为什么要费周折绕这么一圈呢?
肯定存在一个合理的原因让 jsonify存在的有意义。
这个原因就是 Content-Type
看下面两段代码
第一段代码
## jsonify
import json
from flask import Flask, jsonify
app = Flask(__name__)
@app.route('/json')
def test_json():
data = {'name': 'lilei', 'age': 30}
return jsonify(data)
app.run(host="0.0.0.0", port=9877)
在浏览器里输入http://127.0.0.1:9877/json, 得到的结果是
{"age":30,"name":"lilei"}
第二段代码:
## json
import json
from flask import Flask, jsonify
app = Flask(__name__)
@app.route('/json')
def test_json():
data = {'name': 'lilei', 'age': 30}
return json.dumps(data)
app.run(host="0.0.0.0", port=9877)
在浏览器里输入http://127.0.0.1:9877/json, 得到的结果是
{"name": "lilei", "age": 30}
从内容上看,两种方法没有区别。
但是使用 jsonify 时,返回的 http response 的 Content-Type 是
Content-Type: application/json
而使用json.dumps时,Content-Type则是
Content-Type: text/html; charset=utf-8
既然返回的是 json 数据,那么自然要指明 Content-Type 是 application/json , 这样做是符合 HTTP 协议的规定的,这就是使用 jsonify 的原因之一。
减小数据量
使用 jsonify 除了让返回的 http response 符合 HTTP 协议,同时也对数据做了压缩处理,让数据体积更小。
仔细比较上面两种方法返回的数据,虽然内容相同,但 jsonify 返回的数据,每个 key-value 对之间的逗号,和每个 key 与 value 之间的冒号后面都是没有空格的,而 json.dumps 返回的数据里,却在逗号和冒号后面存在空格,因此即便内容相同,jsonify 返回的数据体积更小,更节省流量。
其实,json.dumps 也可以将这些不必要的空格去掉,看下面的代码
import json
data = {'name': 'lilei', 'age': 30}
print(json.dumps(data, separators=(',', ':')))
print(json.dumps(data))
输出结果为
{"name":"lilei","age":30}
{"name": "lilei", "age": 30}
只需要在 dumps 参数里指定 separators 即可,其实在 jsonify 里就是这么干的。