新闻中心

Flask-SQLAlchemy 多对多关系:用户与角色权限管理的正确实践

2025-11-22
浏览次数:
返回列表

flask-sqlalchemy 多对多关系:用户与角色权限管理的正确实践

本文详细介绍了如何在 Flask 应用中利用 SQLAlchemy 实现用户与角色之间的多对多关系。我们将通过一个博客应用的示例,展示如何正确定义关联表、用户模型和角色模型,并纠正常见的 `InvalidRequestError`,特别是由于模型类命名不规范或关系属性配置错误导致的问题,确保关系配置的清晰与准确。

理解多对多关系及其应用场景

在Web应用开发中,多对多关系是一种常见的数据库设计模式。例如,一个用户可以拥有多个角色(如“管理员”、“编辑”、“普通用户”),同时一个角色也可以分配给多个用户。在 SQLAlchemy 中,实现这种关系通常需要一个中间表(也称为关联表或连接表)来连接两个主表。

定义关联表

关联表是多对多关系的核心。它只包含两个外键,分别指向两个主表的ID。在 Flask-SQLAlchemy 中,我们可以使用 db.Table 来定义它。

import sqlalchemy as sa
import sqlalchemy.orm as so
from datetime import datetime, timezone
from typing import Optional
from flask_login import UserMixin
from werkzeug.security import generate_password_hash, check_password_hash
from hashlib import md5
from flask_security.models import fsqla_v3 as fsqla
from app import db, login # 假设 db 和 login 已在 app.py 中初始化

# 定义用户与角色之间的关联表
roles_users_table = db.Table(
    "roles_users_table", # 关联表的名称
    db.metadata,
    sa.Column("user_id", sa.Integer, sa.ForeignKey("user.id"), primary_key=True),
    sa.Column("role_id", sa.Integer, sa.ForeignKey("role.id"), primary_key=True) # 注意这里是 "role.id"
)

注意事项:

CA.LA CA.LA

第一款时尚产品在线设计平台,服装设计系统

CA.LA 94 查看详情 CA.LA
  • 关联表的名称应清晰反映其连接的两个实体,例如 roles_users_table。
  • 外键 (ForeignKey) 引用的是目标表的小写名称和其主键,例如 user.id 和 role.id。
  • 两个外键共同构成联合主键 (primary_key=True),确保每对用户-角色关系的唯一性。

定义用户模型 (User)

用户模型需要包含其基本信息,并定义与角色模型的多对多关系。

class User(fsqla.FsUserMixin, db.Model):
    id: so.Mapped[int] = so.mapped_column(primary_key=True)
    email: so.Mapped[str] = so.mapped_column(sa.String(120), index=True, unique=True)
    password_hash: so.Mapped[Optional[str]] = so.mapped_column(sa.String(256))
    about_me: so.Mapped[Optional[str]] = so.mapped_column(sa.String(140))
    last_seen: so.Mapped[Optional[datetime]] = so.mapped_column(default=lambda: datetime.now(timezone.utc))

    # 定义与 Post 模型的一对多关系
    posts: so.WriteOnlyMapped['Post'] = so.relationship(back_populates='author')

    # 定义与 Role 模型的多对多关系
    # 'roles' 属性将包含一个 Role 对象的列表
    roles: so.Mapped[list['Role']] = so.relationship(
        secondary=roles_users_table, # 指定关联表
        back_populates="users"       # 指定 Role 模型中对应的反向关系属性
    )

    def set_password(self, password):
        self.password_hash = generate_password_hash(password)

    def check_password(self, password):
        return check_password_hash(self.password_hash, password)

    def *atar(self, size):
        digest = md5(self.email.lower().encode('utf-8')).hexdigest()
        return f'https://www.gr*atar.com/*atar/{digest}?d=identicon&s={size}'

    def __repr__(self):
        return '<User {}>'.format(self.email)

# 假设 Post 模型也已定义
class Post(db.Model):
    id: so.Mapped[int] = so.mapped_column(primary_key=True)
    body: so.Mapped[str] = so.mapped_column(sa.String(140))
    timestamp: so.Mapped[datetime] = so.mapped_column(index=True, default=lambda: datetime.now(timezone.utc))
    user_id: so.Mapped[int] = so.mapped_column(sa.ForeignKey(User.id), index=True)
    author: so.Mapped[User] = so.relationship(back_populates='posts')

    def __repr__(self):
        return '<Post {}>'.format(self.body)

注意事项:

  • roles: so.Mapped[list['Role']] 表示一个 User 对象可以关联多个 Role 对象。
  • secondary=roles_users_table 指明了用于连接 User 和 Role 的关联表。
  • back_populates="users" 建立了双向关系。这意味着在 Role 模型中,需要有一个名为 users 的属性来指向关联的 User 对象列表。

定义角色模型 (Role)

角色模型需要包含角色名称等信息,并定义与用户模型的多对多关系。

class Role(db.Model, fsqla.FsRoleMixin): # 注意:类名应为单数 'Role'
    id: so.Mapped[int] = so.mapped_column(primary_key=True)
    name: so.Mapped[str] = so.mapped_column(sa.String(80), unique=True) # 角色名称,应为字符串类型
    description: so.Mapped[Optional[str]] = so.mapped_column(sa.String(255)) # 角色描述(可选)

    # 定义与 User 模型的多对多关系
    # 'users' 属性将包含一个 User 对象的列表
    users: so.Mapped[list['User']] = so.relationship(
        secondary=roles_users_table, # 指定关联表
        back_populates="roles"       # 指定 User 模型中对应的反向关系属性
    )

    def __repr__(self):
        return '<Role {}>'.format(self.name)

关键修正与注意事项:

  1. 类名应为单数:Role 而非 Roles。 这是导致原始 sqlalchemy.exc.InvalidRequestError: When initializing mapper Mapper[User(user)], expression 'Role' failed to locate a name ('Role'). 错误的主要原因。SQLAlchemy 在解析关系时,通常期望引用的是模型类的精确名称。如果 User 模型中 so.Mapped[list['Role']] 引用的是 Role,但实际类名为 Roles,就会出现找不到映射的错误。
  2. name 属性类型:so.Mapped[str]。 角色名称通常是一个字符串(如 "admin", "editor"),而不是一个 User 对象。原始代码中的 name: so.Mapped[User] 是不正确的。
  3. back_populates 属性一致性: User 模型中的 back_populates="users" 必须与 Role 模型中用于反向关系的属性名 users 保持一致。

完整示例代码

结合上述修正,以下是完整的模型定义代码:

from datetime import datetime, timezone
from typing import Optional
import sqlalchemy as sa
import sqlalchemy.orm as so
from app import db, login # 假设 db 和 login 已在 app.py 中初始化
from werkzeug.security import generate_password_hash, check_password_hash
from flask_login import UserMixin
from flask_security.models import fsqla_v3 as fsqla
from hashlib import md5

# 定义用户与角色之间的关联表
roles_users_table = db.Table(
    "roles_users_table",
    db.metadata,
    sa.Column("user_id", sa.Integer, sa.ForeignKey("user.id"), primary_key=True),
    sa.Column("role_id", sa.Integer, sa.ForeignKey("role.id"), primary_key=True)
)

class User(fsqla.FsUserMixin, db.Model):
    id: so.Mapped[int] = so.mapped_column(primary_key=True)
    email: so.Mapped[str] = so.mapped_column(sa.String(120), index=True, unique=True)
    password_hash: so.Mapped[Optional[str]] = so.mapped_column(sa.String(256))
    posts: so.WriteOnlyMapped['Post'] = so.relationship(back_populates='author')
    about_me: so.Mapped[Optional[str]] = so.mapped_column(sa.String(140))
    last_seen: so.Mapped[Optional[datetime]] = so.mapped_column(default=lambda: datetime.now(timezone.utc))

    # 定义与 Role 模型的多对多关系
    roles: so.Mapped[list['Role']] = so.relationship(
        secondary=roles_users_table,
        back_populates="users"
    )

    def set_password(self, password):
        self.password_hash = generate_password_hash(password)

    def check_password(self, password):
        return check_password_hash(self.password_hash, password)

    def __repr__(self):
        return '<User {}>'.format(self.email)

    def *atar(self, size):
        digest = md5(self.email.lower().encode('utf-8')).hexdigest()
        return f'https://www.gr*atar.com/*atar/{digest}?d=identicon&s={size}'

class Post(db.Model):
    id: so.Mapped[int] = so.mapped_column(primary_key=True)
    body: so.Mapped[str] = so.mapped_column(sa.String(140))
    timestamp: so.Mapped[datetime] = so.mapped_column(index=True, default=lambda: datetime.now(timezone.utc))
    user_id: so.Mapped[int] = so.mapped_column(sa.ForeignKey(User.id), index=True)
    author: so.Mapped[User] = so.relationship(back_populates='posts')

    def __repr__(self):
        return '<Post {}>'.format(self.body)

class Role(db.Model, fsqla.FsRoleMixin): # 正确的类名:Role
    id: so.Mapped[int] = so.mapped_column(primary_key=True)
    name: so.Mapped[str] = so.mapped_column(sa.String(80), unique=True) # 角色名称,字符串类型
    description: so.Mapped[Optional[str]] = so.mapped_column(sa.String(255)) # 角色描述(可选)

    # 定义与 User 模型的多对多关系
    users: so.Mapped[list['User']] = so.relationship(
        secondary=roles_users_table,
        back_populates="roles"
    )

    def __repr__(self):
        return '<Role {}>'.format(self.name)

如何创建和关联数据

在上述模型定义正确后,你可以像这样创建角色和用户,并建立它们之间的关系:

# 假设 db 已经初始化并且应用上下文已激活
# from app import app, db, User, Role
# with app.app_context():

# 创建角色
admin_role = Role(name=&quot;admin", description="Administrator role")
editor_role = Role(name="editor", description="Editor role")
user_role = Role(name="user", description="Standard user role")

db.session.add_all([admin_role, editor_role, user_role])
db.session.commit()

# 创建用户
user1 = User(email="test1@example.com", password_hash="hashed_password_1")
user2 = User(email="test2@example.com", password_hash="hashed_password_2")

db.session.add_all([user1, user2])
db.session.commit()

# 将角色分配给用户
user1.roles.append(admin_role)
user1.roles.append(editor_role) # user1 拥有 admin 和 editor 两个角色

user2.roles.append(user_role) # user2 拥有 user 角色

db.session.commit()

# 查询用户及其角色
print(f"User 1 roles: {[r.name for r in user1.roles]}")
# 输出: User 1 roles: ['admin', 'editor']

# 查询角色下的用户
print(f"Admin role users: {[u.email for u in admin_role.users]}")
# 输出: Admin role users: ['test1@example.com']

总结

正确配置 Flask-SQLAlchemy 中的多对多关系是构建复杂应用的关键一步。主要需要注意以下几点:

  1. 关联表定义: 使用 db.Table 定义中间表,包含两个主键外键。
  2. 模型类命名: 确保模型类名与 so.Mapped 或 so.relationship 中引用的名称一致,通常使用单数形式(如 Role 而非 Roles)。这是避免 InvalidRequestError 的常见且重要的一点。
  3. 关系属性类型: so.Mapped[list['ModelName']] 用于表示多对多关系中包含的是另一个模型对象的列表。
  4. secondary 参数: 在 so.relationship 中正确指定关联表。
  5. back_populates 参数: 确保双向关系的属性名在两个模型中保持一致,以便于双向导航。 遵循这些最佳实践,可以有效避免常见的配置错误,并构建出健壮的 Flask 应用数据模型。

以上就是Flask-SQLAlchemy 多对多关系:用户与角色权限管理的正确实践的详细内容,更多请关注其它相关文章!


# app  # word  # 已在  # 主键  # 这是  # 是一个  # 多个  # 文档  # 的是  # 应用开发  # ai  # session  # 专业网站优化效果分析  # 万州网站建设果园路  # 万柏林区推广品牌营销  # 跨镜电商营销推广  # 如何克服网站推广恐惧  # 网站建设的背景介绍  # 有赞网站建设  # 新乐抖音seo  # woocommerce营销推广插件  # seo黑帽子空间  # 自动生成  # 而非  # 可选 


相关栏目: 【 科技资讯46185 】 【 网络学院92790


相关推荐: C++如何实现线程池_C++11手动实现一个简单的固定大小线程池  ArrayList与LinkedList操作复杂度详解:遍历与修改  漫蛙漫画官方首页 漫蛙2漫画在线阅读入口  Win11怎么查看显卡显存 Win11显示适配器属性及专用视频内存查询  小红书怎么解除第三方平台绑定_小红书多平台登录解绑方法介绍  小红书网页版入口链接分享 小红书官网直接进  Lar*el如何生成PDF或Excel文件_Lar*el文档导出工具与使用教程  必由学官网入口 必由学教师登录入口  外媒分析《GTA6》定价:卖100美元可以但真没必要!  word中如何让数字纵向排列_Word数字纵向排列方法  反效果?《战地6》免费试玩开启后玩家数不升反降  mcjs网页版在线存档 mcjs云存档登录入口  蛙漫漫画免费阅读入口_蛙漫官方正版无广告纯净版  Bing引擎入口最新2025 Bing搜索免费官方登录  向日葵客户端怎么进行远程CentOS控制_向日葵客户端远程CentOS控制操作教程  快手官方唯一登录入口 谨防山寨钓鱼网站  知音漫客正版漫画平台_知音漫客官网账号登录  如何修改开机登录密码_Windows账户安全设置超详细教程【必学】  php源码怎么看淘宝客系统_看php源码淘宝客系统技巧  Golang并发任务中错误如何聚合_Golang goroutine error收集方式  在Qt QML中通过Python字典动态更新TextEdit内容的教程  漫蛙2正版漫画站 漫蛙2网页版快速访问入口  PrimeNG Sidebar背景色自定义指南:CSS覆盖与主题化实践  jQuery Mask 插件中实现电话号码固定前导零的教程  蛙漫移动版在线看 蛙漫手机浏览器直达入口  谷歌浏览器怎么给标签页静音_Chrome标签静音快捷操作  Win10自动更新怎么关闭 Win10永久关闭系统更新的两种方法【终极版】  KFC游戏互动怎么赢取优惠券_KFC线上游戏活动参与与优惠代码赢取教程  限制HTML日期输入框的日期选择范围  C++ vector二维数组定义_C++ vector of vector用法  必由学网页版入口 必由学官方平台直接访问  凉拌黄瓜怎么拌更入味 凉拌黄瓜简单家常做法  Centos/Linux 系统下安装 composer 的完整步骤  飞书妙记怎样用语音转文字速记_飞书妙记用语音转文字速记【速记方法】  J*aScript Promise链中如何正确终止后续.then执行并处理错误  电脑安装程序提示“错误1722”怎么办_Windows Installer服务问题解决【教程】  J*aScript实现单选按钮与关联输入框的联动禁用教程  J*aScript 字符串标签转换:使用正则表达式高效替换  在Socket.IO连接中实现Access Token自动更新与动态重连  在J*a中如何开发简易仓库管理与库存统计_仓库管理库存统计项目实战解析  cad如何更改注释性对象的比例_cad注释性比例调整方法  解决macOS上安装pyhdf时‘hdf.h’文件缺失的编译错误  漫蛙漫画网页端入口 漫蛙2官方正版漫画站点  Safari怎么安装扩展程序 浏览器插件安装与管理方法【详解】  vivo云服务网页版登录 怎么登录vivo云服务网页版  12306选座怎么选到临时改签座_12306改签选座策略与步骤  火狐浏览器占用内存高卡顿怎么办 火狐浏览器性能优化设置技巧  sublime怎么设置启动时打开的窗口_sublime会话管理与热退出  高德地图家和公司地址在哪设置 高德地图通勤路线设置方法【超详细】  Windows10怎么开启存储感知 Windows10系统设置自动清理临时文件释放C盘空间【教程】 

搜索