Flask-SQLAlchemy ORM對像如何序列化才能避免'Object of type User is not JSON serializable”錯誤？

Flask-SQLAlchemy ORM 對象序列化：避免“Object of type User is not JSON serializable”錯誤

在Flask 和SQLAlchemy 的結合使用中，直接將Object of type User is not JSON serializable錯誤。本文將詳細講解如何解決此問題。

問題：

使用Flask-SQLAlchemy 定義的數據庫模型(例如User模型)，通過User.query.all()獲取數據後，直接使用jsonify()函數返回給前端會引發上述錯誤。這是因為jsonify()無法直接序列化SQLAlchemy 的ORM 對象。

解決方案：

為了解決這個問題，需要將ORM 對象轉換為JSON 可序列化的格式，例如字典。 我們可以為模型類添加一個to_dict()方法：

 from sqlalchemy import Column, Integer, String
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy() # Assuming you've initialized your SQLAlchemy instance

class User(db.Model):
    __tablename__ = 'users' # Replace 'users' with your table name
    id = Column(Integer, primary_key=True)
    app_key = Column(String(50), unique=True)
    secret = Column(String(120), unique=True)

    def __init__(self, app_key=None, secret=None):
        self.app_key = app_key
        self.secret = secret

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

然後，在Flask 路由函數中使用to_dict()方法將對象轉換為字典列表，再使用jsonify()返回：

 from flask import Flask, jsonify

app = Flask(__name__)
# ... (your database configuration) ...

@app.route("/users")
def get_users():
    users = User.query.all()
    return jsonify([user.to_dict() for user in users])

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

通過to_dict()方法，將User對象轉換為JSON 可序列化的字典，從而避免了序列化錯誤，確保正確的數據返回給前端。 這種方法是處理SQLAlchemy ORM 對象序列化的常用且有效的方式。

以上是Flask-SQLAlchemy ORM對像如何序列化才能避免'Object of type User is not JSON serializable”錯誤？的詳細內容。更多資訊請關注PHP中文網其他相關文章！