FastAPI：如何每次访问SQLAlchemy模型字段时调用函数格式化

我有一个SQLAlchemy模型BusinessStorePhotoInfo，包含两个字段：phone（主键）和store_photo（图片链接）。需要将图片数据以base64格式返回而非图片链接本身，已创建并测试了getData函数，但无法实现每次访问store_photo时都通过该函数处理。尝试过hybrid_property、hybrid_method、root_validator及修改Schema，但均未成功，相关代码如下：

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Boolean, Column, String
from app.models.custom_field import getData

Base = declarative_base()

class BusinessStorePhotoInfo(Base):
    __tablename__ = "business_store_photo_info"

    phone = Column(String, primary_key=True)
    store_photo = Column(String)

# 尝试过的无效代码
# @hybrid_property
# def length(self):
#     return getData(self.store_photo)

# @hybrid_method
# def contains(self):
#     return getData(self.store_photo)

# @hybrid_method
# def intersects(self):
#     return getData(self.store_photo)

解决方案 #

方法1：用hybrid_property替换原字段访问逻辑 #

把数据库字段重命名（避免和对外暴露的属性冲突），然后通过hybrid_property定义store_photo，让访问时自动触发getData转换：

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, String
from sqlalchemy.ext.hybrid import hybrid_property
from app.models.custom_field import getData

Base = declarative_base()

class BusinessStorePhotoInfo(Base):
    __tablename__ = "business_store_photo_info"

    phone = Column(String, primary_key=True)
    # 用下划线前缀标识原始数据库字段，对应表中的store_photo列
    _store_photo = Column("store_photo", String)

    @hybrid_property
    def store_photo(self):
        # 每次访问该属性时，自动返回base64格式数据
        return getData(self._store_photo)

    @store_photo.setter
    def store_photo(self, value):
        # 赋值时直接存入原始图片链接
        self._store_photo = value

这样不管是直接访问模型实例的store_photo属性，还是通过ORM查询返回的对象，都会自动拿到base64格式的图片数据。

方法2：在序列化层处理（推荐） #

如果不想修改模型结构，更合理的方式是在序列化Schema中处理转换逻辑，将数据转换和模型解耦：

from marshmallow import Schema, fields

class BusinessStorePhotoInfoSchema(Schema):
    phone = fields.String()
    store_photo = fields.Method("convert_to_base64")

    def convert_to_base64(self, obj):
        return getData(obj.store_photo)

当你用这个Schema序列化模型实例时，store_photo字段会自动被转换为base64格式，这种方式更符合分层架构的设计原则。

为什么之前的尝试没效果？ #

你之前定义的hybrid_property/hybrid_method用了length、contains这些和store_photo无关的名称，自然不会替换原字段的访问行为。必须让hybrid_property的名称和你要对外暴露的属性名一致，同时把原始数据库字段改名避免命名冲突。

内容的提问来源于stack exchange，提问作者Sarthak