Flask-SQLAlchemyORM对象序列化失败：如何解决“User对象无法JSON序列化”错误？

使用Flask和Flask-SQLAlchemy时，直接序列化ORM对象（例如User对象）到JSON经常导致“User对象无法JSON序列化”错误。这是因为`jsonify`函数无法直接处理SQLAlchemy ORM对象。本文提供解决方案：为ORM模型添加`to_dict()`方法，将ORM对象转换为可序列化的字典，再使用`jsonify`函数序列化，从而避免`Object of type User is not JSON serializable`错误，实现Flask-SQLAlchemy ORM对象成功的JSON序列化。 文章将详细讲解问题原因及代码示例，帮助开发者快速解决此类问题。

Flask-SQLAlchemy ORM 对象序列化难题及解决方案

在使用 Flask 和 Flask-SQLAlchemy 进行数据库操作时，经常会遇到 ORM 对象序列化的问题，导致 Object of type User is not JSON serializable 这样的错误。本文将详细阐述此问题并提供解决方案。

问题描述：

当使用 Flask-SQLAlchemy 查询数据库并尝试直接将查询结果（ORM 对象）序列化为 JSON 时，会发生序列化错误。这是因为 Flask 的 jsonify 函数无法直接处理 SQLAlchemy 的 ORM 对象。

以下是一个示例代码片段，展示了如何定义一个名为 User 的数据库模型，并尝试直接序列化查询结果：

from sqlalchemy import Column, Integer, String
from lib.database import base

class User(base):  # 注意：类名首字母大写更符合 Python 规范
    __tablename__ = 'users'  # 表名通常为复数
    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 __repr__(self):
        return f'<user>' # 更清晰的表示</user>

尝试直接序列化：

from flask import jsonify

@app.route("/users")
def get_users():
    users = User.query.all()
    return jsonify(users) # 此处会报错

解决方案：

为了解决这个问题，需要将 ORM 对象转换为可序列化的字典。 我们可以为 User 类添加一个 to_dict() 方法：

class User(base):
    # ... (previous code) ...

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

然后，修改路由函数，使用 to_dict() 方法将 User 对象转换为字典列表，再使用 jsonify 序列化：

from flask import jsonify

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

通过这个方法，将数据库查询结果转换为可序列化的字典后，就可以成功返回 JSON 数据，避免序列化错误。 这是处理 Flask-SQLAlchemy ORM 对象序列化的常用且有效方法。

以上就是《Flask-SQLAlchemyORM对象序列化失败：如何解决“User对象无法JSON序列化”错误？》的详细内容，更多关于的资料请关注golang学习网公众号！