当前位置：首页 > 文章列表 > 文章 > python教程 > 了解 Flask 中的 JSONify()、to_dict()、make_response() 和 SerializerMixin

了解 Flask 中的 JSONify()、to_dict()、make_response() 和 SerializerMixin

来源：dev.to 2024-11-04 13:09:53 0浏览收藏

本篇文章主要是结合我之前面试的各种经历和实战开发中遇到的问题解决经验整理的，希望这篇《了解 Flask 中的 JSONify()、to_dict()、make_response() 和 SerializerMixin》对你有很大帮助！欢迎收藏，分享给更多的需要的朋友学习~

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/')
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/', 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 sqlalchemy_serializer import SerializerMixin

class Product(db.Model, SerializerMixin):
    __tablename__ = 'products'
    serialize_rules = ('-category',)  # Exclude category from serialization

    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(80), nullable=False)
    category = db.Column(db.String(80))

# Usage in a route
@app.route('/product/')
def get_product(id):
    product = Product.query.get(id)
    return jsonify(product.to_dict()) if product else jsonify({"error": "Product not found"}), 404

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

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

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