了解 Flask 中的 JSONify()、to_dict()、make_response() 和 SerializerMixin-Python教程-PHP中文网

Understanding JSONify(), to_dict(), make_response(), and SerializerMixin in Flask

Flask 确实提供了多种将数据转换为响应的工具，从将 Python 对象转换为 JSON 到创建结构化 HTTP 响应。在这篇文章中，我们将探讨 jsonify()、to_dict()、make_response() 和 SerializerMixin，它们是在 Flask 中处理数据响应的四个有用的函数和工具。了解这些工具将有助于创建更好的 API 和有效的数据管理。

jsonify()
它是一个内置的 Flask 函数，可将 Python 数据结构转换为 JSON 格式，这是一种广泛用于 API Web 开发的轻量级数据交换格式。该函数自动将响应 Content-Type 设置为 application/json 并返回 Flask 响应对象，非常适合在 REST API 中返回数据。

示例：

from flask import jsonify

@app.route('/data')
def get_data():
    data = {"message": "Hello, World!", "status": "success"}
    return jsonify(data)

登录后复制

这里，jsonify(data) 将字典数据转换为 JSON 格式并将其设置为响应正文。当您需要返回小型且定义良好的数据时，此函数非常有用，因为它会为您处理 JSON 转换和响应格式设置。需要注意的是，jsonify() 可以很好地处理简单的数据类型，但不直接支持复杂的对象，例如 SQLAlchemy 模型，无需进行一些转换（如使用 to_dict()）。

to_dict()
它不是原生 Flask 函数，但通常在模型类中用于将 SQLAlchemy 或其他对象关系映射 (ORM) 模型实例表示为字典。将模型属性转换为字典使数据更容易转换为 API 响应的 JSON 格式。
示例：

class Student(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), nullable=False)

    def to_dict(self):
        return {
            "id": self.id,
            "username": self.username
        }

@app.route('/user/<int:id>')
def get_student(id):
    student = Student.query.get(id)
    return jsonify(student.to_dict()) if student else jsonify({"error": "Student not found"}), 404

登录后复制

to_dict() 方法允许您指定要包含在响应中的确切数据，从而提供了灵活性。它对于隐藏敏感数据（如密码）和有选择地仅显示必要的属性非常有用。

make_response()
它是一个 Flask 实用函数，允许您创建自定义 HTTP 响应。 jsonify() 简化了 JSON 数据响应，而 make_response() 允许您控制响应的每个部分，包括状态代码、标头和数据格式。

示例：

from flask import make_response, jsonify
from models import db

class Student(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    username = db.Column(db.String(80), nullable=False)

    def to_dict(self):
        return {
            "id": self.id,
            "username": self.username
        }

@app.route('/student/<int:id>', methods=['GET'])
def get_student(id):
    # Query the database for the student
    student = Student.query.get(id)

    # If student is found, return data with a 200 status
    if student:
        response_data = {
            "message": "Student found",
            "data": student.to_dict()
        }
        return make_response(jsonify(response_data), 200)

    # If student is not found, return a structured error response with a 404 status
    error_data = {
        "error": "Student not found",
        "student_id": id,
        "status_code": 404
    }
    return make_response(jsonify(error_data), 404)

登录后复制

这里，make_response() 允许控制状态代码和响应正文格式。当响应对象的控制至关重要时，这种灵活性是理想的选择。

序列化器Mixin
它来自 sqlalchemy-serializer 库，是用于自动化 SQLAlchemy 模型序列化的强大工具。它提供了一个 to_dict() 方法，可以处理包括模型之间关系的复杂数据类型，并包含一个 serialize_rules 属性来控制字段序列化。

用法：

from flask import jsonify

@app.route('/data')
def get_data():
    data = {"message": "Hello, World!", "status": "success"}
    return jsonify(data)

登录后复制

SerializerMixin 自动将 SQLAlchemy 模型转换为字典，这在处理复杂模型和关系时非常有用。使用serialize_rules，您可以动态包含或排除字段或关系，这可以节省您为每个模型编写自定义 to_dict 方法的时间。

比较及其关联
这些工具在构建 Flask API 中都有其自己的位置。 jsonify() 和 make_response() 是创建 JSON 和自定义响应的基本 Flask 函数，而 to_dict() 和 SerializerMixin 则专注于将模型实例转换为字典，以便更轻松地进行 JSON 序列化。

以下是何时使用每种方法的摘要：