From e3b422cc6e82f4b4f86082c794ca3bdbd4385aa2 Mon Sep 17 00:00:00 2001 From: insistence <3055204202@qq.com> Date: Sat, 13 Jul 2024 18:15:35 +0800 Subject: [PATCH] =?UTF-8?q?style:=20=E4=BC=98=E5=8C=96=E9=83=A8=E5=88=86?= =?UTF-8?q?=E6=96=87=E4=BB=B6=E4=B8=AD=E7=9A=84=E5=87=BD=E6=95=B0=E5=8F=8A?= =?UTF-8?q?=E7=B1=BB=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ruoyi-fastapi-backend/config/constant.py | 3 ++ ruoyi-fastapi-backend/config/enums.py | 1 + ruoyi-fastapi-backend/config/get_db.py | 2 ++ ruoyi-fastapi-backend/config/get_redis.py | 4 +++ ruoyi-fastapi-backend/config/get_scheduler.py | 6 ++++ .../module_admin/annotation/log_annotation.py | 4 ++- .../module_admin/aspect/interface_auth.py | 16 +++++++--- .../module_admin/dao/config_dao.py | 6 ++++ .../module_admin/dao/dept_dao.py | 15 +++++++++ .../module_admin/dao/dict_dao.py | 15 +++++++++ .../module_admin/dao/job_dao.py | 7 ++++ .../module_admin/dao/job_log_dao.py | 4 +++ .../module_admin/dao/log_dao.py | 8 +++++ .../module_admin/dao/login_dao.py | 1 + .../module_admin/dao/menu_dao.py | 9 ++++++ .../module_admin/dao/notice_dao.py | 6 ++++ .../module_admin/dao/post_dao.py | 8 +++++ .../module_admin/dao/role_dao.py | 16 ++++++++++ .../module_admin/dao/user_dao.py | 17 ++++++++++ .../module_admin/service/cache_service.py | 7 ++++ .../module_admin/service/common_service.py | 3 ++ .../module_admin/service/config_service.py | 10 ++++++ .../module_admin/service/dept_service.py | 13 ++++++++ .../module_admin/service/dict_service.py | 18 +++++++++++ .../module_admin/service/job_log_service.py | 5 +++ .../module_admin/service/job_service.py | 7 ++++ .../module_admin/service/log_service.py | 10 ++++++ .../module_admin/service/login_service.py | 20 ++++++++++++ .../module_admin/service/menu_service.py | 9 ++++++ .../module_admin/service/notice_service.py | 6 ++++ .../module_admin/service/online_service.py | 2 ++ .../module_admin/service/post_service.py | 8 +++++ .../module_admin/service/role_service.py | 15 +++++++++ .../module_admin/service/user_service.py | 21 +++++++++++- ruoyi-fastapi-backend/utils/common_util.py | 9 +++++- ruoyi-fastapi-backend/utils/page_util.py | 3 ++ ruoyi-fastapi-backend/utils/pwd_util.py | 2 ++ ruoyi-fastapi-backend/utils/response_util.py | 20 ++++++++---- ruoyi-fastapi-backend/utils/string_util.py | 3 ++ .../utils/time_format_util.py | 1 + ruoyi-fastapi-backend/utils/upload_util.py | 32 ++++++++++++++++--- 41 files changed, 353 insertions(+), 19 deletions(-) diff --git a/ruoyi-fastapi-backend/config/constant.py b/ruoyi-fastapi-backend/config/constant.py index e30fa78..46ad2ea 100644 --- a/ruoyi-fastapi-backend/config/constant.py +++ b/ruoyi-fastapi-backend/config/constant.py @@ -1,6 +1,7 @@ class CommonConstant: """ 常用常量 + WWW: www主域 HTTP: http请求 HTTPS: https请求 @@ -26,6 +27,7 @@ class CommonConstant: class HttpStatusConstant: """ 返回状态码 + SUCCESS: 操作成功 CREATED: 对象创建成功 ACCEPTED: 请求已经被接受 @@ -67,6 +69,7 @@ class HttpStatusConstant: class MenuConstant: """ 菜单常量 + TYPE_DIR: 菜单类型（目录） TYPE_MENU: 菜单类型（菜单） TYPE_BUTTON: 菜单类型（按钮） diff --git a/ruoyi-fastapi-backend/config/enums.py b/ruoyi-fastapi-backend/config/enums.py index 673a4cb..d1a9e56 100644 --- a/ruoyi-fastapi-backend/config/enums.py +++ b/ruoyi-fastapi-backend/config/enums.py @@ -4,6 +4,7 @@ from enum import Enum class BusinessType(Enum): """ 业务操作类型 + OTHER: 其它 INSERT: 新增 UPDATE: 修改 diff --git a/ruoyi-fastapi-backend/config/get_db.py b/ruoyi-fastapi-backend/config/get_db.py index d88405d..20986ae 100644 --- a/ruoyi-fastapi-backend/config/get_db.py +++ b/ruoyi-fastapi-backend/config/get_db.py @@ -5,6 +5,7 @@ from utils.log_util import logger async def get_db(): """ 每一个请求处理完毕后会关闭当前连接，不同的请求使用不同的连接 + :return: """ async with AsyncSessionLocal() as current_db: @@ -14,6 +15,7 @@ async def get_db(): async def init_create_table(): """ 应用启动时初始化数据库连接 + :return: """ logger.info('初始化数据库连接...') diff --git a/ruoyi-fastapi-backend/config/get_redis.py b/ruoyi-fastapi-backend/config/get_redis.py index 0543193..9d78cad 100644 --- a/ruoyi-fastapi-backend/config/get_redis.py +++ b/ruoyi-fastapi-backend/config/get_redis.py @@ -16,6 +16,7 @@ class RedisUtil: async def create_redis_pool(cls) -> aioredis.Redis: """ 应用启动时初始化redis连接 + :return: Redis连接对象 """ logger.info('开始连接redis...') @@ -46,6 +47,7 @@ class RedisUtil: async def close_redis_pool(cls, app): """ 应用关闭时关闭redis连接 + :param app: fastapi对象 :return: """ @@ -56,6 +58,7 @@ class RedisUtil: async def init_sys_dict(cls, redis): """ 应用启动时缓存字典表 + :param redis: redis对象 :return: """ @@ -66,6 +69,7 @@ class RedisUtil: async def init_sys_config(cls, redis): """ 应用启动时缓存参数配置表 + :param redis: redis对象 :return: """ diff --git a/ruoyi-fastapi-backend/config/get_scheduler.py b/ruoyi-fastapi-backend/config/get_scheduler.py index 68c6f63..b9cfa00 100644 --- a/ruoyi-fastapi-backend/config/get_scheduler.py +++ b/ruoyi-fastapi-backend/config/get_scheduler.py @@ -118,6 +118,7 @@ class SchedulerUtil: async def init_system_scheduler(cls): """ 应用启动时初始化定时任务 + :return: """ logger.info('开始启动定时任务...') @@ -136,6 +137,7 @@ class SchedulerUtil: async def close_system_scheduler(cls): """ 应用关闭时关闭定时任务 + :return: """ scheduler.shutdown() @@ -145,6 +147,7 @@ class SchedulerUtil: def get_scheduler_job(cls, job_id): """ 根据任务id获取任务对象 + :param job_id: 任务id :return: 任务对象 """ @@ -156,6 +159,7 @@ class SchedulerUtil: def add_scheduler_job(cls, job_info): """ 根据输入的任务对象信息添加任务 + :param job_info: 任务对象信息 :return: """ @@ -177,6 +181,7 @@ class SchedulerUtil: def execute_scheduler_job_once(cls, job_info): """ 根据输入的任务对象执行一次任务 + :param job_info: 任务对象信息 :return: """ @@ -199,6 +204,7 @@ class SchedulerUtil: def remove_scheduler_job(cls, job_id): """ 根据任务id移除任务 + :param job_id: 任务id :return: """ diff --git a/ruoyi-fastapi-backend/module_admin/annotation/log_annotation.py b/ruoyi-fastapi-backend/module_admin/annotation/log_annotation.py index 36f531b..a074c5b 100644 --- a/ruoyi-fastapi-backend/module_admin/annotation/log_annotation.py +++ b/ruoyi-fastapi-backend/module_admin/annotation/log_annotation.py @@ -24,9 +24,10 @@ def log_decorator( ): """ 日志装饰器 - :param log_type: 日志类型（login表示登录日志，为空表示为操作日志） + :param title: 当前日志装饰器装饰的模块标题 :param business_type: 业务类型（0其它 1新增 2修改 3删除 4授权 5导出 6导入 7强退 8生成代码 9清空数据） + :param log_type: 日志类型（login表示登录日志，operation表示为操作日志） :return: """ warnings.simplefilter('always', category=DeprecationWarning) @@ -193,6 +194,7 @@ def log_decorator( def get_ip_location(oper_ip: str): """ 查询ip归属区域 + :param oper_ip: 需要查询的ip :return: ip归属区域 """ diff --git a/ruoyi-fastapi-backend/module_admin/aspect/interface_auth.py b/ruoyi-fastapi-backend/module_admin/aspect/interface_auth.py index 486cd72..8f8349d 100644 --- a/ruoyi-fastapi-backend/module_admin/aspect/interface_auth.py +++ b/ruoyi-fastapi-backend/module_admin/aspect/interface_auth.py @@ -8,11 +8,15 @@ from module_admin.service.login_service import LoginService class CheckUserInterfaceAuth: """ 校验当前用户是否具有相应的接口权限 - :param perm: 权限标识 - :param is_strict: 当传入的权限标识是list类型时，是否开启严格模式，开启表示会校验列表中的每一个权限标识，所有的校验结果都需要为True才会通过 """ def __init__(self, perm: Union[str, List], is_strict: bool = False): + """ + 校验当前用户是否具有相应的接口权限 + + :param perm: 权限标识 + :param is_strict: 当传入的权限标识是list类型时，是否开启严格模式，开启表示会校验列表中的每一个权限标识，所有的校验结果都需要为True才会通过 + """ self.perm = perm self.is_strict = is_strict @@ -36,11 +40,15 @@ class CheckUserInterfaceAuth: class CheckRoleInterfaceAuth: """ 根据角色校验当前用户是否具有相应的接口权限 - :param role_key: 角色标识 - :param is_strict: 当传入的角色标识是list类型时，是否开启严格模式，开启表示会校验列表中的每一个角色标识，所有的校验结果都需要为True才会通过 """ def __init__(self, role_key: Union[str, List], is_strict: bool = False): + """ + 根据角色校验当前用户是否具有相应的接口权限 + + :param role_key: 角色标识 + :param is_strict: 当传入的角色标识是list类型时，是否开启严格模式，开启表示会校验列表中的每一个角色标识，所有的校验结果都需要为True才会通过 + """ self.role_key = role_key self.is_strict = is_strict diff --git a/ruoyi-fastapi-backend/module_admin/dao/config_dao.py b/ruoyi-fastapi-backend/module_admin/dao/config_dao.py index df3e3f4..7b3c067 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/config_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/config_dao.py @@ -15,6 +15,7 @@ class ConfigDao: async def get_config_detail_by_id(cls, db: AsyncSession, config_id: int): """ 根据参数配置id获取参数配置详细信息 + :param db: orm对象 :param config_id: 参数配置id :return: 参数配置信息对象 @@ -27,6 +28,7 @@ class ConfigDao: async def get_config_detail_by_info(cls, db: AsyncSession, config: ConfigModel): """ 根据参数配置参数获取参数配置信息 + :param db: orm对象 :param config: 参数配置参数对象 :return: 参数配置信息对象 @@ -50,6 +52,7 @@ class ConfigDao: async def get_config_list(cls, db: AsyncSession, query_object: ConfigPageQueryModel, is_page: bool = False): """ 根据查询参数获取参数配置列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -78,6 +81,7 @@ class ConfigDao: async def add_config_dao(cls, db: AsyncSession, config: ConfigModel): """ 新增参数配置数据库操作 + :param db: orm对象 :param config: 参数配置对象 :return: @@ -92,6 +96,7 @@ class ConfigDao: async def edit_config_dao(cls, db: AsyncSession, config: dict): """ 编辑参数配置数据库操作 + :param db: orm对象 :param config: 需要更新的参数配置字典 :return: @@ -102,6 +107,7 @@ class ConfigDao: async def delete_config_dao(cls, db: AsyncSession, config: ConfigModel): """ 删除参数配置数据库操作 + :param db: orm对象 :param config: 参数配置对象 :return: diff --git a/ruoyi-fastapi-backend/module_admin/dao/dept_dao.py b/ruoyi-fastapi-backend/module_admin/dao/dept_dao.py index cfd7c2e..8a4d64d 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/dept_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/dept_dao.py @@ -17,6 +17,7 @@ class DeptDao: async def get_dept_by_id(cls, db: AsyncSession, dept_id: int): """ 根据部门id获取在用部门信息 + :param db: orm对象 :param dept_id: 部门id :return: 在用部门信息对象 @@ -29,6 +30,7 @@ class DeptDao: async def get_dept_detail_by_id(cls, db: AsyncSession, dept_id: int): """ 根据部门id获取部门详细信息 + :param db: orm对象 :param dept_id: 部门id :return: 部门信息对象 @@ -45,6 +47,7 @@ class DeptDao: async def get_dept_detail_by_info(cls, db: AsyncSession, dept: DeptModel): """ 根据部门参数获取部门信息 + :param db: orm对象 :param dept: 部门参数对象 :return: 部门信息对象 @@ -68,6 +71,7 @@ class DeptDao: async def get_dept_info_for_edit_option(cls, db: AsyncSession, dept_info: DeptModel, data_scope_sql: str): """ 获取部门编辑对应的在用部门列表信息 + :param db: orm对象 :param dept_info: 部门对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -100,6 +104,7 @@ class DeptDao: async def get_children_dept_dao(cls, db: AsyncSession, dept_id: int): """ 根据部门id查询当前部门的子部门列表信息 + :param db: orm对象 :param dept_id: 部门id :return: 子部门信息列表 @@ -114,6 +119,7 @@ class DeptDao: async def get_dept_list_for_tree(cls, db: AsyncSession, dept_info: DeptModel, data_scope_sql: str): """ 获取所有在用部门列表信息 + :param db: orm对象 :param dept_info: 部门对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -143,6 +149,7 @@ class DeptDao: async def get_dept_list(cls, db: AsyncSession, page_object: DeptModel, data_scope_sql: str): """ 根据查询参数获取部门列表信息 + :param db: orm对象 :param page_object: 不分页查询参数对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -172,6 +179,7 @@ class DeptDao: async def add_dept_dao(cls, db: AsyncSession, dept: DeptModel): """ 新增部门数据库操作 + :param db: orm对象 :param dept: 部门对象 :return: 新增校验结果 @@ -186,6 +194,7 @@ class DeptDao: async def edit_dept_dao(cls, db: AsyncSession, dept: dict): """ 编辑部门数据库操作 + :param db: orm对象 :param dept: 需要更新的部门字典 :return: 编辑校验结果 @@ -196,6 +205,7 @@ class DeptDao: async def update_dept_children_dao(cls, db: AsyncSession, update_dept: List): """ 更新子部门信息 + :param db: orm对象 :param update_dept: 需要更新的部门列表 :return: @@ -217,6 +227,7 @@ class DeptDao: async def update_dept_status_normal_dao(cls, db: AsyncSession, dept_id_list: List): """ 批量更新部门状态为正常 + :param db: orm对象 :param dept_id_list: 部门id列表 :return: @@ -227,6 +238,7 @@ class DeptDao: async def delete_dept_dao(cls, db: AsyncSession, dept: DeptModel): """ 删除部门数据库操作 + :param db: orm对象 :param dept: 部门对象 :return: @@ -241,6 +253,7 @@ class DeptDao: async def count_normal_children_dept_dao(cls, db: AsyncSession, dept_id: int): """ 根据部门id查询查询所有子部门（正常状态）的数量 + :param db: orm对象 :param dept_id: 部门id :return: 所有子部门（正常状态）的数量 @@ -259,6 +272,7 @@ class DeptDao: async def count_children_dept_dao(cls, db: AsyncSession, dept_id: int): """ 根据部门id查询查询所有子部门（所有状态）的数量 + :param db: orm对象 :param dept_id: 部门id :return: 所有子部门（所有状态）的数量 @@ -278,6 +292,7 @@ class DeptDao: async def count_dept_user_dao(cls, db: AsyncSession, dept_id: int): """ 根据部门id查询查询部门下的用户数量 + :param db: orm对象 :param dept_id: 部门id :return: 部门下的用户数量 diff --git a/ruoyi-fastapi-backend/module_admin/dao/dict_dao.py b/ruoyi-fastapi-backend/module_admin/dao/dict_dao.py index 2c4460c..8f4aab2 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/dict_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/dict_dao.py @@ -16,6 +16,7 @@ class DictTypeDao: async def get_dict_type_detail_by_id(cls, db: AsyncSession, dict_id: int): """ 根据字典类型id获取字典类型详细信息 + :param db: orm对象 :param dict_id: 字典类型id :return: 字典类型信息对象 @@ -28,6 +29,7 @@ class DictTypeDao: async def get_dict_type_detail_by_info(cls, db: AsyncSession, dict_type: DictTypeModel): """ 根据字典类型参数获取字典类型信息 + :param db: orm对象 :param dict_type: 字典类型参数对象 :return: 字典类型信息对象 @@ -51,6 +53,7 @@ class DictTypeDao: async def get_all_dict_type(cls, db: AsyncSession): """ 获取所有的字典类型信息 + :param db: orm对象 :return: 字典类型信息列表对象 """ @@ -62,6 +65,7 @@ class DictTypeDao: async def get_dict_type_list(cls, db: AsyncSession, query_object: DictTypePageQueryModel, is_page: bool = False): """ 根据查询参数获取字典类型列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -90,6 +94,7 @@ class DictTypeDao: async def add_dict_type_dao(cls, db: AsyncSession, dict_type: DictTypeModel): """ 新增字典类型数据库操作 + :param db: orm对象 :param dict_type: 字典类型对象 :return: @@ -104,6 +109,7 @@ class DictTypeDao: async def edit_dict_type_dao(cls, db: AsyncSession, dict_type: dict): """ 编辑字典类型数据库操作 + :param db: orm对象 :param dict_type: 需要更新的字典类型字典 :return: @@ -114,6 +120,7 @@ class DictTypeDao: async def delete_dict_type_dao(cls, db: AsyncSession, dict_type: DictTypeModel): """ 删除字典类型数据库操作 + :param db: orm对象 :param dict_type: 字典类型对象 :return: @@ -130,6 +137,7 @@ class DictDataDao: async def get_dict_data_detail_by_id(cls, db: AsyncSession, dict_code: int): """ 根据字典数据id获取字典数据详细信息 + :param db: orm对象 :param dict_code: 字典数据id :return: 字典数据信息对象 @@ -144,6 +152,7 @@ class DictDataDao: async def get_dict_data_detail_by_info(cls, db: AsyncSession, dict_data: DictDataModel): """ 根据字典数据参数获取字典数据信息 + :param db: orm对象 :param dict_data: 字典数据参数对象 :return: 字典数据信息对象 @@ -168,6 +177,7 @@ class DictDataDao: async def get_dict_data_list(cls, db: AsyncSession, query_object: DictDataPageQueryModel, is_page: bool = False): """ 根据查询参数获取字典数据列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -191,6 +201,7 @@ class DictDataDao: async def query_dict_data_list(cls, db: AsyncSession, dict_type: str): """ 根据查询参数获取字典数据列表信息 + :param db: orm对象 :param dict_type: 字典类型 :return: 字典数据列表信息对象 @@ -220,6 +231,7 @@ class DictDataDao: async def add_dict_data_dao(cls, db: AsyncSession, dict_data: DictDataModel): """ 新增字典数据数据库操作 + :param db: orm对象 :param dict_data: 字典数据对象 :return: @@ -234,6 +246,7 @@ class DictDataDao: async def edit_dict_data_dao(cls, db: AsyncSession, dict_data: dict): """ 编辑字典数据数据库操作 + :param db: orm对象 :param dict_data: 需要更新的字典数据字典 :return: @@ -244,6 +257,7 @@ class DictDataDao: async def delete_dict_data_dao(cls, db: AsyncSession, dict_data: DictDataModel): """ 删除字典数据数据库操作 + :param db: orm对象 :param dict_data: 字典数据对象 :return: @@ -254,6 +268,7 @@ class DictDataDao: async def count_dict_data_dao(cls, db: AsyncSession, dict_type: str): """ 根据字典类型查询字典类型关联的字典数据数量 + :param db: orm对象 :param dict_type: 字典类型 :return: 字典类型关联的字典数据数量 diff --git a/ruoyi-fastapi-backend/module_admin/dao/job_dao.py b/ruoyi-fastapi-backend/module_admin/dao/job_dao.py index 4c984f8..c2488c1 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/job_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/job_dao.py @@ -14,6 +14,7 @@ class JobDao: async def get_job_detail_by_id(cls, db: AsyncSession, job_id: int): """ 根据定时任务id获取定时任务详细信息 + :param db: orm对象 :param job_id: 定时任务id :return: 定时任务信息对象 @@ -26,6 +27,7 @@ class JobDao: async def get_job_detail_by_info(cls, db: AsyncSession, job: JobModel): """ 根据定时任务参数获取定时任务信息 + :param db: orm对象 :param job: 定时任务参数对象 :return: 定时任务信息对象 @@ -51,6 +53,7 @@ class JobDao: async def get_job_list(cls, db: AsyncSession, query_object: JobPageQueryModel, is_page: bool = False): """ 根据查询参数获取定时任务列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -73,6 +76,7 @@ class JobDao: async def get_job_list_for_scheduler(cls, db: AsyncSession): """ 获取定时任务列表信息 + :param db: orm对象 :return: 定时任务列表信息对象 """ @@ -84,6 +88,7 @@ class JobDao: async def add_job_dao(cls, db: AsyncSession, job: JobModel): """ 新增定时任务数据库操作 + :param db: orm对象 :param job: 定时任务对象 :return: @@ -98,6 +103,7 @@ class JobDao: async def edit_job_dao(cls, db: AsyncSession, job: dict): """ 编辑定时任务数据库操作 + :param db: orm对象 :param job: 需要更新的定时任务字典 :return: @@ -108,6 +114,7 @@ class JobDao: async def delete_job_dao(cls, db: AsyncSession, job: JobModel): """ 删除定时任务数据库操作 + :param db: orm对象 :param job: 定时任务对象 :return: diff --git a/ruoyi-fastapi-backend/module_admin/dao/job_log_dao.py b/ruoyi-fastapi-backend/module_admin/dao/job_log_dao.py index 6d64a91..730be5a 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/job_log_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/job_log_dao.py @@ -16,6 +16,7 @@ class JobLogDao: async def get_job_log_list(cls, db: AsyncSession, query_object: JobLogPageQueryModel, is_page: bool = False): """ 根据查询参数获取定时任务日志列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -44,6 +45,7 @@ class JobLogDao: def add_job_log_dao(cls, db: Session, job_log: JobLogModel): """ 新增定时任务日志数据库操作 + :param db: orm对象 :param job_log: 定时任务日志对象 :return: @@ -58,6 +60,7 @@ class JobLogDao: async def delete_job_log_dao(cls, db: AsyncSession, job_log: JobLogModel): """ 删除定时任务日志数据库操作 + :param db: orm对象 :param job_log: 定时任务日志对象 :return: @@ -68,6 +71,7 @@ class JobLogDao: async def clear_job_log_dao(cls, db: AsyncSession): """ 清除定时任务日志数据库操作 + :param db: orm对象 :return: """ diff --git a/ruoyi-fastapi-backend/module_admin/dao/log_dao.py b/ruoyi-fastapi-backend/module_admin/dao/log_dao.py index 547aca9..1e4ad41 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/log_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/log_dao.py @@ -16,6 +16,7 @@ class OperationLogDao: async def get_operation_log_list(cls, db: AsyncSession, query_object: OperLogPageQueryModel, is_page: bool = False): """ 根据查询参数获取操作日志列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -54,6 +55,7 @@ class OperationLogDao: async def add_operation_log_dao(cls, db: AsyncSession, operation_log: OperLogModel): """ 新增操作日志数据库操作 + :param db: orm对象 :param operation_log: 操作日志对象 :return: 新增校验结果 @@ -68,6 +70,7 @@ class OperationLogDao: async def delete_operation_log_dao(cls, db: AsyncSession, operation_log: OperLogModel): """ 删除操作日志数据库操作 + :param db: orm对象 :param operation_log: 操作日志对象 :return: @@ -78,6 +81,7 @@ class OperationLogDao: async def clear_operation_log_dao(cls, db: AsyncSession): """ 清除操作日志数据库操作 + :param db: orm对象 :return: """ @@ -93,6 +97,7 @@ class LoginLogDao: async def get_login_log_list(cls, db: AsyncSession, query_object: LoginLogPageQueryModel, is_page: bool = False): """ 根据查询参数获取登录日志列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -132,6 +137,7 @@ class LoginLogDao: async def add_login_log_dao(cls, db: AsyncSession, login_log: LogininforModel): """ 新增登录日志数据库操作 + :param db: orm对象 :param login_log: 登录日志对象 :return: 新增校验结果 @@ -146,6 +152,7 @@ class LoginLogDao: async def delete_login_log_dao(cls, db: AsyncSession, login_log: LogininforModel): """ 删除登录日志数据库操作 + :param db: orm对象 :param login_log: 登录日志对象 :return: @@ -156,6 +163,7 @@ class LoginLogDao: async def clear_login_log_dao(cls, db: AsyncSession): """ 清除登录日志数据库操作 + :param db: orm对象 :return: """ diff --git a/ruoyi-fastapi-backend/module_admin/dao/login_dao.py b/ruoyi-fastapi-backend/module_admin/dao/login_dao.py index 9bafa65..9764a4a 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/login_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/login_dao.py @@ -7,6 +7,7 @@ from module_admin.entity.do.user_do import SysUser async def login_by_account(db: AsyncSession, user_name: str): """ 根据用户名查询用户信息 + :param db: orm对象 :param user_name: 用户名 :return: 用户对象 diff --git a/ruoyi-fastapi-backend/module_admin/dao/menu_dao.py b/ruoyi-fastapi-backend/module_admin/dao/menu_dao.py index 223b84e..19831e0 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/menu_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/menu_dao.py @@ -15,6 +15,7 @@ class MenuDao: async def get_menu_detail_by_id(cls, db: AsyncSession, menu_id: int): """ 根据菜单id获取菜单详细信息 + :param db: orm对象 :param menu_id: 菜单id :return: 菜单信息对象 @@ -27,6 +28,7 @@ class MenuDao: async def get_menu_detail_by_info(cls, db: AsyncSession, menu: MenuModel): """ 根据菜单参数获取菜单信息 + :param db: orm对象 :param menu: 菜单参数对象 :return: 菜单信息对象 @@ -51,6 +53,7 @@ class MenuDao: async def get_menu_list_for_tree(cls, db: AsyncSession, user_id: int, role: list): """ 根据角色信息获取所有在用菜单列表信息 + :param db: orm对象 :param user_id: 用户id :param role: 用户角色列表信息 @@ -94,6 +97,7 @@ class MenuDao: async def get_menu_list(cls, db: AsyncSession, page_object: MenuQueryModel, user_id: int, role: list): """ 根据查询参数获取菜单列表信息 + :param db: orm对象 :param page_object: 不分页查询参数对象 :param user_id: 用户id @@ -155,6 +159,7 @@ class MenuDao: async def add_menu_dao(cls, db: AsyncSession, menu: MenuModel): """ 新增菜单数据库操作 + :param db: orm对象 :param menu: 菜单对象 :return: @@ -169,6 +174,7 @@ class MenuDao: async def edit_menu_dao(cls, db: AsyncSession, menu: dict): """ 编辑菜单数据库操作 + :param db: orm对象 :param menu: 需要更新的菜单字典 :return: @@ -179,6 +185,7 @@ class MenuDao: async def delete_menu_dao(cls, db: AsyncSession, menu: MenuModel): """ 删除菜单数据库操作 + :param db: orm对象 :param menu: 菜单对象 :return: @@ -189,6 +196,7 @@ class MenuDao: async def has_child_by_menu_id_dao(cls, db: AsyncSession, menu_id: int): """ 根据菜单id查询菜单关联子菜单的数量 + :param db: orm对象 :param menu_id: 菜单id :return: 菜单关联子菜单的数量 @@ -203,6 +211,7 @@ class MenuDao: async def check_menu_exist_role_dao(cls, db: AsyncSession, menu_id: int): """ 根据菜单id查询菜单关联角色数量 + :param db: orm对象 :param menu_id: 菜单id :return: 菜单关联角色数量 diff --git a/ruoyi-fastapi-backend/module_admin/dao/notice_dao.py b/ruoyi-fastapi-backend/module_admin/dao/notice_dao.py index 534c26c..961a992 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/notice_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/notice_dao.py @@ -15,6 +15,7 @@ class NoticeDao: async def get_notice_detail_by_id(cls, db: AsyncSession, notice_id: int): """ 根据通知公告id获取通知公告详细信息 + :param db: orm对象 :param notice_id: 通知公告id :return: 通知公告信息对象 @@ -27,6 +28,7 @@ class NoticeDao: async def get_notice_detail_by_info(cls, db: AsyncSession, notice: NoticeModel): """ 根据通知公告参数获取通知公告信息 + :param db: orm对象 :param notice: 通知公告参数对象 :return: 通知公告信息对象 @@ -51,6 +53,7 @@ class NoticeDao: async def get_notice_list(cls, db: AsyncSession, query_object: NoticePageQueryModel, is_page: bool = False): """ 根据查询参数获取通知公告列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -79,6 +82,7 @@ class NoticeDao: async def add_notice_dao(cls, db: AsyncSession, notice: NoticeModel): """ 新增通知公告数据库操作 + :param db: orm对象 :param notice: 通知公告对象 :return: @@ -93,6 +97,7 @@ class NoticeDao: async def edit_notice_dao(cls, db: AsyncSession, notice: dict): """ 编辑通知公告数据库操作 + :param db: orm对象 :param notice: 需要更新的通知公告字典 :return: @@ -103,6 +108,7 @@ class NoticeDao: async def delete_notice_dao(cls, db: AsyncSession, notice: NoticeModel): """ 删除通知公告数据库操作 + :param db: orm对象 :param notice: 通知公告对象 :return: diff --git a/ruoyi-fastapi-backend/module_admin/dao/post_dao.py b/ruoyi-fastapi-backend/module_admin/dao/post_dao.py index 4805306..7d90088 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/post_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/post_dao.py @@ -15,6 +15,7 @@ class PostDao: async def get_post_by_id(cls, db: AsyncSession, post_id: int): """ 根据岗位id获取在用岗位详细信息 + :param db: orm对象 :param post_id: 岗位id :return: 在用岗位信息对象 @@ -31,6 +32,7 @@ class PostDao: async def get_post_detail_by_id(cls, db: AsyncSession, post_id: int): """ 根据岗位id获取岗位详细信息 + :param db: orm对象 :param post_id: 岗位id :return: 岗位信息对象 @@ -43,6 +45,7 @@ class PostDao: async def get_post_detail_by_info(cls, db: AsyncSession, post: PostModel): """ 根据岗位参数获取岗位信息 + :param db: orm对象 :param post: 岗位参数对象 :return: 岗位信息对象 @@ -67,6 +70,7 @@ class PostDao: async def get_post_list(cls, db: AsyncSession, query_object: PostPageQueryModel, is_page: bool = False): """ 根据查询参数获取岗位列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -90,6 +94,7 @@ class PostDao: async def add_post_dao(cls, db: AsyncSession, post: PostModel): """ 新增岗位数据库操作 + :param db: orm对象 :param post: 岗位对象 :return: @@ -104,6 +109,7 @@ class PostDao: async def edit_post_dao(cls, db: AsyncSession, post: dict): """ 编辑岗位数据库操作 + :param db: orm对象 :param post: 需要更新的岗位字典 :return: @@ -114,6 +120,7 @@ class PostDao: async def delete_post_dao(cls, db: AsyncSession, post: PostModel): """ 删除岗位数据库操作 + :param db: orm对象 :param post: 岗位对象 :return: @@ -124,6 +131,7 @@ class PostDao: async def count_user_post_dao(cls, db: AsyncSession, post_id: int): """ 根据岗位id查询岗位关联的用户数量 + :param db: orm对象 :param post_id: 岗位id :return: 岗位关联的用户数量 diff --git a/ruoyi-fastapi-backend/module_admin/dao/role_dao.py b/ruoyi-fastapi-backend/module_admin/dao/role_dao.py index 30352e8..6c6bb43 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/role_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/role_dao.py @@ -18,6 +18,7 @@ class RoleDao: async def get_role_by_name(cls, db: AsyncSession, role_name: str): """ 根据角色名获取在用角色信息 + :param db: orm对象 :param role_name: 角色名 :return: 当前角色名的角色信息对象 @@ -41,6 +42,7 @@ class RoleDao: async def get_role_by_info(cls, db: AsyncSession, role: RoleModel): """ 根据角色参数获取角色信息 + :param db: orm对象 :param role: 角色参数 :return: 当前角色参数的角色信息对象 @@ -68,6 +70,7 @@ class RoleDao: async def get_role_by_id(cls, db: AsyncSession, role_id: int): """ 根据角色id获取在用角色信息 + :param db: orm对象 :param role_id: 角色id :return: 当前角色id的角色信息对象 @@ -88,6 +91,7 @@ class RoleDao: 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的角色信息对象 @@ -104,6 +108,7 @@ class RoleDao: async def get_role_select_option_dao(cls, db: AsyncSession): """ 获取编辑页面对应的在用角色列表信息 + :param db: orm对象 :return: 角色列表信息 """ @@ -125,6 +130,7 @@ class RoleDao: ): """ 根据查询参数获取角色列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -160,6 +166,7 @@ class RoleDao: async def add_role_dao(cls, db: AsyncSession, role: RoleModel): """ 新增角色数据库操作 + :param db: orm对象 :param role: 角色对象 :return: @@ -174,6 +181,7 @@ class RoleDao: async def edit_role_dao(cls, db: AsyncSession, role: dict): """ 编辑角色数据库操作 + :param db: orm对象 :param role: 需要更新的角色字典 :return: @@ -184,6 +192,7 @@ class RoleDao: async def delete_role_dao(cls, db: AsyncSession, role: RoleModel): """ 删除角色数据库操作 + :param db: orm对象 :param role: 角色对象 :return: @@ -198,6 +207,7 @@ class RoleDao: async def get_role_menu_dao(cls, db: AsyncSession, role: RoleModel): """ 根据角色id获取角色菜单关联列表信息 + :param db: orm对象 :param role: 角色对象 :return: 角色菜单关联列表信息 @@ -233,6 +243,7 @@ class RoleDao: async def add_role_menu_dao(cls, db: AsyncSession, role_menu: RoleMenuModel): """ 新增角色菜单关联信息数据库操作 + :param db: orm对象 :param role_menu: 用户角色菜单关联对象 :return: @@ -244,6 +255,7 @@ class RoleDao: async def delete_role_menu_dao(cls, db: AsyncSession, role_menu: RoleMenuModel): """ 删除角色菜单关联信息数据库操作 + :param db: orm对象 :param role_menu: 角色菜单关联对象 :return: @@ -254,6 +266,7 @@ class RoleDao: async def get_role_dept_dao(cls, db: AsyncSession, role: RoleModel): """ 根据角色id获取角色部门关联列表信息 + :param db: orm对象 :param role: 角色对象 :return: 角色部门关联列表信息 @@ -289,6 +302,7 @@ class RoleDao: async def add_role_dept_dao(cls, db: AsyncSession, role_dept: RoleDeptModel): """ 新增角色部门关联信息数据库操作 + :param db: orm对象 :param role_dept: 用户角色部门关联对象 :return: @@ -300,6 +314,7 @@ class RoleDao: async def delete_role_dept_dao(cls, db: AsyncSession, role_dept: RoleDeptModel): """ 删除角色部门关联信息数据库操作 + :param db: orm对象 :param role_dept: 角色部门关联对象 :return: @@ -310,6 +325,7 @@ class RoleDao: async def count_user_role_dao(cls, db: AsyncSession, role_id: int): """ 根据角色id查询角色关联用户数量 + :param db: orm对象 :param role_id: 角色id :return: 角色关联用户数量 diff --git a/ruoyi-fastapi-backend/module_admin/dao/user_dao.py b/ruoyi-fastapi-backend/module_admin/dao/user_dao.py index 05e47bc..e32656c 100644 --- a/ruoyi-fastapi-backend/module_admin/dao/user_dao.py +++ b/ruoyi-fastapi-backend/module_admin/dao/user_dao.py @@ -26,6 +26,7 @@ class UserDao: async def get_user_by_name(cls, db: AsyncSession, user_name: str): """ 根据用户名获取用户信息 + :param db: orm对象 :param user_name: 用户名 :return: 当前用户名的用户信息对象 @@ -49,6 +50,7 @@ class UserDao: async def get_user_by_info(cls, db: AsyncSession, user: UserModel): """ 根据用户参数获取用户信息 + :param db: orm对象 :param user: 用户参数 :return: 当前用户参数的用户信息对象 @@ -77,6 +79,7 @@ class UserDao: async def get_user_by_id(cls, db: AsyncSession, user_id: int): """ 根据user_id获取用户信息 + :param db: orm对象 :param user_id: 用户id :return: 当前user_id的用户信息对象 @@ -183,6 +186,7 @@ class UserDao: async def get_user_detail_by_id(cls, db: AsyncSession, user_id: int): """ 根据user_id获取用户详细信息 + :param db: orm对象 :param user_id: 用户id :return: 当前user_id的用户信息对象 @@ -275,6 +279,7 @@ class UserDao: ): """ 根据查询参数获取用户列表信息 + :param db: orm对象 :param query_object: 查询参数对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -323,6 +328,7 @@ class UserDao: async def add_user_dao(cls, db: AsyncSession, user: UserModel): """ 新增用户数据库操作 + :param db: orm对象 :param user: 用户对象 :return: 新增校验结果 @@ -337,6 +343,7 @@ class UserDao: async def edit_user_dao(cls, db: AsyncSession, user: dict): """ 编辑用户数据库操作 + :param db: orm对象 :param user: 需要更新的用户字典 :return: 编辑校验结果 @@ -347,6 +354,7 @@ class UserDao: async def delete_user_dao(cls, db: AsyncSession, user: UserModel): """ 删除用户数据库操作 + :param db: orm对象 :param user: 用户对象 :return: @@ -361,6 +369,7 @@ class UserDao: async def get_user_role_allocated_list_by_user_id(cls, db: AsyncSession, query_object: UserRoleQueryModel): """ 根据用户id获取用户已分配的角色列表信息数据库操作 + :param db: orm对象 :param query_object: 用户角色查询对象 :return: 用户已分配的角色列表信息 @@ -393,6 +402,7 @@ class UserDao: ): """ 根据角色id获取已分配的用户列表信息 + :param db: orm对象 :param query_object: 用户角色查询对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -423,6 +433,7 @@ class UserDao: ): """ 根据角色id获取未分配的用户列表信息 + :param db: orm对象 :param query_object: 用户角色查询对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -461,6 +472,7 @@ class UserDao: async def add_user_role_dao(cls, db: AsyncSession, user_role: UserRoleModel): """ 新增用户角色关联信息数据库操作 + :param db: orm对象 :param user_role: 用户角色关联对象 :return: @@ -472,6 +484,7 @@ class UserDao: async def delete_user_role_dao(cls, db: AsyncSession, user_role: UserRoleModel): """ 删除用户角色关联信息数据库操作 + :param db: orm对象 :param user_role: 用户角色关联对象 :return: @@ -482,6 +495,7 @@ class UserDao: async def delete_user_role_by_user_and_role_dao(cls, db: AsyncSession, user_role: UserRoleModel): """ 根据用户id及角色id删除用户角色关联信息数据库操作 + :param db: orm对象 :param user_role: 用户角色关联对象 :return: @@ -497,6 +511,7 @@ class UserDao: async def get_user_role_detail(cls, db: AsyncSession, user_role: UserRoleModel): """ 根据用户角色关联获取用户角色关联详细信息 + :param db: orm对象 :param user_role: 用户角色关联对象 :return: 用户角色关联信息 @@ -519,6 +534,7 @@ class UserDao: async def add_user_post_dao(cls, db: AsyncSession, user_post: UserPostModel): """ 新增用户岗位关联信息数据库操作 + :param db: orm对象 :param user_post: 用户岗位关联对象 :return: @@ -530,6 +546,7 @@ class UserDao: async def delete_user_post_dao(cls, db: AsyncSession, user_post: UserPostModel): """ 删除用户岗位关联信息数据库操作 + :param db: orm对象 :param user_post: 用户岗位关联对象 :return: diff --git a/ruoyi-fastapi-backend/module_admin/service/cache_service.py b/ruoyi-fastapi-backend/module_admin/service/cache_service.py index d134b68..49f4fe7 100644 --- a/ruoyi-fastapi-backend/module_admin/service/cache_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/cache_service.py @@ -14,6 +14,7 @@ class CacheService: async def get_cache_monitor_statistical_info_services(cls, request: Request): """ 获取缓存监控信息service + :param request: Request对象 :return: 缓存监控信息 """ @@ -31,6 +32,7 @@ class CacheService: async def get_cache_monitor_cache_name_services(cls): """ 获取缓存名称列表信息service + :return: 缓存名称列表信息 """ name_list = [] @@ -51,6 +53,7 @@ class CacheService: async def get_cache_monitor_cache_key_services(cls, request: Request, cache_name: str): """ 获取缓存键名列表信息service + :param request: Request对象 :param cache_name: 缓存名称 :return: 缓存键名列表信息 @@ -64,6 +67,7 @@ class CacheService: async def get_cache_monitor_cache_value_services(cls, request: Request, cache_name: str, cache_key: str): """ 获取缓存内容信息service + :param request: Request对象 :param cache_name: 缓存名称 :param cache_key: 缓存键名 @@ -77,6 +81,7 @@ class CacheService: async def clear_cache_monitor_cache_name_services(cls, request: Request, cache_name: str): """ 清除缓存名称对应所有键值service + :param request: Request对象 :param cache_name: 缓存名称 :return: 操作缓存响应信息 @@ -91,6 +96,7 @@ class CacheService: async def clear_cache_monitor_cache_key_services(cls, request: Request, cache_key: str): """ 清除缓存名称对应所有键值service + :param request: Request对象 :param cache_key: 缓存键名 :return: 操作缓存响应信息 @@ -105,6 +111,7 @@ class CacheService: async def clear_cache_monitor_all_services(cls, request: Request): """ 清除所有缓存service + :param request: Request对象 :return: 操作缓存响应信息 """ diff --git a/ruoyi-fastapi-backend/module_admin/service/common_service.py b/ruoyi-fastapi-backend/module_admin/service/common_service.py index bea97c2..20eb868 100644 --- a/ruoyi-fastapi-backend/module_admin/service/common_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/common_service.py @@ -16,6 +16,7 @@ class CommonService: async def upload_service(cls, request: Request, file: UploadFile): """ 通用上传service + :param request: Request对象 :param file: 上传文件对象 :return: 上传结果 @@ -51,6 +52,7 @@ class CommonService: async def download_services(cls, background_tasks: BackgroundTasks, file_name, delete: bool): """ 下载下载目录文件service + :param background_tasks: 后台任务对象 :param file_name: 下载的文件名称 :param delete: 是否在下载完成后删除文件 @@ -70,6 +72,7 @@ class CommonService: async def download_resource_services(cls, resource: str): """ 下载上传目录文件service + :param resource: 下载的文件名称 :return: 上传结果 """ diff --git a/ruoyi-fastapi-backend/module_admin/service/config_service.py b/ruoyi-fastapi-backend/module_admin/service/config_service.py index 8d3b9e6..d463979 100644 --- a/ruoyi-fastapi-backend/module_admin/service/config_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/config_service.py @@ -21,6 +21,7 @@ class ConfigService: ): """ 获取参数配置列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -34,6 +35,7 @@ class ConfigService: async def init_cache_sys_config_services(cls, query_db: AsyncSession, redis): """ 应用初始化：获取所有参数配置对应的键值对信息并缓存service + :param query_db: orm对象 :param redis: redis对象 :return: @@ -54,6 +56,7 @@ class ConfigService: async def query_config_list_from_cache_services(cls, redis, config_key: str): """ 从缓存获取参数键名对应值service + :param redis: redis对象 :param config_key: 参数键名 :return: 参数键名对应值 @@ -66,6 +69,7 @@ class ConfigService: async def check_config_key_unique_services(cls, query_db: AsyncSession, page_object: ConfigModel): """ 校验参数键名是否唯一service + :param query_db: orm对象 :param page_object: 参数配置对象 :return: 校验结果 @@ -80,6 +84,7 @@ class ConfigService: async def add_config_services(cls, request: Request, query_db: AsyncSession, page_object: ConfigModel): """ 新增参数配置信息service + :param request: Request对象 :param query_db: orm对象 :param page_object: 新增参数配置对象 @@ -103,6 +108,7 @@ class ConfigService: async def edit_config_services(cls, request: Request, query_db: AsyncSession, page_object: ConfigModel): """ 编辑参数配置信息service + :param request: Request对象 :param query_db: orm对象 :param page_object: 编辑参数配置对象 @@ -135,6 +141,7 @@ class ConfigService: async def delete_config_services(cls, request: Request, query_db: AsyncSession, page_object: DeleteConfigModel): """ 删除参数配置信息service + :param request: Request对象 :param query_db: orm对象 :param page_object: 删除参数配置对象 @@ -167,6 +174,7 @@ class ConfigService: async def config_detail_services(cls, query_db: AsyncSession, config_id: int): """ 获取参数配置详细信息service + :param query_db: orm对象 :param config_id: 参数配置id :return: 参数配置id对应的信息 @@ -183,6 +191,7 @@ class ConfigService: async def export_config_list_services(config_list: List): """ 导出参数配置信息service + :param config_list: 参数配置信息列表 :return: 参数配置信息对应excel的二进制数据 """ @@ -218,6 +227,7 @@ class ConfigService: async def refresh_sys_config_services(cls, request: Request, query_db: AsyncSession): """ 刷新字典缓存信息service + :param request: Request对象 :param query_db: orm对象 :return: 刷新字典缓存校验结果 diff --git a/ruoyi-fastapi-backend/module_admin/service/dept_service.py b/ruoyi-fastapi-backend/module_admin/service/dept_service.py index 3fe5208..e7ba1dc 100644 --- a/ruoyi-fastapi-backend/module_admin/service/dept_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/dept_service.py @@ -16,6 +16,7 @@ class DeptService: async def get_dept_tree_services(cls, query_db: AsyncSession, page_object: DeptModel, data_scope_sql: str): """ 获取部门树信息service + :param query_db: orm对象 :param page_object: 查询参数对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -32,6 +33,7 @@ class DeptService: ): """ 获取部门编辑部门树信息service + :param query_db: orm对象 :param page_object: 查询参数对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -45,6 +47,7 @@ class DeptService: async def get_dept_list_services(cls, query_db: AsyncSession, page_object: DeptModel, data_scope_sql: str): """ 获取部门列表信息service + :param query_db: orm对象 :param page_object: 分页查询参数对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -58,6 +61,7 @@ class DeptService: async def check_dept_data_scope_services(cls, query_db: AsyncSession, dept_id: int, data_scope_sql: str): """ 校验部门是否有数据权限service + :param query_db: orm对象 :param dept_id: 部门id :param data_scope_sql: 数据权限对应的查询sql语句 @@ -73,6 +77,7 @@ class DeptService: async def check_dept_name_unique_services(cls, query_db: AsyncSession, page_object: DeptModel): """ 校验部门名称是否唯一service + :param query_db: orm对象 :param page_object: 部门对象 :return: 校验结果 @@ -89,6 +94,7 @@ class DeptService: async def add_dept_services(cls, query_db: AsyncSession, page_object: DeptModel): """ 新增部门信息service + :param query_db: orm对象 :param page_object: 新增部门对象 :return: 新增部门校验结果 @@ -111,6 +117,7 @@ class DeptService: async def edit_dept_services(cls, query_db: AsyncSession, page_object: DeptModel): """ 编辑部门信息service + :param query_db: orm对象 :param page_object: 编辑部门对象 :return: 编辑部门校验结果 @@ -150,6 +157,7 @@ class DeptService: async def delete_dept_services(cls, query_db: AsyncSession, page_object: DeleteDeptModel): """ 删除部门信息service + :param query_db: orm对象 :param page_object: 删除部门对象 :return: 删除部门校验结果 @@ -176,6 +184,7 @@ class DeptService: async def dept_detail_services(cls, query_db: AsyncSession, dept_id: int): """ 获取部门详细信息service + :param query_db: orm对象 :param dept_id: 部门id :return: 部门id对应的信息 @@ -192,6 +201,7 @@ class DeptService: def list_to_tree(cls, permission_list: list) -> list: """ 工具方法：根据部门列表信息生成树形嵌套数据 + :param permission_list: 部门列表信息 :return: 部门树形嵌套数据 """ @@ -222,6 +232,7 @@ class DeptService: async def replace_first(cls, original_str: str, old_str: str, new_str: str): """ 工具方法：替换字符串 + :param original_str: 需要替换的原始字符串 :param old_str: 用于匹配的字符串 :param new_str: 替换的字符串 @@ -236,6 +247,7 @@ class DeptService: async def update_parent_dept_status_normal(cls, query_db: AsyncSession, dept: DeptModel): """ 更新父部门状态为正常 + :param query_db: orm对象 :param dept: 部门对象 :return: @@ -247,6 +259,7 @@ class DeptService: async def update_dept_children(cls, query_db: AsyncSession, dept_id: int, new_ancestors: str, old_ancestors: str): """ 更新子部门信息 + :param query_db: orm对象 :param dept_id: 部门id :param new_ancestors: 新的祖先 diff --git a/ruoyi-fastapi-backend/module_admin/service/dict_service.py b/ruoyi-fastapi-backend/module_admin/service/dict_service.py index 06fb80a..8b82449 100644 --- a/ruoyi-fastapi-backend/module_admin/service/dict_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/dict_service.py @@ -29,6 +29,7 @@ class DictTypeService: ): """ 获取字典类型列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -42,6 +43,7 @@ class DictTypeService: async def check_dict_type_unique_services(cls, query_db: AsyncSession, page_object: DictTypeModel): """ 校验字典类型称是否唯一service + :param query_db: orm对象 :param page_object: 字典类型对象 :return: 校验结果 @@ -58,6 +60,7 @@ class DictTypeService: async def add_dict_type_services(cls, request: Request, query_db: AsyncSession, page_object: DictTypeModel): """ 新增字典类型信息service + :param request: Request对象 :param query_db: orm对象 :param page_object: 新增岗位对象 @@ -83,6 +86,7 @@ class DictTypeService: async def edit_dict_type_services(cls, request: Request, query_db: AsyncSession, page_object: DictTypeModel): """ 编辑字典类型信息service + :param request: Request对象 :param query_db: orm对象 :param page_object: 编辑字典类型对象 @@ -126,6 +130,7 @@ class DictTypeService: ): """ 删除字典类型信息service + :param request: Request对象 :param query_db: orm对象 :param page_object: 删除字典类型对象 @@ -155,6 +160,7 @@ class DictTypeService: async def dict_type_detail_services(cls, query_db: AsyncSession, dict_id: int): """ 获取字典类型详细信息service + :param query_db: orm对象 :param dict_id: 字典类型id :return: 字典类型id对应的信息 @@ -171,6 +177,7 @@ class DictTypeService: async def export_dict_type_list_services(dict_type_list: List): """ 导出字典类型信息service + :param dict_type_list: 字典信息列表 :return: 字典信息对应excel的二进制数据 """ @@ -205,6 +212,7 @@ class DictTypeService: async def refresh_sys_dict_services(cls, request: Request, query_db: AsyncSession): """ 刷新字典缓存信息service + :param request: Request对象 :param query_db: orm对象 :return: 刷新字典缓存校验结果 @@ -226,6 +234,7 @@ class DictDataService: ): """ 获取字典数据列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -239,6 +248,7 @@ class DictDataService: async def query_dict_data_list_services(cls, query_db: AsyncSession, dict_type: str): """ 获取字典数据列表信息service + :param query_db: orm对象 :param dict_type: 字典类型 :return: 字典数据列表信息对象 @@ -251,6 +261,7 @@ class DictDataService: async def init_cache_sys_dict_services(cls, query_db: AsyncSession, redis): """ 应用初始化：获取所有字典类型对应的字典数据信息并缓存service + :param query_db: orm对象 :param redis: redis对象 :return: @@ -274,6 +285,7 @@ class DictDataService: async def query_dict_data_list_from_cache_services(cls, redis, dict_type: str): """ 从缓存获取字典数据列表信息service + :param redis: redis对象 :param dict_type: 字典类型 :return: 字典数据列表信息对象 @@ -289,6 +301,7 @@ class DictDataService: async def check_dict_data_unique_services(cls, query_db: AsyncSession, page_object: DictDataModel): """ 校验字典数据是否唯一service + :param query_db: orm对象 :param page_object: 字典数据对象 :return: 校验结果 @@ -303,6 +316,7 @@ class DictDataService: async def add_dict_data_services(cls, request: Request, query_db: AsyncSession, page_object: DictDataModel): """ 新增字典数据信息service + :param request: Request对象 :param query_db: orm对象 :param page_object: 新增岗位对象 @@ -330,6 +344,7 @@ class DictDataService: async def edit_dict_data_services(cls, request: Request, query_db: AsyncSession, page_object: DictDataModel): """ 编辑字典数据信息service + :param request: Request对象 :param query_db: orm对象 :param page_object: 编辑字典数据对象 @@ -364,6 +379,7 @@ class DictDataService: ): """ 删除字典数据信息service + :param request: Request对象 :param query_db: orm对象 :param page_object: 删除字典数据对象 @@ -395,6 +411,7 @@ class DictDataService: async def dict_data_detail_services(cls, query_db: AsyncSession, dict_code: int): """ 获取字典数据详细信息service + :param query_db: orm对象 :param dict_code: 字典数据id :return: 字典数据id对应的信息 @@ -411,6 +428,7 @@ class DictDataService: async def export_dict_data_list_services(dict_data_list: List): """ 导出字典数据信息service + :param dict_data_list: 字典数据信息列表 :return: 字典数据信息对应excel的二进制数据 """ diff --git a/ruoyi-fastapi-backend/module_admin/service/job_log_service.py b/ruoyi-fastapi-backend/module_admin/service/job_log_service.py index a425b0b..a029409 100644 --- a/ruoyi-fastapi-backend/module_admin/service/job_log_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/job_log_service.py @@ -20,6 +20,7 @@ class JobLogService: ): """ 获取定时任务日志列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -33,6 +34,7 @@ class JobLogService: def add_job_log_services(cls, query_db: Session, page_object: JobLogModel): """ 新增定时任务日志信息service + :param query_db: orm对象 :param page_object: 新增定时任务日志对象 :return: 新增定时任务日志校验结果 @@ -51,6 +53,7 @@ class JobLogService: async def delete_job_log_services(cls, query_db: AsyncSession, page_object: DeleteJobLogModel): """ 删除定时任务日志信息service + :param query_db: orm对象 :param page_object: 删除定时任务日志对象 :return: 删除定时任务日志校验结果 @@ -73,6 +76,7 @@ class JobLogService: async def clear_job_log_services(cls, query_db: AsyncSession): """ 清除定时任务日志信息service + :param query_db: orm对象 :return: 清除定时任务日志校验结果 """ @@ -90,6 +94,7 @@ class JobLogService: async def export_job_log_list_services(request: Request, job_log_list: List): """ 导出定时任务日志信息service + :param request: Request对象 :param job_log_list: 定时任务日志信息列表 :return: 定时任务日志信息对应excel的二进制数据 diff --git a/ruoyi-fastapi-backend/module_admin/service/job_service.py b/ruoyi-fastapi-backend/module_admin/service/job_service.py index 87e460f..12a9b93 100644 --- a/ruoyi-fastapi-backend/module_admin/service/job_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/job_service.py @@ -20,6 +20,7 @@ class JobService: ): """ 获取定时任务列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -33,6 +34,7 @@ class JobService: async def add_job_services(cls, query_db: AsyncSession, page_object: JobModel): """ 新增定时任务信息service + :param query_db: orm对象 :param page_object: 新增定时任务对象 :return: 新增定时任务校验结果 @@ -58,6 +60,7 @@ class JobService: async def edit_job_services(cls, query_db: AsyncSession, page_object: EditJobModel): """ 编辑定时任务信息service + :param query_db: orm对象 :param page_object: 编辑定时任务对象 :return: 编辑定时任务校验结果 @@ -99,6 +102,7 @@ class JobService: async def execute_job_once_services(cls, query_db: AsyncSession, page_object: JobModel): """ 执行一次定时任务service + :param query_db: orm对象 :param page_object: 定时任务对象 :return: 执行一次定时任务结果 @@ -119,6 +123,7 @@ class JobService: async def delete_job_services(cls, query_db: AsyncSession, page_object: DeleteJobModel): """ 删除定时任务信息service + :param query_db: orm对象 :param page_object: 删除定时任务对象 :return: 删除定时任务校验结果 @@ -144,6 +149,7 @@ class JobService: async def job_detail_services(cls, query_db: AsyncSession, job_id: int): """ 获取定时任务详细信息service + :param query_db: orm对象 :param job_id: 定时任务id :return: 定时任务id对应的信息 @@ -157,6 +163,7 @@ class JobService: async def export_job_list_services(request: Request, job_list: List): """ 导出定时任务信息service + :param request: Request对象 :param job_list: 定时任务信息列表 :return: 定时任务信息对应excel的二进制数据 diff --git a/ruoyi-fastapi-backend/module_admin/service/log_service.py b/ruoyi-fastapi-backend/module_admin/service/log_service.py index 0ac8464..047ec45 100644 --- a/ruoyi-fastapi-backend/module_admin/service/log_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/log_service.py @@ -28,6 +28,7 @@ class OperationLogService: ): """ 获取操作日志列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -41,6 +42,7 @@ class OperationLogService: async def add_operation_log_services(cls, query_db: AsyncSession, page_object: OperLogModel): """ 新增操作日志service + :param query_db: orm对象 :param page_object: 新增操作日志对象 :return: 新增操作日志校验结果 @@ -57,6 +59,7 @@ class OperationLogService: async def delete_operation_log_services(cls, query_db: AsyncSession, page_object: DeleteOperLogModel): """ 删除操作日志信息service + :param query_db: orm对象 :param page_object: 删除操作日志对象 :return: 删除操作日志校验结果 @@ -78,6 +81,7 @@ class OperationLogService: async def clear_operation_log_services(cls, query_db: AsyncSession): """ 清除操作日志信息service + :param query_db: orm对象 :return: 清除操作日志校验结果 """ @@ -93,6 +97,7 @@ class OperationLogService: async def export_operation_log_list_services(cls, request: Request, operation_log_list: List): """ 导出操作日志信息service + :param request: Request对象 :param operation_log_list: 操作日志信息列表 :return: 操作日志信息对应excel的二进制数据 @@ -153,6 +158,7 @@ class LoginLogService: ): """ 获取登录日志列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -166,6 +172,7 @@ class LoginLogService: async def add_login_log_services(cls, query_db: AsyncSession, page_object: LogininforModel): """ 新增登录日志service + :param query_db: orm对象 :param page_object: 新增登录日志对象 :return: 新增登录日志校验结果 @@ -182,6 +189,7 @@ class LoginLogService: async def delete_login_log_services(cls, query_db: AsyncSession, page_object: DeleteLoginLogModel): """ 删除操作日志信息service + :param query_db: orm对象 :param page_object: 删除操作日志对象 :return: 删除操作日志校验结果 @@ -203,6 +211,7 @@ class LoginLogService: async def clear_login_log_services(cls, query_db: AsyncSession): """ 清除操作日志信息service + :param query_db: orm对象 :return: 清除操作日志校验结果 """ @@ -227,6 +236,7 @@ class LoginLogService: async def export_login_log_list_services(login_log_list: List): """ 导出登录日志信息service + :param login_log_list: 登录日志信息列表 :return: 登录日志信息对应excel的二进制数据 """ diff --git a/ruoyi-fastapi-backend/module_admin/service/login_service.py b/ruoyi-fastapi-backend/module_admin/service/login_service.py index ddf792a..6f654c4 100644 --- a/ruoyi-fastapi-backend/module_admin/service/login_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/login_service.py @@ -64,6 +64,7 @@ class LoginService: async def authenticate_user(cls, request: Request, query_db: AsyncSession, login_user: UserLogin): """ 根据用户名密码校验用户登录 + :param request: Request对象 :param query_db: orm对象 :param login_user: 登录用户对象 @@ -132,6 +133,7 @@ class LoginService: async def __check_login_ip(cls, request: Request): """ 校验用户登录ip是否在黑名单内 + :param request: Request对象 :return: 校验结果 """ @@ -148,6 +150,7 @@ class LoginService: async def __check_login_captcha(cls, request: Request, login_user: UserLogin): """ 校验用户登录验证码 + :param request: Request对象 :param login_user: 登录用户对象 :return: 校验结果 @@ -167,6 +170,7 @@ class LoginService: async def create_access_token(cls, data: dict, expires_delta: Union[timedelta, None] = None): """ 根据登录信息创建当前用户token + :param data: 登录信息 :param expires_delta: token有效期 :return: token @@ -186,6 +190,7 @@ class LoginService: ): """ 根据token获取当前用户信息 + :param request: Request对象 :param token: 用户token :param query_db: orm对象 @@ -264,6 +269,7 @@ class LoginService: async def get_current_user_routers(cls, user_id: int, query_db: AsyncSession): """ 根据用户id获取当前用户路由信息 + :param user_id: 用户id :param query_db: orm对象 :return: 当前用户路由信息对象 @@ -285,6 +291,7 @@ class LoginService: def __generate_menus(cls, pid: int, permission_list: List[SysMenu]): """ 工具方法：根据菜单信息生成菜单信息树形嵌套数据 + :param pid: 菜单id :param permission_list: 菜单列表信息 :return: 菜单信息树形嵌套数据 @@ -304,6 +311,7 @@ class LoginService: def __generate_user_router_menu(cls, permission_list: List[MenuTreeModel]): """ 工具方法：根据菜单树信息生成路由信息树形嵌套数据 + :param permission_list: 菜单树列表信息 :return: 路由信息树形嵌套数据 """ @@ -370,6 +378,7 @@ class LoginService: async def register_user_services(cls, request: Request, query_db: AsyncSession, user_register: UserRegister): """ 用户注册services + :param request: Request对象 :param query_db: orm对象 :param user_register: 注册用户对象 @@ -415,6 +424,7 @@ class LoginService: async def get_sms_code_services(cls, request: Request, query_db: AsyncSession, user: ResetUserModel): """ 获取短信验证码service + :param request: Request对象 :param query_db: orm对象 :param user: 用户对象 @@ -443,6 +453,7 @@ class LoginService: async def forget_user_services(cls, request: Request, query_db: AsyncSession, forget_user: ResetUserModel): """ 用户忘记密码services + :param request: Request对象 :param query_db: orm对象 :param forget_user: 重置用户对象 @@ -468,6 +479,7 @@ class LoginService: async def logout_services(cls, request: Request, session_id: str): """ 退出登录services + :param request: Request对象 :param session_id: 会话编号 :return: 退出登录结果 @@ -488,6 +500,7 @@ class RouterUtil: def get_router_name(cls, menu: MenuTreeModel): """ 获取路由名称 + :param menu: 菜单数对象 :return: 路由名称 """ @@ -501,6 +514,7 @@ class RouterUtil: def get_router_path(cls, menu: MenuTreeModel): """ 获取路由地址 + :param menu: 菜单数对象 :return: 路由地址 """ @@ -520,6 +534,7 @@ class RouterUtil: def get_component(cls, menu: MenuTreeModel): """ 获取组件信息 + :param menu: 菜单数对象 :return: 组件信息 """ @@ -536,6 +551,7 @@ class RouterUtil: def is_menu_frame(cls, menu: MenuTreeModel): """ 判断是否为菜单内部跳转 + :param menu: 菜单数对象 :return: 是否为菜单内部跳转 """ @@ -547,6 +563,7 @@ class RouterUtil: def is_inner_link(cls, menu: MenuTreeModel): """ 判断是否为内链组件 + :param menu: 菜单数对象 :return: 是否为内链组件 """ @@ -556,6 +573,7 @@ class RouterUtil: def is_parent_view(cls, menu: MenuTreeModel): """ 判断是否为parent_view组件 + :param menu: 菜单数对象 :return: 是否为parent_view组件 """ @@ -565,6 +583,7 @@ class RouterUtil: def is_http(cls, link: str): """ 判断是否为http(s)://开头 + :param link: 链接 :return: 是否为http(s)://开头 """ @@ -574,6 +593,7 @@ class RouterUtil: def inner_link_replace_each(cls, path: str): """ 内链域名特殊字符替换 + :param path: 内链域名 :return: 替换后的内链域名 """ diff --git a/ruoyi-fastapi-backend/module_admin/service/menu_service.py b/ruoyi-fastapi-backend/module_admin/service/menu_service.py index f0f8ce2..6020d1a 100644 --- a/ruoyi-fastapi-backend/module_admin/service/menu_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/menu_service.py @@ -21,6 +21,7 @@ class MenuService: async def get_menu_tree_services(cls, query_db: AsyncSession, current_user: Optional[CurrentUserModel] = None): """ 获取菜单树信息service + :param query_db: orm对象 :param current_user: 当前用户对象 :return: 菜单树信息对象 @@ -38,6 +39,7 @@ class MenuService: ): """ 根据角色id获取菜单树信息service + :param query_db: orm对象 :param role_id: 角色id :param current_user: 当前用户对象 @@ -60,6 +62,7 @@ class MenuService: ): """ 获取菜单列表信息service + :param query_db: orm对象 :param page_object: 分页查询参数对象 :param current_user: 当前用户对象 @@ -75,6 +78,7 @@ class MenuService: async def check_menu_name_unique_services(cls, query_db: AsyncSession, page_object: MenuModel): """ 校验菜单名称是否唯一service + :param query_db: orm对象 :param page_object: 菜单对象 :return: 校验结果 @@ -89,6 +93,7 @@ class MenuService: async def add_menu_services(cls, query_db: AsyncSession, page_object: MenuModel): """ 新增菜单信息service + :param query_db: orm对象 :param page_object: 新增菜单对象 :return: 新增菜单校验结果 @@ -110,6 +115,7 @@ class MenuService: async def edit_menu_services(cls, query_db: AsyncSession, page_object: MenuModel): """ 编辑菜单信息service + :param query_db: orm对象 :param page_object: 编辑部门对象 :return: 编辑菜单校验结果 @@ -138,6 +144,7 @@ class MenuService: async def delete_menu_services(cls, query_db: AsyncSession, page_object: DeleteMenuModel): """ 删除菜单信息service + :param query_db: orm对象 :param page_object: 删除菜单对象 :return: 删除菜单校验结果 @@ -163,6 +170,7 @@ class MenuService: async def menu_detail_services(cls, query_db: AsyncSession, menu_id: int): """ 获取菜单详细信息service + :param query_db: orm对象 :param menu_id: 菜单id :return: 菜单id对应的信息 @@ -179,6 +187,7 @@ class MenuService: def list_to_tree(cls, permission_list: list) -> list: """ 工具方法：根据菜单列表信息生成树形嵌套数据 + :param permission_list: 菜单列表信息 :return: 菜单树形嵌套数据 """ diff --git a/ruoyi-fastapi-backend/module_admin/service/notice_service.py b/ruoyi-fastapi-backend/module_admin/service/notice_service.py index d9e5594..5ee69e7 100644 --- a/ruoyi-fastapi-backend/module_admin/service/notice_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/notice_service.py @@ -18,6 +18,7 @@ class NoticeService: ): """ 获取通知公告列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -31,6 +32,7 @@ class NoticeService: async def check_notice_unique_services(cls, query_db: AsyncSession, page_object: NoticeModel): """ 校验通知公告是否存在service + :param query_db: orm对象 :param page_object: 通知公告对象 :return: 校验结果 @@ -45,6 +47,7 @@ class NoticeService: async def add_notice_services(cls, query_db: AsyncSession, page_object: NoticeModel): """ 新增通知公告信息service + :param query_db: orm对象 :param page_object: 新增通知公告对象 :return: 新增通知公告校验结果 @@ -64,6 +67,7 @@ class NoticeService: async def edit_notice_services(cls, query_db: AsyncSession, page_object: NoticeModel): """ 编辑通知公告信息service + :param query_db: orm对象 :param page_object: 编辑通知公告对象 :return: 编辑通知公告校验结果 @@ -88,6 +92,7 @@ class NoticeService: async def delete_notice_services(cls, query_db: AsyncSession, page_object: DeleteNoticeModel): """ 删除通知公告信息service + :param query_db: orm对象 :param page_object: 删除通知公告对象 :return: 删除通知公告校验结果 @@ -109,6 +114,7 @@ class NoticeService: async def notice_detail_services(cls, query_db: AsyncSession, notice_id: int): """ 获取通知公告详细信息service + :param query_db: orm对象 :param notice_id: 通知公告id :return: 通知公告id对应的信息 diff --git a/ruoyi-fastapi-backend/module_admin/service/online_service.py b/ruoyi-fastapi-backend/module_admin/service/online_service.py index 3e16eef..e861213 100644 --- a/ruoyi-fastapi-backend/module_admin/service/online_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/online_service.py @@ -16,6 +16,7 @@ class OnlineService: async def get_online_list_services(cls, request: Request, query_object: OnlineQueryModel): """ 获取在线用户表信息service + :param request: Request对象 :param query_object: 查询参数对象 :return: 在线用户列表信息 @@ -60,6 +61,7 @@ class OnlineService: async def delete_online_services(cls, request: Request, page_object: DeleteOnlineModel): """ 强退在线用户信息service + :param request: Request对象 :param page_object: 强退在线用户对象 :return: 强退在线用户校验结果 diff --git a/ruoyi-fastapi-backend/module_admin/service/post_service.py b/ruoyi-fastapi-backend/module_admin/service/post_service.py index 3ce4a6b..b435393 100644 --- a/ruoyi-fastapi-backend/module_admin/service/post_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/post_service.py @@ -19,6 +19,7 @@ class PostService: ): """ 获取岗位列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param is_page: 是否开启分页 @@ -32,6 +33,7 @@ class PostService: async def check_post_name_unique_services(cls, query_db: AsyncSession, page_object: PostModel): """ 检查岗位名称是否唯一service + :param query_db: orm对象 :param page_object: 岗位对象 :return: 校验结果 @@ -46,6 +48,7 @@ class PostService: async def check_post_code_unique_services(cls, query_db: AsyncSession, page_object: PostModel): """ 检查岗位编码是否唯一service + :param query_db: orm对象 :param page_object: 岗位对象 :return: 校验结果 @@ -60,6 +63,7 @@ class PostService: async def add_post_services(cls, query_db: AsyncSession, page_object: PostModel): """ 新增岗位信息service + :param query_db: orm对象 :param page_object: 新增岗位对象 :return: 新增岗位校验结果 @@ -81,6 +85,7 @@ class PostService: async def edit_post_services(cls, query_db: AsyncSession, page_object: PostModel): """ 编辑岗位信息service + :param query_db: orm对象 :param page_object: 编辑岗位对象 :return: 编辑岗位校验结果 @@ -107,6 +112,7 @@ class PostService: async def delete_post_services(cls, query_db: AsyncSession, page_object: DeletePostModel): """ 删除岗位信息service + :param query_db: orm对象 :param page_object: 删除岗位对象 :return: 删除岗位校验结果 @@ -131,6 +137,7 @@ class PostService: async def post_detail_services(cls, query_db: AsyncSession, post_id: int): """ 获取岗位详细信息service + :param query_db: orm对象 :param post_id: 岗位id :return: 岗位id对应的信息 @@ -147,6 +154,7 @@ class PostService: async def export_post_list_services(post_list: List): """ 导出岗位信息service + :param post_list: 岗位信息列表 :return: 岗位信息对应excel的二进制数据 """ diff --git a/ruoyi-fastapi-backend/module_admin/service/role_service.py b/ruoyi-fastapi-backend/module_admin/service/role_service.py index dbd2b22..cd6fa57 100644 --- a/ruoyi-fastapi-backend/module_admin/service/role_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/role_service.py @@ -28,6 +28,7 @@ class RoleService: async def get_role_select_option_services(cls, query_db: AsyncSession): """ 获取角色列表不分页信息service + :param query_db: orm对象 :return: 角色列表不分页信息对象 """ @@ -39,6 +40,7 @@ class RoleService: async def get_role_dept_tree_services(cls, query_db: AsyncSession, role_id: int): """ 根据角色id获取部门树信息service + :param query_db: orm对象 :param role_id: 角色id :return: 当前角色id的部门树信息对象 @@ -56,6 +58,7 @@ class RoleService: ): """ 获取角色列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -70,6 +73,7 @@ class RoleService: async def check_role_allowed_services(cls, check_role: RoleModel): """ 校验角色是否允许操作service + :param check_role: 角色信息 :return: 校验结果 """ @@ -82,6 +86,7 @@ class RoleService: async def check_role_data_scope_services(cls, query_db: AsyncSession, role_ids: str, data_scope_sql: str): """ 校验角色是否有数据权限service + :param query_db: orm对象 :param role_ids: 角色id :param data_scope_sql: 数据权限对应的查询sql语句 @@ -100,6 +105,7 @@ class RoleService: async def check_role_name_unique_services(cls, query_db: AsyncSession, page_object: RoleModel): """ 校验角色名称是否唯一service + :param query_db: orm对象 :param page_object: 角色对象 :return: 校验结果 @@ -114,6 +120,7 @@ class RoleService: async def check_role_key_unique_services(cls, query_db: AsyncSession, page_object: RoleModel): """ 校验角色权限字符是否唯一service + :param query_db: orm对象 :param page_object: 角色对象 :return: 校验结果 @@ -128,6 +135,7 @@ class RoleService: async def add_role_services(cls, query_db: AsyncSession, page_object: AddRoleModel): """ 新增角色信息service + :param query_db: orm对象 :param page_object: 新增角色对象 :return: 新增角色校验结果 @@ -154,6 +162,7 @@ class RoleService: async def edit_role_services(cls, query_db: AsyncSession, page_object: AddRoleModel): """ 编辑角色信息service + :param query_db: orm对象 :param page_object: 编辑角色对象 :return: 编辑角色校验结果 @@ -191,6 +200,7 @@ class RoleService: async def role_datascope_services(cls, query_db: AsyncSession, page_object: AddRoleModel): """ 分配角色数据权限service + :param query_db: orm对象 :param page_object: 角色数据权限对象 :return: 分配角色数据权限结果 @@ -218,6 +228,7 @@ class RoleService: async def delete_role_services(cls, query_db: AsyncSession, page_object: DeleteRoleModel): """ 删除角色信息service + :param query_db: orm对象 :param page_object: 删除角色对象 :return: 删除角色校验结果 @@ -247,6 +258,7 @@ class RoleService: async def role_detail_services(cls, query_db: AsyncSession, role_id: int): """ 获取角色详细信息service + :param query_db: orm对象 :param role_id: 角色id :return: 角色id对应的信息 @@ -263,6 +275,7 @@ class RoleService: async def export_role_list_services(role_list: List): """ 导出角色列表信息service + :param role_list: 角色信息列表 :return: 角色列表信息对象 """ @@ -300,6 +313,7 @@ class RoleService: ): """ 根据角色id获取已分配用户列表 + :param query_db: orm对象 :param page_object: 用户关联角色对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -324,6 +338,7 @@ class RoleService: ): """ 根据角色id获取未分配用户列表 + :param query_db: orm对象 :param page_object: 用户关联角色对象 :param data_scope_sql: 数据权限对应的查询sql语句 diff --git a/ruoyi-fastapi-backend/module_admin/service/user_service.py b/ruoyi-fastapi-backend/module_admin/service/user_service.py index 37d9dac..9213406 100644 --- a/ruoyi-fastapi-backend/module_admin/service/user_service.py +++ b/ruoyi-fastapi-backend/module_admin/service/user_service.py @@ -47,6 +47,7 @@ class UserService: ): """ 获取用户列表信息service + :param query_db: orm对象 :param query_object: 查询参数对象 :param data_scope_sql: 数据权限对应的查询sql语句 @@ -72,6 +73,7 @@ class UserService: async def check_user_allowed_services(cls, check_user: UserModel): """ 校验用户是否允许操作service + :param check_user: 用户信息 :return: 校验结果 """ @@ -84,6 +86,7 @@ class UserService: async def check_user_data_scope_services(cls, query_db: AsyncSession, user_id: int, data_scope_sql: str): """ 校验用户数据权限service + :param query_db: orm对象 :param user_id: 用户id :param data_scope_sql: 数据权限对应的查询sql语句 @@ -99,6 +102,7 @@ class UserService: async def check_user_name_unique_services(cls, query_db: AsyncSession, page_object: UserModel): """ 校验用户名是否唯一service + :param query_db: orm对象 :param page_object: 用户对象 :return: 校验结果 @@ -113,6 +117,7 @@ class UserService: async def check_phonenumber_unique_services(cls, query_db: AsyncSession, page_object: UserModel): """ 校验用户手机号是否唯一service + :param query_db: orm对象 :param page_object: 用户对象 :return: 校验结果 @@ -127,6 +132,7 @@ class UserService: async def check_email_unique_services(cls, query_db: AsyncSession, page_object: UserModel): """ 校验用户邮箱是否唯一service + :param query_db: orm对象 :param page_object: 用户对象 :return: 校验结果 @@ -141,6 +147,7 @@ class UserService: async def add_user_services(cls, query_db: AsyncSession, page_object: AddUserModel): """ 新增用户信息service + :param query_db: orm对象 :param page_object: 新增用户对象 :return: 新增用户校验结果 @@ -172,6 +179,7 @@ class UserService: async def edit_user_services(cls, query_db: AsyncSession, page_object: EditUserModel): """ 编辑用户信息service + :param query_db: orm对象 :param page_object: 编辑用户对象 :return: 编辑用户校验结果 @@ -219,6 +227,7 @@ class UserService: async def delete_user_services(cls, query_db: AsyncSession, page_object: DeleteUserModel): """ 删除用户信息service + :param query_db: orm对象 :param page_object: 删除用户对象 :return: 删除用户校验结果 @@ -245,6 +254,7 @@ class UserService: async def user_detail_services(cls, query_db: AsyncSession, user_id: Union[int, str]): """ 获取用户详细信息service + :param query_db: orm对象 :param user_id: 用户id :return: 用户id对应的信息 @@ -277,7 +287,8 @@ class UserService: @classmethod async def user_profile_services(cls, query_db: AsyncSession, user_id: int): """ - 获取用户详细信息service + 获取用户个人详细信息service + :param query_db: orm对象 :param user_id: 用户id :return: 用户id对应的信息 @@ -304,6 +315,7 @@ class UserService: async def reset_user_services(cls, query_db: AsyncSession, page_object: ResetUserModel): """ 重置用户密码service + :param query_db: orm对象 :param page_object: 重置用户对象 :return: 重置用户校验结果 @@ -341,6 +353,7 @@ class UserService: ): """ 批量导入用户service + :param request: Request对象 :param query_db: orm对象 :param file: 用户导入文件对象 @@ -441,6 +454,7 @@ class UserService: async def get_user_import_template_services(): """ 获取用户导入模板service + :return: 用户导入模板excel的二进制数据 """ header_list = ['部门编号', '登录名称', '用户名称', '用户邮箱', '手机号码', '用户性别', '帐号状态'] @@ -456,6 +470,7 @@ class UserService: async def export_user_list_services(user_list: List): """ 导出用户信息service + :param user_list: 用户信息列表 :return: 用户信息对应excel的二进制数据 """ @@ -500,6 +515,7 @@ class UserService: async def get_user_role_allocated_list_services(cls, query_db: AsyncSession, page_object: UserRoleQueryModel): """ 根据用户id获取已分配角色列表 + :param query_db: orm对象 :param page_object: 用户关联角色对象 :return: 已分配角色列表 @@ -529,6 +545,7 @@ class UserService: async def add_user_role_services(cls, query_db: AsyncSession, page_object: CrudUserRoleModel): """ 新增用户关联角色信息service + :param query_db: orm对象 :param page_object: 新增用户关联角色对象 :return: 新增用户关联角色校验结果 @@ -584,6 +601,7 @@ class UserService: async def delete_user_role_services(cls, query_db: AsyncSession, page_object: CrudUserRoleModel): """ 删除用户关联角色信息service + :param query_db: orm对象 :param page_object: 删除用户关联角色对象 :return: 删除用户关联角色校验结果 @@ -620,6 +638,7 @@ class UserService: async def detail_user_role_services(cls, query_db: AsyncSession, page_object: UserRoleModel): """ 获取用户关联角色详细信息service + :param query_db: orm对象 :param page_object: 用户关联角色对象 :return: 用户关联角色详细信息 diff --git a/ruoyi-fastapi-backend/utils/common_util.py b/ruoyi-fastapi-backend/utils/common_util.py index 67145d9..853cfe3 100644 --- a/ruoyi-fastapi-backend/utils/common_util.py +++ b/ruoyi-fastapi-backend/utils/common_util.py @@ -33,7 +33,7 @@ def worship(): // ========`-.____`-.___\_____/___.-`____.-'======== // // `=---=' // // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ // -// 佛祖保佑 永不宕机 永无BUG // +// 佛祖保佑 永不宕机 永无BUG // //////////////////////////////////////////////////////////////////// """) @@ -47,6 +47,7 @@ class CamelCaseUtil: def snake_to_camel(cls, snake_str): """ 下划线形式字符串(snake_case)转换为小驼峰形式字符串(camelCase) + :param snake_str: 下划线形式字符串 :return: 小驼峰形式字符串 """ @@ -59,6 +60,7 @@ class CamelCaseUtil: def transform_result(cls, result): """ 针对不同类型将下划线形式(snake_case)批量转换为小驼峰形式(camelCase)方法 + :param result: 输入数据 :return: 小驼峰形式结果 """ @@ -101,6 +103,7 @@ class SnakeCaseUtil: def camel_to_snake(cls, camel_str): """ 小驼峰形式字符串(camelCase)转换为下划线形式字符串(snake_case) + :param camel_str: 小驼峰形式字符串 :return: 下划线形式字符串 """ @@ -112,6 +115,7 @@ class SnakeCaseUtil: def transform_result(cls, result): """ 针对不同类型将下划线形式(snake_case)批量转换为小驼峰形式(camelCase)方法 + :param result: 输入数据 :return: 小驼峰形式结果 """ @@ -172,6 +176,7 @@ def bytes2file_response(bytes_info): def export_list2excel(list_data: List): """ 工具方法：将需要导出的list数据转化为对应excel的二进制数据 + :param list_data: 数据列表 :return: 字典信息对应excel的二进制数据 """ @@ -186,6 +191,7 @@ def export_list2excel(list_data: List): def get_excel_template(header_list: List, selector_header_list: List, option_list: List[dict]): """ 工具方法：将需要导出的list数据转化为对应excel的二进制数据 + :param header_list: 表头数据列表 :param selector_header_list: 需要设置为选择器格式的表头数据列表 :param option_list: 选择器格式的表头预设的选项列表 @@ -246,6 +252,7 @@ def get_excel_template(header_list: List, selector_header_list: List, option_lis def get_filepath_from_url(url: str): """ 工具方法：根据请求参数获取文件路径 + :param url: 请求参数中的url参数 :return: 文件路径 """ diff --git a/ruoyi-fastapi-backend/utils/page_util.py b/ruoyi-fastapi-backend/utils/page_util.py index 0a18c9b..6e7bfe2 100644 --- a/ruoyi-fastapi-backend/utils/page_util.py +++ b/ruoyi-fastapi-backend/utils/page_util.py @@ -30,6 +30,7 @@ class PageUtil: def get_page_obj(cls, data_list: List, page_num: int, page_size: int): """ 输入数据列表data_list和分页信息，返回分页数据列表结果 + :param data_list: 原始数据列表 :param page_num: 当前页码 :param page_size: 当前页面数据量 @@ -53,6 +54,7 @@ class PageUtil: async def paginate(cls, db: AsyncSession, query: Select, page_num: int, page_size: int, is_page: bool = False): """ 输入查询语句和分页信息，返回分页数据列表结果 + :param db: orm对象 :param query: sqlalchemy查询语句 :param page_num: 当前页码 @@ -93,6 +95,7 @@ class PageUtil: def get_page_obj(data_list: List, page_num: int, page_size: int): """ 输入数据列表data_list和分页信息，返回分页数据列表结果 + :param data_list: 原始数据列表 :param page_num: 当前页码 :param page_size: 当前页面数据量 diff --git a/ruoyi-fastapi-backend/utils/pwd_util.py b/ruoyi-fastapi-backend/utils/pwd_util.py index badaa04..86e9c27 100644 --- a/ruoyi-fastapi-backend/utils/pwd_util.py +++ b/ruoyi-fastapi-backend/utils/pwd_util.py @@ -12,6 +12,7 @@ class PwdUtil: def verify_password(cls, plain_password, hashed_password): """ 工具方法：校验当前输入的密码与数据库存储的密码是否一致 + :param plain_password: 当前输入的密码 :param hashed_password: 数据库存储的密码 :return: 校验结果 @@ -22,6 +23,7 @@ class PwdUtil: def get_password_hash(cls, input_password): """ 工具方法：对当前输入的密码进行加密 + :param input_password: 输入的密码 :return: 加密成功的密码 """ diff --git a/ruoyi-fastapi-backend/utils/response_util.py b/ruoyi-fastapi-backend/utils/response_util.py index d06a7fa..88d2e37 100644 --- a/ruoyi-fastapi-backend/utils/response_util.py +++ b/ruoyi-fastapi-backend/utils/response_util.py @@ -23,6 +23,7 @@ class ResponseUtil: ) -> Response: """ 成功响应方法 + :param msg: 可选，自定义成功响应信息 :param data: 可选，成功响应结果中属性为data的值 :param rows: 可选，成功响应结果中属性为rows的值 @@ -56,6 +57,7 @@ class ResponseUtil: ) -> Response: """ 失败响应方法 + :param msg: 可选，自定义失败响应信息 :param data: 可选，失败响应结果中属性为data的值 :param rows: 可选，失败响应结果中属性为rows的值 @@ -89,6 +91,7 @@ class ResponseUtil: ) -> Response: """ 未认证响应方法 + :param msg: 可选，自定义未认证响应信息 :param data: 可选，未认证响应结果中属性为data的值 :param rows: 可选，未认证响应结果中属性为rows的值 @@ -121,13 +124,14 @@ class ResponseUtil: model_content: Optional[BaseModel] = None, ) -> Response: """ - 未认证响应方法 - :param msg: 可选，自定义未认证响应信息 - :param data: 可选，未认证响应结果中属性为data的值 - :param rows: 可选，未认证响应结果中属性为rows的值 - :param dict_content: 可选，dict类型，未认证响应结果中自定义属性的值 - :param model_content: 可选，BaseModel类型，未认证响应结果中自定义属性的值 - :return: 未认证响应结果 + 未授权响应方法 + + :param msg: 可选，自定义未授权响应信息 + :param data: 可选，未授权响应结果中属性为data的值 + :param rows: 可选，未授权响应结果中属性为rows的值 + :param dict_content: 可选，dict类型，未授权响应结果中自定义属性的值 + :param model_content: 可选，BaseModel类型，未授权响应结果中自定义属性的值 + :return: 未授权响应结果 """ result = {'code': HttpStatusConstant.FORBIDDEN, 'msg': msg} @@ -155,6 +159,7 @@ class ResponseUtil: ) -> Response: """ 错误响应方法 + :param msg: 可选，自定义错误响应信息 :param data: 可选，错误响应结果中属性为data的值 :param rows: 可选，错误响应结果中属性为rows的值 @@ -181,6 +186,7 @@ class ResponseUtil: def streaming(cls, *, data: Any = None): """ 流式响应方法 + :param data: 流式传输的内容 :return: 流式响应结果 """ diff --git a/ruoyi-fastapi-backend/utils/string_util.py b/ruoyi-fastapi-backend/utils/string_util.py index 738e0ac..0a9d25d 100644 --- a/ruoyi-fastapi-backend/utils/string_util.py +++ b/ruoyi-fastapi-backend/utils/string_util.py @@ -10,6 +10,7 @@ class StringUtil: def is_blank(cls, string: str) -> bool: """ 校验字符串是否为''或全空格 + :param string: 需要校验的字符串 :return: 校验结果 """ @@ -28,6 +29,7 @@ class StringUtil: def is_empty(cls, string) -> bool: """ 校验字符串是否为''或None + :param string: 需要校验的字符串 :return: 校验结果 """ @@ -37,6 +39,7 @@ class StringUtil: def is_http(cls, link: str): """ 判断是否为http(s)://开头 + :param link: 链接 :return: 是否为http(s)://开头 """ diff --git a/ruoyi-fastapi-backend/utils/time_format_util.py b/ruoyi-fastapi-backend/utils/time_format_util.py index ba19489..380537e 100644 --- a/ruoyi-fastapi-backend/utils/time_format_util.py +++ b/ruoyi-fastapi-backend/utils/time_format_util.py @@ -29,6 +29,7 @@ def list_format_datetime(lst): def format_datetime_dict_list(dicts): """ 递归遍历嵌套字典，并将 datetime 值转换为字符串格式 + :param dicts: 输入一个嵌套字典的列表 :return: 对目标列表中所有字典的datetime类型的属性格式化 """ diff --git a/ruoyi-fastapi-backend/utils/upload_util.py b/ruoyi-fastapi-backend/utils/upload_util.py index 99b00bb..726789e 100644 --- a/ruoyi-fastapi-backend/utils/upload_util.py +++ b/ruoyi-fastapi-backend/utils/upload_util.py @@ -14,15 +14,20 @@ class UploadUtil: def generate_random_number(cls): """ 生成3位数字构成的字符串 + + :return: 3位数字构成的字符串 """ random_number = random.randint(1, 999) return f'{random_number:03}' @classmethod - def check_file_exists(cls, filepath): + def check_file_exists(cls, filepath: str): """ 检查文件是否存在 + + :param filepath: 文件路径 + :return: 校验结果 """ return os.path.exists(filepath) @@ -30,6 +35,9 @@ class UploadUtil: def check_file_extension(cls, file: UploadFile): """ 检查文件后缀是否合法 + + :param file: 文件对象 + :return: 校验结果 """ file_extension = file.filename.rsplit('.', 1)[-1] if file_extension in UploadConfig.DEFAULT_ALLOWED_EXTENSION: @@ -37,9 +45,12 @@ class UploadUtil: return False @classmethod - def check_file_timestamp(cls, filename): + def check_file_timestamp(cls, filename: str): """ 校验文件时间戳是否合法 + + :param filename: 文件名称 + :return: 校验结果 """ timestamp = filename.rsplit('.', 1)[0].split('_')[-1].split(UploadConfig.UPLOAD_MACHINE)[0] try: @@ -49,18 +60,24 @@ class UploadUtil: return False @classmethod - def check_file_machine(cls, filename): + def check_file_machine(cls, filename: str): """ 校验文件机器码是否合法 + + :param filename: 文件名称 + :return: 校验结果 """ if filename.rsplit('.', 1)[0][-4] == UploadConfig.UPLOAD_MACHINE: return True return False @classmethod - def check_file_random_code(cls, filename): + def check_file_random_code(cls, filename: str): """ 校验文件随机码是否合法 + + :param filename: 文件名称 + :return: 校验结果 """ valid_code_list = [f'{i:03}' for i in range(1, 999)] if filename.rsplit('.', 1)[0][-3:] in valid_code_list: @@ -68,9 +85,12 @@ class UploadUtil: return False @classmethod - def generate_file(cls, filepath): + def generate_file(cls, filepath: str): """ 根据文件生成二进制数据 + + :param filepath: 文件路径 + :yield: 二进制数据 """ with open(filepath, 'rb') as response_file: yield from response_file @@ -79,5 +99,7 @@ class UploadUtil: def delete_file(cls, filepath: str): """ 根据文件路径删除对应文件 + + :param filepath: 文件路径 """ os.remove(filepath)