Question

我在python中构建一个端点，它将返回包含每个类别中所有项目的目录。我想基于外键约束在我的数据库中连接两个表（目录和项），并以JSON格式输出。

目前我已尝试

@app.route('/catalog/JSON/')
@login_required
  def getCatalog():
  categories = session.query(Category).join(Item).all()
  return jsonify(Catalog=[r.serializable for r in categories])

但是，这只返回项目数据和有关目录的数据，例如名称。

我当前的模特

class Category(Base):
__tablename__ = 'category'
id = Column(Integer, primary_key=True)
name = Column(String(32), nullable=False)

@property
def serializable(self):
    return {'id': self.id, 'username': self.username}

class Item(Base):
__tablename__ = 'item'
id = Column(Integer, primary_key=True)
name = Column(String(32), nullable=False)
description = Column(String(255))
user_id = Column(Integer, ForeignKey('user.id'))
user = relationship(User)
category_id = Column(Integer, ForeignKey('category.id'))
category = relationship(Category)

@property
def serializable(self):
    return {
        'id': self.id,
        'name': self.name,
        'description': self.description,
        'category_id': self.category_id,
        'user_id': self.user_id
    }

我是新手，所以我不能100％确定我想要完成的是框架或sqlalchemy已经解决的问题。

Answer 1

通过在category = relationship(Category)中声明Item，Item的实例具有与数据库中正确行对应的category属性。在后台，如有必要，这将从数据库中获取行。在处理项目集合时应该小心，因为它可能导致为每个项目调用一次数据库 - 这称为n + 1问题。

所以回答问题＆＃34;如何在序列化项目中包含self.category？＆＃34;，你可以简单地写一下：

class Item(Base):
    ...

    @property
    def serializable(self):
        return {
            'id': self.id,
            'name': self.name,
            ...
            'category': self.category.serializable
        }

但这可能不是一个好主意，因为在编写item.serializable时可能会意外地导致额外的数据库调用。

在任何情况下，我们确实要列出类别中的所有项目，因此我们需要在另一个方向上使用外键关系。这是通过在关系中添加backref参数来完成的：

category = relationship(Category, backref='items')

现在Category个实例将具有items属性。然后，这里是如何写getCatalog：

def getCatalog():
    categories = Session().query(Category).options(joinedload(Category.items)).all()
    return dict(Catalog=[dict(c.serializable, items=[i.serializable
                                                     for i in c.items])
                         for c in categories])

此处.options(joinedload(Category.items))执行SQL JOIN以提前获取项目，以便c.items不会导致额外的数据库查询。（感谢Ilja）

以下是完整演示的完整代码：

from sqlalchemy import create_engine, Column, Integer, String, ForeignKey
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker, relationship, joinedload

engine = create_engine('sqlite://', echo=True)

Session = sessionmaker(bind=engine)

Base = declarative_base()


class Category(Base):
    __tablename__ = 'category'
    id = Column(Integer, primary_key=True)
    name = Column(String(32), nullable=False)

    @property
    def serializable(self):
        return {'id': self.id, 'name': self.name}


class Item(Base):
    __tablename__ = 'item'
    id = Column(Integer, primary_key=True)
    name = Column(String(32), nullable=False)
    category_id = Column(Integer, ForeignKey('category.id'))
    category = relationship(Category, backref='items')

    @property
    def serializable(self):
        return {'id': self.id, 'name': self.name}


Base.metadata.create_all(engine)

category1 = Category(id=1, name='fruit')
category2 = Category(id=2, name='clothes')
session = Session()
session.add_all([category1, category2,
                 Item(id=1, name='apple', category=category1),
                 Item(id=2, name='orange', category=category1),
                 Item(id=3, name='shirt', category=category2),
                 Item(id=4, name='pants', category=category2)])
session.commit()


def getCatalog():
    categories = Session().query(Category).options(joinedload(Category.items)).all()
    return dict(Catalog=[dict(c.serializable, items=[i.serializable
                                                     for i in c.items])
                         for c in categories])


from pprint import pprint

pprint(getCatalog())

回显的SQL显示只有一个SELECT被发送到数据库。实际输出是：

{'Catalog': [{'id': 1,
              'items': [{'id': 1, 'name': 'apple'},
                        {'id': 2, 'name': 'orange'}],
              'name': 'fruit'},
             {'id': 2,
              'items': [{'id': 3, 'name': 'shirt'}, {'id': 4, 'name': 'pants'}],
              'name': 'clothes'}]}

使用SQLAlchemy和Flask jsonify以JSON格式返回连接表

1 个答案: