問題描述

在Flask中直接返回list或dict是不行的，如

from flask import Flask

app = Flask(__name__)


@app.route('/')
def root():
    t = {
        'a': 1,
        'b': 2,
        'c': [3, 4, 5]
    }
    return t

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

這樣訪問會直接提示

TypeError: 'dict' object is not callable

其原因是Flask并不會將list或dict默認轉(zhuǎn)換為json格式。

解決方法

HTTP返回json格式數(shù)據(jù)主要有兩個方面：

1. 數(shù)據(jù)本身為json格式；
2. Content-Type聲明為json格式。

使用標準庫json

比較常見的是采用標準庫json進行格式轉(zhuǎn)換：

from flask import Flask
import json

app = Flask(__name__)


@app.route('/')
def root():
    t = {
        'a': 1,
        'b': 2,
        'c': [3, 4, 5]
    }
    return json.dumps(t)

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

這樣當訪問時即能夠正常得到j(luò)son數(shù)據(jù)。但這么做有一個缺點，就是HTTP返回的Content-Type仍然是text/html，即HTTP認為內(nèi)容是HTML。

聲明Content-Type為json格式

在上面的解決方法上作一個加強，手動指定其Content-Type為application/json，通常采用的是修改Flask中的Response模塊：

from flask import Flask, Response
import json

app = Flask(__name__)


@app.route('/')
def root():
    t = {
        'a': 1,
        'b': 2,
        'c': [3, 4, 5]
    }
    return Response(json.dumps(t), mimetype='application/json')

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

這樣不僅HTTP返回的內(nèi)容是json，而且返回的Content-Type也是application/json了。

使用Flask的jsonify模塊

實際上flask已經(jīng)為json準備了專門的模塊：jsonify。jsonify不僅會將內(nèi)容轉(zhuǎn)換為json，而且也會修改Content-Type為application/json。

from flask import Flask, jsonify

app = Flask(__name__)


@app.route('/')
def root():
    t = {
        'a': 1,
        'b': 2,
        'c': [3, 4, 5]
    }
    return jsonify(t)

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

自定義Flask的Response，使用force_type()

對于某些特殊的情況，可能并不想每個返回json數(shù)據(jù)的方法都使用jsonify()包起來，那有沒有什么“非侵入式”的方法實現(xiàn)jsonify()的功能呢？其實是有的，不過這個方法相對比較高端。

Flask返回的內(nèi)容實際是Response對象，return語句的內(nèi)容實際是交給Response處理后才輸出由HTTP返回的；也就是說，之前直接返回dict報錯TypeError: 'dict' object is not callable也是Response干的。那么只需要在Response處理如dict等“非法”數(shù)據(jù)是，告訴Response該怎么做就好了，這里就是用到了其force_type()方法了，所有不能處理的數(shù)據(jù)，都由force_type()方法嘗試處理后，再決定報錯或通過。直接看例子吧。

from flask import Flask, Response, jsonify

class MyResponse(Response):
    @classmethod
    def force_type(cls, response, environ=None):
        if isinstance(response, (list, dict)):
            response = jsonify(response)
        return super(Response, cls).force_type(response, environ)

app = Flask(__name__)
app.response_class = MyResponse

@app.route('/')
def root():
    t = {
        'a': 1,
        'b': 2,
        'c': [3, 4, 5]
    }
    return t

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

或者還可以以繼承的方式來實現(xiàn)自定義Response，如：

from flask import Flask, Response, jsonify

class MyResponse(Response):
    @classmethod
    def force_type(cls, response, environ=None):
        if isinstance(response, (list, dict)):
            response = jsonify(response)
        return super(Response, cls).force_type(response, environ)

class MyFlask(Flask):
    response_class = MyResponse

app = MyFlask(__name__)

@app.route('/')
def root():
    t = {
        'a': 1,
        'b': 2,
        'c': [3, 4, 5]
    }
    return t

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

本文轉(zhuǎn)載自Flask設(shè)置返回json格式數(shù)據(jù)