# +====================================================================== # | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ] # +---------------------------------------------------------------------- # | Copyright (c) 2021-2026 一米阳光团队 版权所有 # +---------------------------------------------------------------------- # | 开源协议: Apache-2.0 # | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。 # +---------------------------------------------------------------------- # | 官方网站: https://www.djangoadmin.cn # +---------------------------------------------------------------------- # | 研发团队: 一米阳光团队 荣誉出品 # +====================================================================== # | 版权和免责声明: # | 一、知识产权声明 # | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、 # | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权， # | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。 # | 二、使用限制与禁止条款 # | 您理解并同意，禁止将本产品用于以下任何行为： # | 1. 任何违反中华人民共和国法律法规的用途； # | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为； # | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。 # | 三、责任豁免 # | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失 # | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三 # | 方提起索赔或行政机关进行调查，您应独立承担全部责任。 # | 四、违约与法律责任 # | 如发现任何违反本声明的行为，本团队有权： # | 1. 无条件配合公安机关及其他有权机关的调查取证工作； # | 2. 依法追究相关方的民事责任，并要求赔偿全部损失； # | 3. 保留进一步采取刑事控告等法律措施的权利。 # | 五、许可范围说明 # | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包 # | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通 # | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、 # | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造 # | 成的一切经济损失及商誉损害。 # | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件 # | 许可协议》附件为准。 # +====================================================================== """ 菜单管理服务模块 ============================================================= 该模块实现了菜单管理相关的所有业务逻辑。 包括菜单的列表查询、详情查询、添加、更新、删除、权限节点管理等功能。 菜单用于构建系统导航栏和权限控制，支持目录、菜单、按钮三种类型， 通过parent_id字段建立层级关系，sort字段控制显示顺序。 命名规范： - 函数参数使用驼峰命名（如 menuId, userId） - 表单字段使用下划线命名（如 name, path, permission）- 与数据库字段保持一致 - 返回数据使用驼峰命名（如 createUser, updateTime）- 与前端规范保持一致 - 私有函数以下划线开头（如 _apply_filters, _build_tree） 功能模块： 1. 列表查询：支持按名称模糊搜索，按sort字段排序 2. 详情查询：根据ID获取单个菜单的详细信息（含权限节点） 3. 数据维护：菜单的添加、更新、删除（支持批量） 4. 权限节点：自动生成菜单对应的权限节点（增删改查等） 5. 用户权限：根据用户ID获取权限节点列表 6. 菜单树：根据用户ID获取权限菜单树结构 """ import logging from datetime import datetime, timezone from flask import request from sqlalchemy import and_ from application.forms.menu import MenuForm from application.models.menu import Menu from application.models.role_menu import RoleMenu from application.models.user_role import UserRole from extensions import db from utils import R, regular from utils.case_converter import convert_camel_to_snake from utils.redis_client import redis from utils.request import parse_request_body, parse_id_list, like_contains from utils.model_utils import models_to_list, model_to_dict from utils.security import get_username # 获取日志记录器 logger = logging.getLogger(__name__) # ============================================================ # 权限缓存配置 # ============================================================ # 缓存Key前缀 _CACHE_PREFIX_PERM = "perm:user:" _CACHE_PREFIX_MENU = "menu:user:" _CACHE_KEY_VERSION = "perm:version" # 缓存过期时间（秒），2小时 _CACHE_EXPIRE = 7200 # ============================================================ # 权限节点常量映射 # ============================================================ class PermissionNode: """权限节点常量定义""" QUERY = 1 # 查询 ADD = 5 # 添加 UPDATE = 10 # 修改 DELETE = 15 # 删除 DETAIL = 20 # 详情 STATUS = 25 # 设置状态 BATCH_DELETE = 30 # 批量删除 ADD_CHILD = 35 # 添加子级 EXPAND = 40 # 全部展开 COLLAPSE = 45 # 全部折叠 EXPORT = 50 # 导出 IMPORT = 55 # 导入 PERMISSION = 60 # 分配权限 RESET_PWD = 65 # 重置密码 # 权限节点配置映射 PERMISSION_CONFIG = { PermissionNode.QUERY: {'suffix': '查询', 'action': 'list', 'perm_suffix': 'list'}, PermissionNode.ADD: {'suffix': '添加', 'action': 'add', 'perm_suffix': 'add'}, PermissionNode.UPDATE: {'suffix': '修改', 'action': 'update', 'perm_suffix': 'update'}, PermissionNode.DELETE: {'suffix': '删除', 'action': 'delete', 'perm_suffix': 'delete'}, PermissionNode.DETAIL: {'suffix': '详情', 'action': 'detail', 'perm_suffix': 'detail'}, PermissionNode.STATUS: {'suffix': '设置状态', 'action': 'status', 'perm_suffix': 'status'}, PermissionNode.BATCH_DELETE: {'suffix': '批量删除', 'action': 'dall', 'perm_suffix': 'dall'}, PermissionNode.ADD_CHILD: {'suffix': '添加子级', 'action': 'addz', 'perm_suffix': 'addz'}, PermissionNode.EXPAND: {'suffix': '全部展开', 'action': 'expand', 'perm_suffix': 'expand'}, PermissionNode.COLLAPSE: {'suffix': '全部折叠', 'action': 'collapse', 'perm_suffix': 'collapse'}, PermissionNode.EXPORT: {'suffix': '导出', 'action': 'export', 'perm_suffix': 'export'}, PermissionNode.IMPORT: {'suffix': '导入', 'action': 'import', 'perm_suffix': 'import'}, PermissionNode.PERMISSION: {'suffix': '分配权限', 'action': 'permission', 'perm_suffix': 'permission'}, PermissionNode.RESET_PWD: {'suffix': '重置密码', 'action': 'resetPwd', 'perm_suffix': 'resetPwd'}, } # ============================================================ # 菜单列表查询 # ============================================================ def get_menu_list(): """ 查询菜单列表 用于菜单管理页面的列表展示，支持按名称模糊搜索。 Args: request: Flask request对象，包含查询参数 - name: 菜单名称（可选，模糊查询） Returns: R: 包含菜单列表的JSON响应 """ try: # 应用筛选条件 query = _apply_filters() # 查询数据（按排序升序） menu_list = query.order_by(Menu.sort.asc()).all() # 转换为字典列表 records = models_to_list(menu_list) return R.ok(data=records) except Exception as e: logger.error(f"查询菜单列表异常: {str(e)}") return R.failed(msg="查询失败，请稍后重试") def _apply_filters(): """ 应用查询筛选条件 根据请求参数动态构建查询条件： - 自动过滤已删除记录（is_delete == 0） - 支持菜单名称模糊查询 Returns: Query: 应用筛选后的SQLAlchemy查询对象 """ # 基础查询：过滤已删除记录 query = Menu.query.filter(Menu.is_delete == 0) # 菜单名称模糊筛选 name = request.args.get('name') if name: query = query.filter(Menu.name.like(like_contains(name), escape='\\')) return query # ============================================================ # 菜单详情查询 # ============================================================ def get_menu_detail(menu_id): """ 根据ID查询菜单详情（返回字典格式） 此方法调用 get_info 获取模型对象，然后转换为字典格式返回。 同时查询该菜单下的权限节点列表。 Args: menu_id: 菜单ID Returns: dict/None: 菜单详情字典，包含 checked_list 权限节点列表，不存在时返回 None """ try: # 复用 get_info 方法查询菜单 menu = get_info(menu_id) if not menu: return None # 转换为字典格式 data = model_to_dict(menu) # 查询菜单权限节点（type=1 表示权限节点） permission_list = Menu.query.filter( and_(Menu.parent_id == menu_id, Menu.type == 1, Menu.is_delete == 0) ).all() # 选中的权限节点（按sort值收集） checked_list = [p.sort for p in permission_list] if permission_list else [] # 权限节点 data['checked_list'] = checked_list return data except Exception as e: logger.error(f"查询菜单详情异常，ID: {menu_id}, 错误: {str(e)}") return None # ============================================================ # 菜单信息查询（根据ID）- 核心查询方法 # ============================================================ def get_info(menu_id: int): """ 根据ID查询菜单信息（返回模型对象） 这是一个通用的菜单查询方法，返回菜单模型对象而非字典。 与 get_menu_detail 的区别： - get_menu_detail: 返回字典格式，用于前端接口 - get_info: 返回模型对象，用于内部服务调用 此方法被以下方法复用： - get_menu_detail: 获取详情字典 - update_menu: 验证菜单是否存在 - delete_menus: 验证菜单是否存在 Args: menu_id: 菜单ID Returns: Menu/None: 菜单模型对象，不存在或已删除时返回 None Example: menu = get_info(menu_id) if menu: print(menu.title) """ # 参数有效性验证 if not menu_id or menu_id <= 0: return None try: # 查询未删除的菜单 menu = Menu.query.filter( and_(Menu.id == menu_id, Menu.is_delete == 0) ).first() return menu except Exception as e: logger.error(f"查询菜单信息异常，ID: {menu_id}, 错误: {str(e)}") return None # ============================================================ # 菜单添加 # ============================================================ def add_menu(): """ 添加菜单 流程： 1. 解析请求体JSON数据 2. 表单验证 3. 创建菜单对象并保存到数据库 4. 如果是目录类型，自动生成权限节点 Returns: R: 操作结果 """ try: # 获取参数 json_data, error = parse_request_body() if error: return R.failed(msg=error) # 表单验证 form = MenuForm(data=json_data) if not form.validate(): err_msg = regular.get_err(form) return R.failed(msg=err_msg) # 权限节点 checked_list = form.data.get('checked_list') menu_type = form.data.get('type') title = form.data.get('title') path = form.data.get('path', '') # 移除不需要直接保存到Menu表的字段 form_data = form.data.copy() form_data.pop('checked_list', None) # 创建菜单 menu = Menu(**form_data) menu.create_user = get_username() db.session.add(menu) db.session.flush() # 保存权限节点数据 _create_permission_nodes(menu_type, checked_list, title, path, menu.id) # 菜单变更，递增全局版本号使所有用户缓存失效 invalidate_all_cache() return R.ok(msg="添加成功") except Exception as e: logger.error(f"添加菜单异常: {str(e)}") return R.failed(msg="添加菜单失败，请稍后重试") # ============================================================ # 菜单更新 # ============================================================ def update_menu(): """ 更新菜单 流程： 1. 解析请求体JSON数据 2. 表单验证 3. 验证菜单是否存在（复用 get_info） 4. 更新菜单信息 5. 更新权限节点数据 Returns: R: 操作结果 """ try: # 获取参数 json_data, error = parse_request_body() if error: return R.failed(msg=error) # 表单验证 form = MenuForm(data=json_data) if not form.validate(): return R.failed(msg=regular.get_err(form)) # 获取菜单ID menu_id = form.data.get('id') if not menu_id or int(menu_id) <= 0: return R.failed("菜单ID无效") menu_id = int(menu_id) # 复用 get_info 方法验证菜单是否存在 menu = get_info(menu_id) if not menu: return R.failed("菜单不存在") # 权限节点 checked_list = form.data.get('checked_list') menu_type = form.data.get('type') title = form.data.get('title') path = form.data.get('path', '') # 移除不需要直接更新到Menu表的字段 form_data = convert_camel_to_snake(form.data.copy()) form_data.pop('id', None) form_data.pop('checked_list', None) form_data['update_time'] = datetime.now(tz=timezone.utc) form_data['update_user'] = get_username() # 更新菜单信息 result = Menu.query.filter_by(id=menu_id).update(form_data) if not result: return R.failed("更新失败") # 保存权限节点数据 _create_permission_nodes(menu_type, checked_list, title, path, menu_id) # 菜单变更，递增全局版本号使所有用户缓存失效 invalidate_all_cache() return R.ok(msg="更新成功") except Exception as e: logger.error(f"更新菜单异常: {str(e)}") return R.failed(msg="更新菜单失败，请稍后重试") # ============================================================ # 菜单删除 # ============================================================ def delete_menus(menu_ids): """ 删除菜单（批量删除） 采用软删除方式，将 is_delete 标识设置为 1。 支持逗号分隔的多个ID批量删除。 Args: menu_ids: 菜单ID字符串，多个ID用逗号分隔，如 "1,2,3" Returns: R: 操作结果 """ if not menu_ids: return R.failed("记录ID不存在") # 解析ID列表 id_list = parse_id_list(menu_ids) if not id_list: return R.failed("无效的记录ID") # 检查是否有子菜单 for menu_id in id_list: child_count = Menu.query.filter( and_(Menu.parent_id == menu_id, Menu.is_delete == 0) ).count() if child_count > 0: return R.failed(f"菜单ID {menu_id} 存在子菜单，请先删除子菜单") result = Menu.batch_delete_r(menu_ids) # 菜单变更，递增全局版本号使所有用户缓存失效 invalidate_all_cache() return result # ============================================================ # 权限节点管理 # ============================================================ def _create_permission_nodes(menu_type, checked_list, title, path, parent_id): """ 创建权限节点 根据菜单类型和选中的权限节点，自动生成对应的权限菜单。 Args: menu_type: 菜单类型（0-目录/菜单，1-权限节点） checked_list: 选中的权限节点列表（逗号分隔的字符串） title: 菜单标题 path: 菜单路径 parent_id: 父级菜单ID """ # 非目录/菜单类型，或没有选中节点，或路径为空时直接返回 if menu_type != 0 or not checked_list or not path: return try: # 删除现有权限节点 Menu.query.filter( and_(Menu.parent_id == parent_id, Menu.type == 1, Menu.is_delete == 0) ).delete() # 模块名称（去掉"管理"后缀） module_title = title.replace("管理", "") if title else "" # 请求path处理，获取模块名 path_arr = path.split('/') if len(path_arr) < 3: return module_name = path_arr[-1] # 权限节点处理 permission_list = parse_id_list(checked_list) for value in permission_list: config = PERMISSION_CONFIG.get(value) if not config: continue # 构建节点标题 if value in [PermissionNode.DETAIL]: node_title = f"{module_title}{config['suffix']}" elif value in [PermissionNode.QUERY, PermissionNode.ADD, PermissionNode.UPDATE, PermissionNode.DELETE, PermissionNode.EXPORT, PermissionNode.IMPORT]: node_title = f"{config['suffix']}{module_title}" else: node_title = config['suffix'] # 构建路径 node_path = f"/{module_name}/{config['action']}" # 构建权限标识 permission = f"sys:{module_name}:{config['perm_suffix']}" # 创建权限节点 permission_menu = Menu( parent_id=parent_id, title=node_title, path=node_path, permission=permission, type=1, # 权限节点类型 status=1, target="_self", sort=value, create_user=get_username() ) permission_menu.save() except Exception as e: logger.error(f"创建权限节点异常: {str(e)}") raise # ============================================================ # 用户权限节点获取 # ============================================================ def get_user_permissions(user_id): """ 获取用户权限节点列表（带Redis缓存） 缓存策略：用户级缓存 + 全局版本号 - Key: perm:user:{user_id}:{version} - 菜单/角色变更时递增全局版本号，旧缓存自然失效 - 用户角色变更时直接删除该用户缓存 Args: user_id: 用户ID Returns: list: 权限标识列表，如 ['sys:user:list', 'sys:user:add', ...] """ if not user_id or user_id <= 0: return [] try: # 查询全局版本号 version = redis.get(_CACHE_KEY_VERSION, deserialize=False) or "1" cache_key = f"{_CACHE_PREFIX_PERM}{user_id}:{version}" # 尝试从缓存获取 cached = redis.get(cache_key) if cached is not None: return cached # 缓存未命中，查询数据库 if user_id == 1: permission_list = Menu.query.filter( and_(Menu.is_delete == 0, Menu.type == 1, Menu.status == 0) ).all() result = [item.permission for item in permission_list if item.permission] else: rows = ( db.session.query(Menu.permission) .join(RoleMenu, Menu.id == RoleMenu.menu_id) .join(UserRole, UserRole.role_id == RoleMenu.role_id) .filter( UserRole.user_id == user_id, Menu.type == 1, Menu.status == 0, Menu.is_delete == 0, Menu.permission != '' ) .all() ) result = [row.permission for row in rows if row.permission] # 写入缓存 redis.set(cache_key, result, expire=_CACHE_EXPIRE) return result except Exception as e: logger.error(f"获取用户权限节点异常，用户ID: {user_id}, 错误: {str(e)}") return [] # ============================================================ # 用户菜单树获取 # ============================================================ def get_user_permission_menus(user_id): """ 根据用户ID获取权限菜单树（带Redis缓存） 缓存策略：用户级缓存 + 全局版本号 - Key: menu:user:{user_id}:{version} - 菜单变更时递增全局版本号，旧缓存自然失效 - 用户角色变更时直接删除该用户缓存 Args: user_id: 用户ID Returns: list: 菜单树结构数据 """ if not user_id or user_id <= 0: return [] try: # 查询全局版本号 version = redis.get(_CACHE_KEY_VERSION, deserialize=False) or "1" cache_key = f"{_CACHE_PREFIX_MENU}{user_id}:{version}" # 尝试从缓存获取 cached = redis.get(cache_key) if cached is not None: return cached # 缓存未命中，查询数据库 if user_id == 1: menu_list = Menu.query.filter( and_(Menu.is_delete == 0, Menu.status == 0, Menu.type == 0) ).order_by(Menu.sort.asc()).all() else: menu_list = ( db.session.query(Menu) .join(RoleMenu, Menu.id == RoleMenu.menu_id) .join(UserRole, UserRole.role_id == RoleMenu.role_id) .filter( UserRole.user_id == user_id, Menu.type == 0, Menu.status == 0, Menu.is_delete == 0 ) .order_by(Menu.sort.asc()) .all() ) menu_data = models_to_list(menu_list) menu_tree = _build_menu_tree(menu_data, 0) # 写入缓存 redis.set(cache_key, menu_tree, expire=_CACHE_EXPIRE) return menu_tree except Exception as e: logger.error(f"获取用户菜单树异常，用户ID: {user_id}, 错误: {str(e)}") return [] # 获取树状结构 def _build_menu_tree(menu_data, parent_id): """ 递归构建菜单树形结构 使用字典按 parentId 分组，避免每次递归遍历全量数据， 时间复杂度从 O(n²) 降为 O(n)。 Args: menu_data: 菜单字典列表 parent_id: 父级菜单ID Returns: list: 树形结构数据 """ # 按 parentId 分组，O(n) 构建 children_map = {} for item in menu_data: pid = item["parentId"] children_map.setdefault(pid, []).append(item) def _build(pid): children = children_map.get(pid, []) for item in children: item['children'] = _build(item["id"]) children.sort(key=lambda x: x.get('sort', 0)) return children return _build(parent_id) # ============================================================ # 权限缓存失效 # ============================================================ def invalidate_user_cache(user_id): """ 清除指定用户的权限和菜单缓存 用于用户角色变更场景，直接删除该用户的缓存Key。 由于缓存Key带版本号后缀，需要遍历所有版本删除。 Args: user_id: 用户ID """ try: for prefix in (_CACHE_PREFIX_PERM, _CACHE_PREFIX_MENU): pattern = f"{prefix}{user_id}:*" keys = redis.keys(pattern) if keys: redis.delete(*keys) except Exception as e: logger.warning(f"清除用户缓存异常，user_id={user_id}: {e}") def invalidate_role_users_cache(role_id): """ 清除指定角色下所有用户的权限和菜单缓存 用于角色菜单变更/角色删除场景，查询该角色关联的所有用户ID， 逐个清除缓存。 Args: role_id: 角色ID """ try: user_ids = [row.user_id for row in UserRole.query.filter(UserRole.role_id == role_id).all()] for uid in user_ids: invalidate_user_cache(uid) except Exception as e: logger.warning(f"清除角色用户缓存异常，role_id={role_id}: {e}") def invalidate_all_cache(): """ 清除所有用户的权限和菜单缓存 用于菜单增删改场景，递增全局版本号使所有旧缓存自然失效。 下次读取时因版本号不匹配，会重新查询数据库并写入新版本缓存。 """ try: redis.incr(_CACHE_KEY_VERSION) except Exception as e: logger.warning(f"递增权限缓存版本号异常: {e}")