flask-sqlalchemy orm 對象序列化:避免“Object of type user is not json serializable”錯誤
在 Flask 和 SQLAlchemy 的結合使用中,直接將 ORM 對象序列化為 JSON 經常會導致 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 對象序列化的常用且有效的方式。
? 版權聲明
文章版權歸作者所有,未經允許請勿轉載。
THE END