refactor: 重构数据库orm为异步 #I9MRQS

ruoyi-fastapi-backend/module_admin/dao/role_dao.py

@@ -1,5 +1,5 @@
-from sqlalchemy import desc, func
-from sqlalchemy.orm import Session
+from sqlalchemy import select, update, delete, desc, func
+from sqlalchemy.ext.asyncio import AsyncSession
 from module_admin.entity.do.role_do import SysRole, SysRoleMenu, SysRoleDept
 from module_admin.entity.do.dept_do import SysDept
 from module_admin.entity.vo.role_vo import *
@@ -13,80 +13,90 @@ class RoleDao:
     """
 
     @classmethod
-    def get_role_by_name(cls, db: Session, role_name: str):
+    async def get_role_by_name(cls, db: AsyncSession, role_name: str):
         """
         根据角色名获取在用角色信息
         :param db: orm对象
         :param role_name: 角色名
         :return: 当前角色名的角色信息对象
         """
-        query_role_info = db.query(SysRole) \
-            .filter(SysRole.status == 0, SysRole.del_flag == 0, SysRole.role_name == role_name) \
-            .order_by(desc(SysRole.create_time)).distinct().first()
+        query_role_info = (await db.execute(
+            select(SysRole)
+                .where(SysRole.status == 0, SysRole.del_flag == 0, SysRole.role_name == role_name)
+                .order_by(desc(SysRole.create_time))
+                .distinct()
+        )).scalars().first()
 
         return query_role_info
 
     @classmethod
-    def get_role_by_info(cls, db: Session, role: RoleModel):
+    async def get_role_by_info(cls, db: AsyncSession, role: RoleModel):
         """
         根据角色参数获取角色信息
         :param db: orm对象
         :param role: 角色参数
         :return: 当前角色参数的角色信息对象
         """
-        query_role_info = db.query(SysRole) \
-            .filter(SysRole.del_flag == 0,
-                    SysRole.role_name == role.role_name if role.role_name else True,
-                    SysRole.role_key == role.role_key if role.role_key else True) \
-            .order_by(desc(SysRole.create_time)).distinct().first()
+        query_role_info = (await db.execute(
+            select(SysRole)
+                .where(SysRole.del_flag == 0,
+                       SysRole.role_name == role.role_name if role.role_name else True,
+                       SysRole.role_key == role.role_key if role.role_key else True)
+                .order_by(desc(SysRole.create_time))
+                .distinct()
+        )).scalars().first()
 
         return query_role_info
 
     @classmethod
-    def get_role_by_id(cls, db: Session, role_id: int):
+    async def get_role_by_id(cls, db: AsyncSession, role_id: int):
         """
         根据角色id获取在用角色信息
         :param db: orm对象
         :param role_id: 角色id
         :return: 当前角色id的角色信息对象
         """
-        role_info = db.query(SysRole) \
-            .filter(SysRole.role_id == role_id,
-                    SysRole.status == 0,
-                    SysRole.del_flag == 0) \
-            .first()
+        role_info = (await db.execute(
+            select(SysRole)
+                .where(SysRole.role_id == role_id,
+                       SysRole.status == 0,
+                       SysRole.del_flag == 0)
+        )).scalars().first()
 
         return role_info
 
     @classmethod
-    def get_role_detail_by_id(cls, db: Session, role_id: int):
+    async def get_role_detail_by_id(cls, db: AsyncSession, role_id: int):
         """
         根据role_id获取角色详细信息
         :param db: orm对象
         :param role_id: 角色id
         :return: 当前role_id的角色信息对象
         """
-        query_role_info = db.query(SysRole) \
-            .filter(SysRole.del_flag == 0, SysRole.role_id == role_id) \
-            .distinct().first()
+        query_role_info = (await db.execute(
+            select(SysRole)
+                .where(SysRole.del_flag == 0, SysRole.role_id == role_id)
+                .distinct()
+        )).scalars().first()
 
         return query_role_info
 
     @classmethod
-    def get_role_select_option_dao(cls, db: Session):
+    async def get_role_select_option_dao(cls, db: AsyncSession):
         """
         获取编辑页面对应的在用角色列表信息
         :param db: orm对象
         :return: 角色列表信息
         """
-        role_info = db.query(SysRole) \
-            .filter(SysRole.role_id != 1, SysRole.status == 0, SysRole.del_flag == 0) \
-            .all()
+        role_info = (await db.execute(
+            select(SysRole)
+                .where(SysRole.role_id != 1, SysRole.status == 0, SysRole.del_flag == 0)
+        )).scalars().all()
 
         return role_info
 
     @classmethod
-    def get_role_list(cls, db: Session, query_object: RolePageQueryModel, is_page: bool = False):
+    async def get_role_list(cls, db: AsyncSession, query_object: RolePageQueryModel, is_page: bool = False):
         """
         根据查询参数获取角色列表信息
         :param db: orm对象
@@ -94,24 +104,23 @@ class RoleDao:
         :param is_page: 是否开启分页
         :return: 角色列表信息对象
         """
-        query = db.query(SysRole) \
-            .filter(SysRole.del_flag == 0,
-                    SysRole.role_name.like(f'%{query_object.role_name}%') if query_object.role_name else True,
-                    SysRole.role_key.like(f'%{query_object.role_key}%') if query_object.role_key else True,
-                    SysRole.status == query_object.status if query_object.status else True,
-                    SysRole.create_time.between(
-                        datetime.combine(datetime.strptime(query_object.begin_time, '%Y-%m-%d'), time(00, 00, 00)),
-                        datetime.combine(datetime.strptime(query_object.end_time, '%Y-%m-%d'), time(23, 59, 59)))
-                    if query_object.begin_time and query_object.end_time else True
-                    ) \
+        query = select(SysRole) \
+            .where(SysRole.del_flag == 0,
+                   SysRole.role_name.like(f'%{query_object.role_name}%') if query_object.role_name else True,
+                   SysRole.role_key.like(f'%{query_object.role_key}%') if query_object.role_key else True,
+                   SysRole.status == query_object.status if query_object.status else True,
+                   SysRole.create_time.between(
+                       datetime.combine(datetime.strptime(query_object.begin_time, '%Y-%m-%d'), time(00, 00, 00)),
+                       datetime.combine(datetime.strptime(query_object.end_time, '%Y-%m-%d'), time(23, 59, 59)))
+                   if query_object.begin_time and query_object.end_time else True) \
             .order_by(SysRole.role_sort) \
             .distinct()
-        role_list = PageUtil.paginate(query, query_object.page_num, query_object.page_size, is_page)
+        role_list = await PageUtil.paginate(db, query, query_object.page_num, query_object.page_size, is_page)
 
         return role_list
 
     @classmethod
-    def add_role_dao(cls, db: Session, role: RoleModel):
+    async def add_role_dao(cls, db: AsyncSession, role: RoleModel):
         """
         新增角色数据库操作
         :param db: orm对象
@@ -120,50 +129,55 @@ class RoleDao:
         """
         db_role = SysRole(**role.model_dump(exclude={'admin'}))
         db.add(db_role)
-        db.flush()
+        await db.flush()
 
         return db_role
 
     @classmethod
-    def edit_role_dao(cls, db: Session, role: dict):
+    async def edit_role_dao(cls, db: AsyncSession, role: dict):
         """
         编辑角色数据库操作
         :param db: orm对象
         :param role: 需要更新的角色字典
         :return:
         """
-        db.query(SysRole) \
-            .filter(SysRole.role_id == role.get('role_id')) \
-            .update(role)
+        await db.execute(
+            update(SysRole),
+            [role]
+        )
 
     @classmethod
-    def delete_role_dao(cls, db: Session, role: RoleModel):
+    async def delete_role_dao(cls, db: AsyncSession, role: RoleModel):
         """
         删除角色数据库操作
         :param db: orm对象
         :param role: 角色对象
         :return:
         """
-        db.query(SysRole) \
-            .filter(SysRole.role_id == role.role_id) \
-            .update({SysRole.del_flag: '2', SysRole.update_by: role.update_by, SysRole.update_time: role.update_time})
+        await db.execute(
+            update(SysRole)
+                .where(SysRole.role_id == role.role_id)
+                .values(del_flag='2', update_by=role.update_by, update_time=role.update_time)
+        )
 
     @classmethod
-    def get_role_menu_dao(cls, db: Session, role_id: int):
+    async def get_role_menu_dao(cls, db: AsyncSession, role_id: int):
         """
         根据角色id获取角色菜单关联列表信息
         :param db: orm对象
         :param role_id: 角色id
         :return: 角色菜单关联列表信息
         """
-        role_menu_query_all = db.query(SysRoleMenu) \
-            .filter(SysRoleMenu.role_id == role_id) \
-            .distinct().all()
+        role_menu_query_all = (await db.execute(
+            select(SysRoleMenu)
+                .where(SysRoleMenu.role_id == role_id)
+                .distinct()
+        )).scalars().all()
 
         return role_menu_query_all
 
     @classmethod
-    def add_role_menu_dao(cls, db: Session, role_menu: RoleMenuModel):
+    async def add_role_menu_dao(cls, db: AsyncSession, role_menu: RoleMenuModel):
         """
         新增角色菜单关联信息数据库操作
         :param db: orm对象
@@ -174,35 +188,37 @@ class RoleDao:
         db.add(db_role_menu)
 
     @classmethod
-    def delete_role_menu_dao(cls, db: Session, role_menu: RoleMenuModel):
+    async def delete_role_menu_dao(cls, db: AsyncSession, role_menu: RoleMenuModel):
         """
         删除角色菜单关联信息数据库操作
         :param db: orm对象
         :param role_menu: 角色菜单关联对象
         :return:
         """
-        db.query(SysRoleMenu) \
-            .filter(SysRoleMenu.role_id == role_menu.role_id) \
-            .delete()
+        await db.execute(
+            delete(SysRoleMenu)
+                .where(SysRoleMenu.role_id.in_([role_menu.role_id]))
+        )
 
     @classmethod
-    def get_role_dept_dao(cls, db: Session, role_id: int):
+    async def get_role_dept_dao(cls, db: AsyncSession, role_id: int):
         """
         根据角色id获取角色部门关联列表信息
         :param db: orm对象
         :param role_id: 角色id
         :return: 角色部门关联列表信息
         """
-        role_dept_query_all = db.query(SysRoleDept) \
-            .filter(SysRoleDept.role_id == role_id,
-                    ~db.query(SysDept).filter(func.find_in_set(SysRoleDept.dept_id, SysDept.ancestors)).exists()
-                    ) \
-            .distinct().all()
+        role_dept_query_all = (await db.execute(
+            select(SysRoleDept)
+                .where(SysRoleDept.role_id == role_id,
+                       ~select(SysDept).where(func.find_in_set(SysRoleDept.dept_id, SysDept.ancestors)).exists())
+                .distinct()
+        )).scalars().all()
 
         return role_dept_query_all
 
     @classmethod
-    def add_role_dept_dao(cls, db: Session, role_dept: RoleDeptModel):
+    async def add_role_dept_dao(cls, db: AsyncSession, role_dept: RoleDeptModel):
         """
         新增角色部门关联信息数据库操作
         :param db: orm对象
@@ -213,13 +229,14 @@ class RoleDao:
         db.add(db_role_dept)
 
     @classmethod
-    def delete_role_dept_dao(cls, db: Session, role_dept: RoleDeptModel):
+    async def delete_role_dept_dao(cls, db: AsyncSession, role_dept: RoleDeptModel):
         """
         删除角色部门关联信息数据库操作
         :param db: orm对象
         :param role_dept: 角色部门关联对象
         :return:
         """
-        db.query(SysRoleDept) \
-            .filter(SysRoleDept.role_id == role_dept.role_id) \
-            .delete()
+        await db.execute(
+            delete(SysRoleDept)
+                .where(SysRoleDept.role_id.in_([role_dept.role_id]))
+        )