Browse Source

perf: 优化菜单管理模块service层及异常处理

master
insistence 11 months ago
parent
commit
013ea25731
  1. 47
      ruoyi-fastapi-backend/module_admin/controller/menu_controller.py
  2. 34
      ruoyi-fastapi-backend/module_admin/dao/menu_dao.py
  3. 62
      ruoyi-fastapi-backend/module_admin/service/menu_service.py
  4. 12
      ruoyi-fastapi-backend/utils/string_util.py

47
ruoyi-fastapi-backend/module_admin/controller/menu_controller.py

@ -16,100 +16,67 @@ menuController = APIRouter(prefix='/system/menu', dependencies=[Depends(LoginSer
@menuController.get("/treeselect") @menuController.get("/treeselect")
async def get_system_menu_tree(request: Request, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)): async def get_system_menu_tree(request: Request, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)):
try:
menu_query_result = await MenuService.get_menu_tree_services(query_db, current_user) menu_query_result = await MenuService.get_menu_tree_services(query_db, current_user)
logger.info('获取成功') logger.info('获取成功')
return ResponseUtil.success(data=menu_query_result) return ResponseUtil.success(data=menu_query_result)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@menuController.get("/roleMenuTreeselect/{role_id}") @menuController.get("/roleMenuTreeselect/{role_id}")
async def get_system_role_menu_tree(request: Request, role_id: int, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)): async def get_system_role_menu_tree(request: Request, role_id: int, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)):
try:
role_menu_query_result = await MenuService.get_role_menu_tree_services(query_db, role_id, current_user) role_menu_query_result = await MenuService.get_role_menu_tree_services(query_db, role_id, current_user)
logger.info('获取成功') logger.info('获取成功')
return ResponseUtil.success(model_content=role_menu_query_result) return ResponseUtil.success(model_content=role_menu_query_result)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@menuController.get("/list", response_model=List[MenuModel], dependencies=[Depends(CheckUserInterfaceAuth('system:menu:list'))]) @menuController.get("/list", response_model=List[MenuModel], dependencies=[Depends(CheckUserInterfaceAuth('system:menu:list'))])
async def get_system_menu_list(request: Request, menu_query: MenuQueryModel = Depends(MenuQueryModel.as_query), query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)): async def get_system_menu_list(request: Request, menu_query: MenuQueryModel = Depends(MenuQueryModel.as_query), query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)):
try:
menu_query_result = await MenuService.get_menu_list_services(query_db, menu_query, current_user) menu_query_result = await MenuService.get_menu_list_services(query_db, menu_query, current_user)
logger.info('获取成功') logger.info('获取成功')
return ResponseUtil.success(data=menu_query_result) return ResponseUtil.success(data=menu_query_result)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@menuController.post("", dependencies=[Depends(CheckUserInterfaceAuth('system:menu:add'))]) @menuController.post("", dependencies=[Depends(CheckUserInterfaceAuth('system:menu:add'))])
@ValidateFields(validate_model='add_menu') @ValidateFields(validate_model='add_menu')
@log_decorator(title='菜单管理', business_type=BusinessType.INSERT) @log_decorator(title='菜单管理', business_type=BusinessType.INSERT)
async def add_system_menu(request: Request, add_menu: MenuModel, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)): async def add_system_menu(request: Request, add_menu: MenuModel, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)):
try:
add_menu.create_by = current_user.user.user_name add_menu.create_by = current_user.user.user_name
add_menu.create_time = datetime.now() add_menu.create_time = datetime.now()
add_menu.update_by = current_user.user.user_name add_menu.update_by = current_user.user.user_name
add_menu.update_time = datetime.now() add_menu.update_time = datetime.now()
add_menu_result = await MenuService.add_menu_services(query_db, add_menu) add_menu_result = await MenuService.add_menu_services(query_db, add_menu)
if add_menu_result.is_success:
logger.info(add_menu_result.message) logger.info(add_menu_result.message)
return ResponseUtil.success(msg=add_menu_result.message) return ResponseUtil.success(msg=add_menu_result.message)
else:
logger.warning(add_menu_result.message)
return ResponseUtil.failure(msg=add_menu_result.message)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@menuController.put("", dependencies=[Depends(CheckUserInterfaceAuth('system:menu:edit'))]) @menuController.put("", dependencies=[Depends(CheckUserInterfaceAuth('system:menu:edit'))])
@ValidateFields(validate_model='edit_menu') @ValidateFields(validate_model='edit_menu')
@log_decorator(title='菜单管理', business_type=BusinessType.UPDATE) @log_decorator(title='菜单管理', business_type=BusinessType.UPDATE)
async def edit_system_menu(request: Request, edit_menu: MenuModel, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)): async def edit_system_menu(request: Request, edit_menu: MenuModel, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)):
try:
edit_menu.update_by = current_user.user.user_name edit_menu.update_by = current_user.user.user_name
edit_menu.update_time = datetime.now() edit_menu.update_time = datetime.now()
edit_menu_result = await MenuService.edit_menu_services(query_db, edit_menu) edit_menu_result = await MenuService.edit_menu_services(query_db, edit_menu)
if edit_menu_result.is_success:
logger.info(edit_menu_result.message) logger.info(edit_menu_result.message)
return ResponseUtil.success(msg=edit_menu_result.message) return ResponseUtil.success(msg=edit_menu_result.message)
else:
logger.warning(edit_menu_result.message)
return ResponseUtil.failure(msg=edit_menu_result.message)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@menuController.delete("/{menu_ids}", dependencies=[Depends(CheckUserInterfaceAuth('system:menu:remove'))]) @menuController.delete("/{menu_ids}", dependencies=[Depends(CheckUserInterfaceAuth('system:menu:remove'))])
@log_decorator(title='菜单管理', business_type=BusinessType.DELETE) @log_decorator(title='菜单管理', business_type=BusinessType.DELETE)
async def delete_system_menu(request: Request, menu_ids: str, query_db: AsyncSession = Depends(get_db)): async def delete_system_menu(request: Request, menu_ids: str, query_db: AsyncSession = Depends(get_db)):
try:
delete_menu = DeleteMenuModel(menuIds=menu_ids) delete_menu = DeleteMenuModel(menuIds=menu_ids)
delete_menu_result = await MenuService.delete_menu_services(query_db, delete_menu) delete_menu_result = await MenuService.delete_menu_services(query_db, delete_menu)
if delete_menu_result.is_success:
logger.info(delete_menu_result.message) logger.info(delete_menu_result.message)
return ResponseUtil.success(msg=delete_menu_result.message) return ResponseUtil.success(msg=delete_menu_result.message)
else:
logger.warning(delete_menu_result.message)
return ResponseUtil.failure(msg=delete_menu_result.message)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@menuController.get("/{menu_id}", response_model=MenuModel, dependencies=[Depends(CheckUserInterfaceAuth('system:menu:query'))]) @menuController.get("/{menu_id}", response_model=MenuModel, dependencies=[Depends(CheckUserInterfaceAuth('system:menu:query'))])
async def query_detail_system_menu(request: Request, menu_id: int, query_db: AsyncSession = Depends(get_db)): async def query_detail_system_menu(request: Request, menu_id: int, query_db: AsyncSession = Depends(get_db)):
try:
menu_detail_result = await MenuService.menu_detail_services(query_db, menu_id) menu_detail_result = await MenuService.menu_detail_services(query_db, menu_id)
logger.info(f'获取menu_id为{menu_id}的信息成功') logger.info(f'获取menu_id为{menu_id}的信息成功')
return ResponseUtil.success(data=menu_detail_result) return ResponseUtil.success(data=menu_detail_result)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))

34
ruoyi-fastapi-backend/module_admin/dao/menu_dao.py

@ -1,4 +1,4 @@
from sqlalchemy import select, update, delete, and_ from sqlalchemy import select, update, delete, and_, func
from sqlalchemy.ext.asyncio import AsyncSession from sqlalchemy.ext.asyncio import AsyncSession
from module_admin.entity.do.menu_do import SysMenu from module_admin.entity.do.menu_do import SysMenu
from module_admin.entity.do.user_do import SysUser, SysUserRole from module_admin.entity.do.user_do import SysUser, SysUserRole
@ -156,3 +156,35 @@ class MenuDao:
delete(SysMenu) delete(SysMenu)
.where(SysMenu.menu_id.in_([menu.menu_id])) .where(SysMenu.menu_id.in_([menu.menu_id]))
) )
@classmethod
async def has_child_by_menu_id_dao(cls, db: AsyncSession, menu_id: int):
"""
根据菜单id查询菜单关联子菜单的数量
:param db: orm对象
:param menu_id: 菜单id
:return: 菜单关联子菜单的数量
"""
menu_count = (await db.execute(
select(func.count('*'))
.select_from(SysMenu)
.where(SysMenu.menu_id == menu_id)
)).scalar()
return menu_count
@classmethod
async def check_menu_exist_role_dao(cls, db: AsyncSession, menu_id: int):
"""
根据菜单id查询菜单关联角色数量
:param db: orm对象
:param menu_id: 菜单id
:return: 菜单关联角色数量
"""
role_count = (await db.execute(
select(func.count('*'))
.select_from(SysRoleMenu)
.where(SysRoleMenu.menu_id == menu_id)
)).scalar()
return role_count

62
ruoyi-fastapi-backend/module_admin/service/menu_service.py

@ -3,7 +3,10 @@ from module_admin.entity.vo.role_vo import RoleMenuQueryModel
from module_admin.entity.vo.common_vo import CrudResponseModel from module_admin.entity.vo.common_vo import CrudResponseModel
from module_admin.dao.role_dao import RoleDao from module_admin.dao.role_dao import RoleDao
from module_admin.dao.menu_dao import * from module_admin.dao.menu_dao import *
from config.constant import CommonConstant, MenuConstant
from exceptions.exception import ServiceException
from utils.common_util import CamelCaseUtil from utils.common_util import CamelCaseUtil
from utils.string_util import StringUtil
class MenuService: class MenuService:
@ -57,6 +60,20 @@ class MenuService:
return CamelCaseUtil.transform_result(menu_list_result) return CamelCaseUtil.transform_result(menu_list_result)
@classmethod
async def check_menu_name_unique_services(cls, query_db: AsyncSession, page_object: MenuModel):
"""
校验菜单名称是否唯一service
:param query_db: orm对象
:param page_object: 菜单对象
:return: 校验结果
"""
menu_id = -1 if page_object.menu_id is None else page_object.menu_id
menu = await MenuDao.get_menu_detail_by_info(query_db, MenuModel(menuName=page_object.menu_name))
if menu and menu.menu_id != menu_id:
return CommonConstant.NOT_UNIQUE
return CommonConstant.UNIQUE
@classmethod @classmethod
async def add_menu_services(cls, query_db: AsyncSession, page_object: MenuModel): async def add_menu_services(cls, query_db: AsyncSession, page_object: MenuModel):
""" """
@ -65,20 +82,19 @@ class MenuService:
:param page_object: 新增菜单对象 :param page_object: 新增菜单对象
:return: 新增菜单校验结果 :return: 新增菜单校验结果
""" """
menu = await MenuDao.get_menu_detail_by_info(query_db, MenuModel(parentId=page_object.parent_id, menuName=page_object.menu_name, menuType=page_object.menu_type)) if not await cls.check_menu_name_unique_services(query_db, page_object):
if menu: raise ServiceException(message=f'新增菜单{page_object.post_name}失败,菜单名称已存在')
result = dict(is_success=False, message='同一目录下不允许存在同名同类型的菜单') elif page_object.is_frame == MenuConstant.YES_FRAME and not StringUtil.is_http(page_object.path):
raise ServiceException(message=f'新增菜单{page_object.post_name}失败,地址必须以http(s)://开头')
else: else:
try: try:
await MenuDao.add_menu_dao(query_db, page_object) await MenuDao.add_menu_dao(query_db, page_object)
await query_db.commit() await query_db.commit()
result = dict(is_success=True, message='新增成功') return CrudResponseModel(is_success=True, message='新增成功')
except Exception as e: except Exception as e:
await query_db.rollback() await query_db.rollback()
raise e raise e
return CrudResponseModel(**result)
@classmethod @classmethod
async def edit_menu_services(cls, query_db: AsyncSession, page_object: MenuModel): async def edit_menu_services(cls, query_db: AsyncSession, page_object: MenuModel):
""" """
@ -88,24 +104,24 @@ class MenuService:
:return: 编辑菜单校验结果 :return: 编辑菜单校验结果
""" """
edit_menu = page_object.model_dump(exclude_unset=True) edit_menu = page_object.model_dump(exclude_unset=True)
menu_info = await cls.menu_detail_services(query_db, edit_menu.get('menu_id')) menu_info = await cls.menu_detail_services(query_db, page_object.menu_id)
if menu_info: if menu_info.menu_id:
if menu_info.parent_id != page_object.parent_id or menu_info.menu_name != page_object.menu_name or menu_info.menu_type != page_object.menu_type: if not await cls.check_menu_name_unique_services(query_db, page_object):
menu = await MenuDao.get_menu_detail_by_info(query_db, MenuModel(parentId=page_object.parent_id, menuName=page_object.menu_name, menuType=page_object.menu_type)) raise ServiceException(message=f'修改菜单{page_object.post_name}失败,菜单名称已存在')
if menu: elif page_object.is_frame == MenuConstant.YES_FRAME and not StringUtil.is_http(page_object.path):
result = dict(is_success=False, message='同一目录下不允许存在同名同类型的菜单') raise ServiceException(message=f'修改菜单{page_object.post_name}失败,地址必须以http(s)://开头')
return CrudResponseModel(**result) elif page_object.menu_id == page_object.parent_id:
raise ServiceException(message=f'修改菜单{page_object.post_name}失败,上级菜单不能选择自己')
else:
try: try:
await MenuDao.edit_menu_dao(query_db, edit_menu) await MenuDao.edit_menu_dao(query_db, edit_menu)
await query_db.commit() await query_db.commit()
result = dict(is_success=True, message='更新成功') return CrudResponseModel(is_success=True, message='更新成功')
except Exception as e: except Exception as e:
await query_db.rollback() await query_db.rollback()
raise e raise e
else: else:
result = dict(is_success=False, message='菜单不存在') raise ServiceException(message='菜单不存在')
return CrudResponseModel(**result)
@classmethod @classmethod
async def delete_menu_services(cls, query_db: AsyncSession, page_object: DeleteMenuModel): async def delete_menu_services(cls, query_db: AsyncSession, page_object: DeleteMenuModel):
@ -119,15 +135,18 @@ class MenuService:
menu_id_list = page_object.menu_ids.split(',') menu_id_list = page_object.menu_ids.split(',')
try: try:
for menu_id in menu_id_list: for menu_id in menu_id_list:
if (await MenuDao.has_child_by_menu_id_dao(query_db, int(menu_id))) > 0:
raise ServiceException(message='存在子菜单,不允许删除')
elif (await MenuDao.check_menu_exist_role_dao(query_db, int(menu_id))) > 0:
raise ServiceException(message='菜单已分配,不允许删除')
await MenuDao.delete_menu_dao(query_db, MenuModel(menuId=menu_id)) await MenuDao.delete_menu_dao(query_db, MenuModel(menuId=menu_id))
await query_db.commit() await query_db.commit()
result = dict(is_success=True, message='删除成功') return CrudResponseModel(is_success=True, message='删除成功')
except Exception as e: except Exception as e:
await query_db.rollback() await query_db.rollback()
raise e raise e
else: else:
result = dict(is_success=False, message='传入菜单id为空') raise ServiceException(message='传入菜单id为空')
return CrudResponseModel(**result)
@classmethod @classmethod
async def menu_detail_services(cls, query_db: AsyncSession, menu_id: int): async def menu_detail_services(cls, query_db: AsyncSession, menu_id: int):
@ -138,7 +157,10 @@ class MenuService:
:return: 菜单id对应的信息 :return: 菜单id对应的信息
""" """
menu = await MenuDao.get_menu_detail_by_id(query_db, menu_id=menu_id) menu = await MenuDao.get_menu_detail_by_id(query_db, menu_id=menu_id)
if menu:
result = MenuModel(**CamelCaseUtil.transform_result(menu)) result = MenuModel(**CamelCaseUtil.transform_result(menu))
else:
result = MenuModel(**dict())
return result return result

12
ruoyi-fastapi-backend/utils/string_util.py

@ -1,3 +1,6 @@
from config.constant import CommonConstant
class StringUtil: class StringUtil:
""" """
字符串工具类 字符串工具类
@ -29,3 +32,12 @@ class StringUtil:
:return: 校验结果 :return: 校验结果
""" """
return string is None or len(string) == 0 return string is None or len(string) == 0
@classmethod
def is_http(cls, link: str):
"""
判断是否为http(s)://开头
:param link: 链接
:return: 是否为http(s)://开头
"""
return link.startswith(CommonConstant.HTTP) or link.startswith(CommonConstant.HTTPS)

Loading…
Cancel
Save