在flask中使用jsonify和json.dumps的區別

flask提供了jsonify函數供用戶處理返回的序列化json數據,而python自帶的json庫中也有dumps方法可以序列化json對象,那麼在flask的視圖函數中return它們會有什麼不同之處呢?想必開始很多人和我一樣搞不清楚,只知道既然框架提供了方法就用,肯定不會錯。但作爲開發人員,我們需要弄清楚開發過程中各種實現方式的特點和區別,這樣在我們面對不同的需求時才能做出相對合理的選擇,而不是千篇一律地使用自己熟悉的。下面我就jsonify和json.dumps的區別這一問題簡單探討一下。

一、實驗

python的flask框架爲用戶提供了直接返回包含json格式數據響應的方法,即jsonify,在開發中會經常用到。如下一段簡單的flask後端代碼,服務端視圖函數根據請求參數返回json格式的數據到客戶端。

from flask import Flask
from flask import jsonify
from flask import Response
 
 
app = Flask(__name__)
 
 
@app.route('/hello/<name>/<words>',methods=['GET'])
def hello(name,words):
    return jsonify({'name':name,'words':words})#也可以傳入key=value形式的參數,如jsonify(name=name,words=words)
 
 
if __name__ == '__main__':
    app.run()

用chrome瀏覽器訪問得到的頁面如下圖:
在這裏插入圖片描述
在這裏插入圖片描述

現在我們改爲使用python自帶的json庫json.dumps作爲視圖函數的直接返回值,代碼如下:

from flask import Flask
from flask import jsonify
from flask import Response
 
 
app = Flask(__name__)
 
 
@app.route('/hello/<name>/<words>',methods=['GET'])
def hello(name,words):
    return json.dumps({'name':name,'words':words})
 
 
if __name__ == '__main__':
    app.run()

PS:直接返回json.dumps的結果是可行的,因爲flask會判斷並使用make_response方法自動構造出響應,只不過響應頭各個字段是默認的。若要自定義響應字段,則可以使用make_response或Response自行構造響應。用chrome訪問的響應頁面如下圖。
在這裏插入圖片描述
在這裏插入圖片描述
二、分析

1.Content-Type有區別

jsonify的作用實際上就是將我們傳入的json形式數據序列化成爲json字符串,作爲響應的body,並且設置響應的Content-Type爲application/json,構造出響應返回至客戶端。jsonify的部分源碼如下:

def jsonify(*args, **kwargs):
    if __debug__:
        _assert_have_json()
    return current_app.response_class(json.dumps(dict(*args, **kwargs),
        indent=None if request.is_xhr else 2), mimetype='application/json')

可以看出jsonify實際上也是使用了json.dumps來序列化json形式的數據,作爲響應正文返回。indent表示json格式化的縮進,若是Ajax請求則不縮進(因爲一般Ajax數據沒必要直接展示),否則縮進2格。但想必從第一部分的實驗結果我們已經看出來了,使用jsonify時響應的Content-Type字段值爲application/json,而使用json.dumps時該字段值爲text/html。Content-Type決定了接收數據的一方如何看待數據,如何處理數據,如果是application/json,則可以直接當做json對象處理,若是text/html,則還要將文本對象轉化爲json對象再做處理(個人理解,有誤請指正)。

2.接受參數有區別

jsonify可以接受和python中的dict構造器同樣的參數,如下圖。
在這裏插入圖片描述
而json.dumps比jsonify可以多接受list類型和一些其他類型的參數。但我試了一下,形式爲key1=value1,[key2=value2,…]這樣的參數是不行的,會報出“TypeError: dumps() takes exactly 1 argument (0 given)”這一錯誤,而jsonify不會報錯並能正常返回數據。

最後,我們可以使用flask中的make_response方法或者直接通過Response類,通過設置mimetype參數來達到和使用jsonify差不多的效果,但少寫點代碼何樂而不爲呢?況且簡潔一點更不容易出錯,參數越多調試和維護就越麻煩。當然,使用哪個並不是絕對的,必要時要根據前端的數據處理方式來決定。

更多關於jsonify的知識請參考官方文檔:http://flask.pocoo.org/docs/0.12/api/#module-flask.json

更多關於json.dumps的知識參考官方文檔:https://docs.python.org/2/library/json.html#module-json

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章