FastAPI Best Architecture

外观

FastAPI 如何添加操作人信息

复制页面

约 888 字大约 3 分钟

FastAPI

2024-12-13

我们常见的后台管理系统中，经常会有一些比如创建人，更新人这类的信息，那这些信息是如何做的呢？下面我们就来讲一讲我们在 fba 中应该如何集成操作人信息

如何集成？

打开 fba 项目，进入 backend/common/model.py 文件中，你会看到 UserMixin 类就冰冷冷的站在那里，因为 fba 没有使用它，而只是保留它；

class UserMixin(MappedAsDataclass):
    """用户 Mixin 数据类"""

    created_by: Mapped[int] = mapped_column(sort_order=998, comment='创建者')
    updated_by: Mapped[int | None] = mapped_column(init=False, default=None, sort_order=998, comment='修改者')

如何使用？

首先，UserMixin 类所存储的信息只是用户的 id ，这也是一种常见的做法，那么问题来了：我该如何获取用户 id 并存储？ 我在后台展示的时候，肯定不能展示 id 吧？容我一一解答

如何获取用户 ID？

fba 通过 JWT 中间件将用户信息存储到了每个请求的上下文中，我们可以很轻松的通过 request 对象读取用户信息（在 Django，Flask 等 Web 框架中， request 都是常驻嘉宾）

如何存储？

手动

首先，在接口函数中，传入一个 request 参数，最好，我们加上参数类型：request: Request，然后我们可以在接口函数中通过 request.user.id 获取当前操作人员 id ，然后传递此 id 进行存储

除此之外，为了简化代码，我们还可以通过 ctx.user_id 直接获取操作人员 id 进行存储

自动

利用 SQLAlchemy 的事件监听，我们可以轻松做到这一点

首先，我们需要对 UserMixin 做些调整：

class UserMixin(MappedAsDataclass):
    """用户 Mixin 数据类"""

    created_by: Mapped[int] = mapped_column(init=False, sort_order=998, comment='创建者')
    updated_by: Mapped[int | None] = mapped_column(init=False, default=None, sort_order=998, comment='修改者')

然后在 backend/common/model.py 底部添加添加以下监听事件：

@event.listens_for(UserMixin, 'before_insert', propagate=True)
def _inject_created_by(mapper, connection, target) -> None:  # noqa: ANN001
    user_id = ctx.user_id
    if user_id is None:
        return
    if hasattr(target, 'created_by') and target.created_by is None:
        target.created_by = ctx.user_id


@event.listens_for(Session, 'do_orm_execute', propagate=True)
def _inject_updated_by(orm_execute_state: ORMExecuteState) -> None:
    if (
        orm_execute_state.is_update
        and orm_execute_state.is_orm_statement
        and orm_execute_state.statement.is_update
        and orm_execute_state.bind_mapper.c.get('updated_by') is not None
    ):
        orm_execute_state.statement = orm_execute_state.statement.values(updated_by=ctx.user_id)

注意

before_insert 事件需配合 flush() 才能触发！

事件监听条件要求严格，如果监听事件未按预期执行，参考：sqlalchemy#12724

如何展示？

当然不能，那该怎么办呢？虽然我们只存储了用户 id 到数据库，但当我们单查询或列表查询的时候，我们需要进行数据拦截，将 id 替换为 username；

这会涉及到另外的问题，username 从哪里来？考虑到性能影响，我们如果每次都遍历这些 id 去查询数据库进行替换，无疑是增加了大量 IO 操作，因此，我们可以埋点（新用户注册后，查询用户列表时...）将所有用户 id 和 username 缓存到 redis，替换的时候就直接读取缓存

直接存成 username 不更好么？

当然可以，你可以直接修改 UserMixin 存为字符串，然后直接通过 request.user.username 存储用户名，这样查询出来就直接是用户名，从而无需再进行替换操作

到底存什么？

用 id 还是用 username，取决于业务场景；如果需要总是显示最新用户信息，避免用户更新用户名之后还需要更新所有历史数据，则使用 id，如果 username 是唯一的，并且需要保留历史痕迹，直接用 username 即可