Flask 如何在 Flask 中实现漂亮的 JSON 格式化

在本文中，我们将介绍如何在 Flask 中实现漂亮的 JSON 格式化。Flask 是一个轻量级的 Python Web 框架，它提供了一种简单和灵活的方式来构建 Web 应用程序。JSON 是一种常用的数据交换格式，Python 中的 Flask 框架可以很方便地处理 JSON 数据。

阅读更多：Flask 教程

什么是 JSON

JSON（JavaScript Object Notation）是一种轻量级的数据交换格式，常用于前后端之间的数据传输。它以键值对的形式表示数据，并使用大括号 { } 包围。例如，一个简单的 JSON 对象表示如下：

{
  "name": "John",
  "age": 25,
  "city": "New York"
}

JSON 中的值可以是字符串、数字、布尔值、数组、对象等。它是一种易于阅读和书写的格式，也易于解析和生成。

在 Flask 中使用 jsonify 函数

Flask 提供了一个名为 jsonify 的函数，可以将 Python 对象转换为 JSON 格式的数据，并设置正确的响应头。使用该函数可以很方便地在 Flask 中处理 JSON 数据。

from flask import Flask, jsonify

app = Flask(__name__)

@app.route("/")
def hello():
    data = {
        "name": "John",
        "age": 25,
        "city": "New York"
    }
    return jsonify(data)

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

在上面的例子中，我们定义了一个根路由 /，并返回一个包含名字、年龄和城市的 JSON 对象。jsonify 函数将该 Python 对象转换为 JSON 格式，并设置正确的响应头。

实现漂亮的 JSON 格式化

默认情况下，jsonify 函数生成的 JSON 数据是紧凑的，所有的键值对都在同一行。如果想要让 JSON 数据有更好的可读性，我们可以使用 Flask 提供的 JSONEncoder 类来自定义 JSON 的格式化方式。

from flask import Flask, jsonify
from flask.json import JSONEncoder

class PrettyJSONEncoder(JSONEncoder):
    def __init__(self, **kwargs):
        kwargs["ensure_ascii"] = False  
        kwargs["indent"] = 4  
        super().__init__(**kwargs)

app = Flask(__name__)
app.json_encoder = PrettyJSONEncoder

@app.route("/")
def hello():
    data = {
        "name": "John",
        "age": 25,
        "city": "New York"
    }
    return jsonify(data)

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

在上面的例子中，我们创建了一个自定义的 JSONEncoder 类 PrettyJSONEncoder，并在 app.json_encoder 中设置为默认的 JSONEncoder 类。我们在 PrettyJSONEncoder 类中通过修改 ensure_ascii 和 indent 参数的值来实现漂亮的 JSON 格式化。

ensure_ascii=False 表示允许非 ASCII 字符的输出，indent=4 表示每个缩进级别使用 4 个空格进行缩进。这样生成的 JSON 数据就会在每个键值对之间有空格换行，更加易读。

自定义函数实现漂亮的 JSON 格式化

除了使用 Flask 提供的 JSONEncoder 类外，我们还可以使用 Python 内置的 json 模块来自定义 JSON 的格式化方式。json.dumps 函数可以将 Python 对象转换为 JSON 格式的字符串，并可以通过 indent 参数来设置缩进的空格数。

from flask import Flask, jsonify
import json

app = Flask(__name__)

@app.route("/")
def hello():
    data = {
        "name": "John",
        "age": 25,
        "city": "New York"
    }
    return json.dumps(data, ensure_ascii=False, indent=4)

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

上面的例子中，我们使用了 Python 内置的 json.dumps 函数将 Python 对象转换为 JSON 格式的字符串，同时设置 ensure_ascii=False 和 indent=4 参数来实现漂亮的 JSON 格式化。

总结

本文介绍了如何在 Flask 中实现漂亮的 JSON 格式化。我们可以使用 Flask 提供的 jsonify 函数将 Python 对象转换为 JSON 数据，并使用自定义的 JSONEncoder 类来实现漂亮的 JSON 格式化。此外，我们还可以使用 Python 内置的 json 模块来实现相同的功能。通过合理的使用这些方法，我们可以使 JSON 数据更加易读和美观。