了解 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 序列化。

以下是何時使用每種方法的摘要：