Files
FastapiAdmin/backend/app/api/v1/module_platform/menu/service.py
T
zhangtao 4e2b668d7b chore: 批量优化项目代码,修复多处细节问题
本次提交包含多项优化和修复:
1. 修复CRUD初始化参数传递、搜索参数处理逻辑
2. 更新环境配置中的大模型相关参数
3. 重构部分服务方法命名,统一代码风格
4. 新增多个枚举类型,补充模型关联关系和加载选项
5. 优化查询参数类实现,完善字段校验逻辑
6. 调整Pydantic模型字段注释和类型定义
7. 简化并移除冗余的CRUD方法实现
8. 新增超级管理员权限装饰器
9. 修复邮件日志模型的租户关联和字段定义
2026-06-20 23:37:58 +08:00

249 lines
8.8 KiB
Python

from typing import Any
from app.core.base_schema import AuthSchema, BatchSetAvailable
from app.core.dependencies import require_superadmin
from app.core.exceptions import CustomException
from app.utils.common_util import (
get_child_id_map,
get_child_recursion,
get_parent_id_map,
get_parent_recursion,
traversal_to_tree,
)
from .crud import MenuCRUD
from .schema import (
MenuCreateSchema,
MenuOutSchema,
MenuQueryParam,
MenuTreeOutSchema,
MenuUpdateSchema,
)
class MenuService:
"""
菜单管理服务(查询操作租户可见,写操作仅超级管理员可操作)
"""
@classmethod
async def _validate_parent_child_type(cls, auth: AuthSchema, parent_id: int | None, child_type: int) -> None:
"""
父子类型约束:目录下仅允许目录/菜单/外链;菜单下仅允许按钮;按钮与外链下不可挂子级。
无父级时仅允许目录、菜单、外链(与前端一致)。
"""
if parent_id is None:
if child_type is None:
return
if child_type not in (1, 2, 4):
raise CustomException(msg="顶级菜单仅允许目录、菜单或外链类型")
return
parent = await MenuCRUD(auth).get(id=parent_id)
if not parent:
raise CustomException(msg="父级菜单不存在")
pt = parent.type
if pt == 1:
if child_type not in (1, 2, 4):
raise CustomException(msg="目录下仅允许新增目录、菜单或外链")
elif pt == 2:
if child_type != 3:
raise CustomException(msg="菜单下仅允许新增按钮")
else:
raise CustomException(msg="菜单或链接类型下不允许新增子菜单")
@classmethod
async def _validate_parent_child_client(cls, auth: AuthSchema, parent_id: int | None, client: str) -> None:
"""子菜单终端须与父菜单一致。"""
if parent_id is None or client is None:
return
parent = await MenuCRUD(auth).get(id=parent_id)
if not parent:
return
p_client = getattr(parent, "client", None) or "pc"
if p_client != client:
raise CustomException(msg="子菜单终端须与父菜单一致(均为 pc 或均为 app)")
@classmethod
async def detail_service(cls, auth: AuthSchema, id: int) -> MenuOutSchema:
"""
获取菜单详情。
参数:
- auth (AuthSchema): 认证对象。
- id (int): 菜单ID。
返回:
- MenuOutSchema: 菜单详情对象。
"""
menu = await MenuCRUD(auth).get(id=id, preload=["roles"])
if not menu:
raise CustomException(msg="菜单不存在")
menu_out = MenuOutSchema.model_validate(menu)
if menu.parent_id:
parent = await MenuCRUD(auth).get(id=menu.parent_id)
if parent:
menu_out.parent_name = parent.name
return menu_out
@classmethod
async def tree_service(
cls,
auth: AuthSchema,
search: MenuQueryParam | None = None,
order_by: list[dict] | None = None,
) -> list[dict]:
"""
获取菜单树形列表。
参数:
- auth (AuthSchema): 认证对象。
- search (MenuQueryParam | None): 查询参数对象。
- order_by (list[dict] | None): 排序参数列表。
返回:
- list[dict]: 菜单树形列表对象。
"""
# 使用树形结构查询,预加载children关系
menu_list = await MenuCRUD(auth).tree_list(search=vars(search) if search else None, order_by=order_by)
# 转换为字典列表(使用树形 Schema)
menu_dict_list = [MenuTreeOutSchema.model_validate(menu).model_dump() for menu in menu_list]
# 使用traversal_to_tree构建树形结构
return traversal_to_tree(menu_dict_list)
@classmethod
@require_superadmin
async def create_service(cls, auth: AuthSchema, data: MenuCreateSchema) -> MenuOutSchema:
"""
创建菜单。
参数:
- auth (AuthSchema): 认证对象。
- data (MenuCreateSchema): 创建参数对象。
返回:
- MenuOutSchema: 创建的菜单对象。
"""
search: dict[str, Any] = {}
if data.title is not None:
search["title"] = data.title
if data.parent_id is not None:
search["parent_id"] = data.parent_id
menu = await MenuCRUD(auth).get(**search)
if menu:
raise CustomException(msg="创建失败,该菜单已存在")
await cls._validate_parent_child_type(auth, data.parent_id, data.type)
await cls._validate_parent_child_client(auth, data.parent_id, data.client)
new_menu = await MenuCRUD(auth).create(data=data)
return MenuOutSchema.model_validate(new_menu)
@classmethod
@require_superadmin
async def update_service(cls, auth: AuthSchema, id: int, data: MenuUpdateSchema) -> MenuOutSchema:
"""
更新菜单。
参数:
- auth (AuthSchema): 认证对象。
- id (int): 菜单ID。
- data (MenuUpdateSchema): 更新参数对象。
返回:
- MenuOutSchema: 更新的菜单对象。
"""
_ = await MenuCRUD(auth).get_or_404(id=id, msg="更新失败,该菜单不存在")
await cls._validate_parent_child_type(auth, data.parent_id, data.type)
await cls._validate_parent_child_client(auth, data.parent_id, data.client)
if data.title is not None:
search: dict[str, Any] = {"title": data.title}
if data.parent_id is not None:
search["parent_id"] = data.parent_id
exist_menu = await MenuCRUD(auth).get(**search)
if exist_menu and exist_menu.id != id:
raise CustomException(msg="更新失败,菜单标题重复")
if data.parent_id:
parent_menu = await MenuCRUD(auth).get(id=data.parent_id)
if not parent_menu:
raise CustomException(msg="更新失败,父级菜单不存在")
new_menu = await MenuCRUD(auth).update(id=id, data=data)
if data.status is not None:
await cls.set_available_service(auth=auth, data=BatchSetAvailable(ids=[id], status=data.status))
menu_out = MenuOutSchema.model_validate(new_menu)
if menu_out.parent_id:
parent = await MenuCRUD(auth).get(id=menu_out.parent_id)
if parent:
menu_out.parent_name = parent.name
return menu_out
@classmethod
@require_superadmin
async def delete_service(cls, auth: AuthSchema, ids: list[int]) -> None:
"""
删除菜单。
参数:
- auth (AuthSchema): 认证对象。
- ids (list[int]): 菜单ID列表。
返回:
- None
"""
if len(ids) < 1:
raise CustomException(msg="删除失败,删除对象不能为空")
# 获取所有菜单列表,用于构建树形关系
all_menus = await MenuCRUD(auth).list()
# 构建子菜单ID映射
child_id_map = get_child_id_map(model_list=all_menus)
# 收集所有需要删除的菜单ID,包括直接指定的ID和它们的所有子菜单ID
delete_ids_set = set()
for id in ids:
# 递归获取该ID的所有子菜单ID
all_descendants = get_child_recursion(id=id, id_map=child_id_map)
delete_ids_set.update(all_descendants)
# 将集合转换为列表
delete_ids = list(delete_ids_set)
# 执行批量删除操作
await MenuCRUD(auth).delete(ids=delete_ids)
@classmethod
@require_superadmin
async def set_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None:
"""
递归获取所有父、子级菜单,然后批量修改菜单可用状态。
参数:
- auth (AuthSchema): 认证对象。
- data (BatchSetAvailable): 批量设置可用参数对象。
返回:
- None
"""
menu_list = await MenuCRUD(auth).list()
total_ids = []
if data.status == 0:
# 激活,则需要把所有父级菜单都激活
id_map = get_parent_id_map(model_list=menu_list)
for menu_id in data.ids:
enable_ids = get_parent_recursion(id=menu_id, id_map=id_map)
total_ids.extend(enable_ids)
else:
# 禁止,则需要把所有子级菜单都禁止
id_map = get_child_id_map(model_list=menu_list)
for menu_id in data.ids:
disable_ids = get_child_recursion(id=menu_id, id_map=id_map)
total_ids.extend(disable_ids)
await MenuCRUD(auth).set(ids=total_ids, status=data.status)