Flask Marshmallow/SqlAlchemy：序列化多对多关系

Posted 2023-03-23

【中文标题】Flask Marshmallow/SqlAlchemy：序列化多对多关系

【英文标题】：Flask Marshmallow/SqlAlchemy: Serializing many-to-many relationships

【发布时间】：2017-01-25 18:20:24

【问题描述】：

我正在使用 Flask、flask-sqlalchemy 和 flask-marshmallow 构建一个小型 REST api。对于某些请求，我想返回一个包含我的 sqlalchemy 对象的 json 序列化响应。但是，当使用多对多关系/辅助表时，我无法让序列化与急切加载的 sqlalchemy 对象一起工作。

这是一个简单的例子，或多或少是从flask-marshmallow docs复制/粘贴的：

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_marshmallow import Marshmallow
from sqlalchemy.orm import joinedload

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite://'

# Order matters: Initialize SQLAlchemy before Marshmallow
db = SQLAlchemy(app)
ma = Marshmallow(app)

secondary_foo = db.Table('secondary_foo',
                            db.Column('author_id', db.Integer, db.ForeignKey('author.id')),
                            db.Column('book_id', db.Integer, db.ForeignKey('book.id')))

class Author(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(255))

class Book(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    title = db.Column(db.String(255))
    authors = db.relationship('Author', secondary="secondary_foo", backref='books', lazy="joined")

class AuthorSchema(ma.ModelSchema):
    class Meta:
        model = Author

class BookSchema(ma.ModelSchema):
    #authors = ma.Nested(AuthorSchema) <-- Doesn't work, authors will be serialized to empty json object, instead of list of ids
    class Meta:
        model = Book


db.drop_all()
db.create_all()
author_schema = AuthorSchema()
book_schema = BookSchema()
author = Author(name='Chuck Paluhniuk')
book = Book(title='Fight Club')
book.authors.append(author)
db.session.add(author)
db.session.add(book)
db.session.commit()

s = BookSchema(many=True)

基于上面的代码，我可以急切地加载书籍并获取作者对象。但是在序列化时，深层对象被序列化为一个 ID 列表：

print(Book.query.filter(1==1).options(joinedload('authors')).all()[0].authors)
//--> [<__main__.Author object at 0x1043a0dd8>]

print(s.dump(Book.query.filter(1==1).options(joinedload('authors')).all()).data)
//--> ['authors': [1], 'title': 'Fight Club', 'id': 1]

这是我想要的结果：

print(s.dump(Book.query.filter(1==1).options(joinedload('authors')).all()).data)
//--> ['authors': ['name':'Chuck Paluhniuk', 'id':'1'], 'title': 'Fight Club', 'id': 1]

我该怎么做？

【参考方案1】：

在您的 BookSchema 中，您需要添加一个 Nested authors 字段，就像您拥有（但已注释掉）一样，但您需要使用 many keyword argument 指定它将是一个列表.

class BookSchema(ma.ModelSchema):

    # A list of author objects
    authors = ma.Nested(AuthorSchema, many=True)

    class Meta:
        model = Book

【讨论】：

太棒了，谢谢！我一定花了几个小时浏览烧瓶棉花糖、烧瓶 sqlalchemy、sqlalchemy 和棉花糖文档。

非常好的答案！我遇到了同样的问题......嵌套就像一个魅力。谢谢@Suever