如何在 SQLAlchemy 中自动填充 ORM 模型的创建者与更新者字段-Python教程

本文介绍如何利用 sqlalchemy 的 `before_flush` 事件钩子,无需修改业务代码即可自动为模型(如 `project`)的 `created_by` 和 `updated_by` 字段注入当前用户标识,实现审计字段的零侵入式管理。

在构建基于 AWS API Gateway + Lambda 的 RESTful 后端时,常需为数据库记录自动记录操作人信息(如 created_by、updated_by),尤其当用户身份通过 JWT Token 解析获得时。手动在每个 add() 或属性赋值处设置这些字段不仅易出错,还严重破坏代码可维护性。SQLAlchemy 提供了优雅的解决方案:事件监听机制。

核心思路是监听 Session.before_flush 事件——该事件在 session.commit() 触发前、SQL 语句生成前执行,此时可安全访问待插入(session.new)和待更新(session.dirty)的对象集合,并按需注入用户上下文。

以下为完整实践示例(已适配您的场景):

from sqlalchemy import event, Column, String, Integer
from sqlalchemy.orm import declarative_base, Session
import datetime
import jwt

Base = declarative_base()

class Project(Base):
    __tablename__ = "project"
    id = Column(Integer, primary_key=True, autoincrement=True)
    name = Column(String(256))
    created_by = Column(String(256), nullable=True)   # 建议设为 nullable,避免 flush 失败
    updated_by = Column(String(256), nullable=True)

# ✅ 替换为您真实的 JWT 解析逻辑(注意:生产环境务必校验签名!)
def get_user_creds(token: str) -> dict:
    try:
        payload = jwt.decode(token, algorithms=["RS256"], options={"verify_signature": False})
        return payload.get("username") or payload.get("cognito:username") or "anonymous"
    except Exception:
        return "anonymous"

# ? 注册全局事件监听器
@event.listens_for(Session, "before_flush")
def auto_set_audit_fields(session, flush_context, instances):
    # 从请求上下文获取 JWT Token(Lambda 中通常来自 event['headers']['Authorization'])
    # 此处用占位符模拟;实际需结合您的 Lambda handler 传递 token
    token = "dummy.jwt.token"  # ← 替换为真实 token 获取逻辑
    current_user = get_user_creds(token)

    # 自动填充新建对象的 created_by
    for obj in session.new:
        if isinstance(obj, Project):
            if not obj.created_by:  # 避免覆盖已显式设置的值
                obj.created_by = current_user

    # 自动填充已修改对象的 updated_by
    for obj in session.dirty:
        if isinstance(obj, Project):
            # 只有当对象确实被修改时才更新 updated_by(可选增强)
            state = session.identity_map.get((Project, obj.id))
            if state and hasattr(state, '_modified') and state._modified:
                obj.updated_by = current_user

? 关键注意事项:

夏夕资源网专注于CMS网站模板,主流语言整站网站源码下载,网站建设相关教程分享,好用的软件素材整合下载,提供一站式便捷自助服务。
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,您必须在下载后24小时内删除!
3. 不得使用于非法商业用途,不得违反国家法律。否则后果自负!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是赞助,收取费用仅维持本站的日常运营所需!
7. 如遇到加密压缩包,默认解压密码为"zy.lucklyus.top",如遇到无法解压的请联系管理员!
夏夕资源网-网站模板_免费源码_资源素材 » 如何在 SQLAlchemy 中自动填充 ORM 模型的创建者与更新者字段-Python教程
在线时间:12:00 - 22:00
关注微信公众号:微信公众号
站长邮箱:[email protected]
  • 运营天数: 1392+
  • 资源总数: 47989+
  • 用户总数: 1+
  • 今日更新: 0+
  • 访问次数: 4011055+
  • 本周更新: 0+
  • 最后更新: 2026-03-16

本站指数

×
  • 运营天数: 1392+
  • 资源总数: 47989+
  • 用户总数: 1+
  • 今日更新: 0+
  • 访问次数: 4011056+
  • 本周更新: 0+
  • 最后更新: 2026-03-16