如何将 Flask-SQLAlchemy 查询结果转换为 JSON 格式
在使用 Flask-SQLAlchemy 开发 Web 应用时，经常需要将数据库查询结果以 JSON 格式返回给前端。本文将介绍几种常用的方法来实现这一需求。
方法一：使用 SQLAlchemy 内置的序列化方法
Flask-SQLAlchemy 模型可以通过定义 to_dict() 方法来实现序列化：
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy()
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), unique=True, nullable=False)
email = db.Column(db.String(120), unique=True, nullable=False)
def to_dict(self):
return {
'id': self.id,
'username': self.username,
'email': self.email
}使用示例：
# 查询单个对象 user = User.query.first() user_json = user.to_dict() # 查询多个对象 users = User.query.all() users_json = [user.to_dict() for user in users]
方法二：使用 Marshmallow 库
Marshmallow 是一个强大的序列化/反序列化库，可以与 Flask-SQLAlchemy 完美集成：
from flask import Flask from flask_sqlalchemy import SQLAlchemy from marshmallow_sqlalchemy import SQLAlchemyAutoSchema app = Flask(__name__) app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///test.db' db = SQLAlchemy(app) class User(db.Model): id = db.Column(db.Integer, primary_key=True) username = db.Column(db.String(80), unique=True, nullable=False) email = db.Column(db.String(120), unique=True, nullable=False) class UserSchema(SQLAlchemyAutoSchema): class Meta: model = User load_instance = True user_schema = UserSchema() users_schema = UserSchema(many=True)
使用示例：
# 序列化单个对象 user = User.query.first() result = user_schema.dump(user) # 序列化多个对象 users = User.query.all() result = users_schema.dump(users)
方法三：使用 Flask 的 jsonify 函数
对于简单的场景，可以直接使用 Flask 的 jsonify 函数：
from flask import jsonify
@app.route('/users')
def get_users():
users = User.query.all()
return jsonify([{
'id': user.id,
'username': user.username,
'email': user.email
} for user in users])处理关系字段
当模型包含关系字段时，需要在序列化方法中特别处理：
class Post(db.Model):
id = db.Column(db.Integer, primary_key=True)
title = db.Column(db.String(100))
user_id = db.Column(db.Integer, db.ForeignKey('user.id'))
user = db.relationship('User', backref='posts')
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), unique=True, nullable=False)
email = db.Column(db.String(120), unique=True, nullable=False)
def to_dict(self):
return {
'id': self.id,
'username': self.username,
'email': self.email,
'posts': [{'id': post.id, 'title': post.title} for post in self.posts]
}最佳实践建议
对于简单项目，使用方法一或方法三即可满足需求
对于复杂的数据结构和关系，推荐使用 Marshmallow
考虑性能因素，避免在循环中执行数据库查询
注意处理日期时间等特殊类型的序列化
根据 API 需求选择合适的序列化深度
选择合适的方法取决于项目的具体需求和复杂度。希望本文能帮助你更好地处理 Flask-SQLAlchemy 的 JSON 序列化问题。