聊一聊 Flask 的 jsonify

首先我们来看一段 Python 代码

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(debug=True)

在这段代码里面,我们看到了今天的主角 jsonify

Flask 框架里,可以用 jsonify 返回 json 数据,但是为什么不用 Python 自带的 json 模块返回 JSON 数据呢?


其实是一样

其实,jsonify 在处理数据过程中,对数据做 JSON 序列化处理时,用的是 itsdangerous 模块里的 JSON ,让我们看一下,这个模块里的 JSON 是如何引入的

try:
    import simplejson as json
except ImportError:
    import json

它会先尝试引入simplejson,如果没有安装这个模块,则引入 Python 原生模。

在Flask框架中,引入过程如下

from itsdangerous import json as _json

对于数据的序列化处理,用的正是 _json.


Content-Type 的差别

前面讲到,jsonifyjson 是殊途同归,那么为什么要费周折绕这么一圈呢?

肯定存在一个合理的原因让 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 responseContent-Type

Content-Type: application/json

而使用json.dumps时,Content-Type则是

Content-Type: text/html; charset=utf-8

既然返回的是 json 数据,那么自然要指明 Content-Typeapplication/json , 这样做是符合 HTTP 协议的规定的,这就是使用 jsonify 的原因之一。


减小数据量

使用 jsonify 除了让返回的 `http response符合 HTTP 协议,同时也对数据做了压缩处理,让数据体积更小。

仔细比较上面两种方法返回的数据,虽然内容相同,但 jsonify 返回的数据,每个 key-value 对之间的逗号,和每个 keyvalue 之间的冒号后面都是没有空格的,而 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 里就是这么干的。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容