refactor: 重构日志装饰器为Log

ruoyi-fastapi-backend/module_admin/annotation/log_annotation.py

@@ -17,6 +17,177 @@ from config.enums import BusinessType
 from config.env import AppConfig
 
 
+class Log:
+    """
+    日志装饰器
+    """
+
+    def __init__(
+        self,
+        title: str,
+        business_type: BusinessType,
+        log_type: Optional[Literal['login', 'operation']] = 'operation',
+    ):
+        """
+        日志装饰器
+
+        :param title: 当前日志装饰器装饰的模块标题
+        :param business_type: 业务类型（OTHER其它 INSERT新增 UPDATE修改 DELETE删除 GRANT授权 EXPORT导出 IMPORT导入 FORCE强退 GENCODE生成代码 CLEAN清空数据）
+        :param log_type: 日志类型（login表示登录日志，operation表示为操作日志）
+        :return:
+        """
+        self.title = title
+        self.business_type = business_type.value
+        self.log_type = log_type
+
+    def __call__(self, func):
+        @wraps(func)
+        async def wrapper(*args, **kwargs):
+            start_time = time.time()
+            # 获取被装饰函数的文件路径
+            file_path = inspect.getfile(func)
+            # 获取项目根路径
+            project_root = os.getcwd()
+            # 处理文件路径，去除项目根路径部分
+            relative_path = os.path.relpath(file_path, start=project_root)[0:-2].replace('\\', '.')
+            # 获取当前被装饰函数所在路径
+            func_path = f'{relative_path}{func.__name__}()'
+            # 获取上下文信息
+            request: Request = kwargs.get('request')
+            token = request.headers.get('Authorization')
+            query_db = kwargs.get('query_db')
+            request_method = request.method
+            operator_type = 0
+            user_agent = request.headers.get('User-Agent')
+            if 'Windows' in user_agent or 'Macintosh' in user_agent or 'Linux' in user_agent:
+                operator_type = 1
+            if 'Mobile' in user_agent or 'Android' in user_agent or 'iPhone' in user_agent:
+                operator_type = 2
+            # 获取请求的url
+            oper_url = request.url.path
+            # 获取请求的ip及ip归属区域
+            oper_ip = request.headers.get('X-Forwarded-For')
+            oper_location = '内网IP'
+            if AppConfig.app_ip_location_query:
+                oper_location = get_ip_location(oper_ip)
+            # 根据不同的请求类型使用不同的方法获取请求参数
+            content_type = request.headers.get('Content-Type')
+            if content_type and (
+                'multipart/form-data' in content_type or 'application/x-www-form-urlencoded' in content_type
+            ):
+                payload = await request.form()
+                oper_param = '\n'.join([f'{key}: {value}' for key, value in payload.items()])
+            else:
+                payload = await request.body()
+                # 通过 request.path_params 直接访问路径参数
+                path_params = request.path_params
+                oper_param = {}
+                if payload:
+                    oper_param.update(json.loads(str(payload, 'utf-8')))
+                if path_params:
+                    oper_param.update(path_params)
+                oper_param = json.dumps(oper_param, ensure_ascii=False)
+            # 日志表请求参数字段长度最大为2000，因此在此处判断长度
+            if len(oper_param) > 2000:
+                oper_param = '请求参数过长'
+
+            # 获取操作时间
+            oper_time = datetime.now()
+            # 此处在登录之前向原始函数传递一些登录信息，用于监测在线用户的相关信息
+            login_log = {}
+            if self.log_type == 'login':
+                user_agent_info = parse(user_agent)
+                browser = f'{user_agent_info.browser.family}'
+                system_os = f'{user_agent_info.os.family}'
+                if user_agent_info.browser.version != ():
+                    browser += f' {user_agent_info.browser.version[0]}'
+                if user_agent_info.os.version != ():
+                    system_os += f' {user_agent_info.os.version[0]}'
+                login_log = dict(
+                    ipaddr=oper_ip,
+                    loginLocation=oper_location,
+                    browser=browser,
+                    os=system_os,
+                    loginTime=oper_time.strftime('%Y-%m-%d %H:%M:%S'),
+                )
+                kwargs['form_data'].login_info = login_log
+            # 调用原始函数
+            result = await func(*args, **kwargs)
+            # 获取请求耗时
+            cost_time = float(time.time() - start_time) * 100
+            # 判断请求是否来自api文档
+            request_from_swagger = (
+                request.headers.get('referer').endswith('docs') if request.headers.get('referer') else False
+            )
+            request_from_redoc = (
+                request.headers.get('referer').endswith('redoc') if request.headers.get('referer') else False
+            )
+            # 根据响应结果的类型使用不同的方法获取响应结果参数
+            if (
+                isinstance(result, JSONResponse)
+                or isinstance(result, ORJSONResponse)
+                or isinstance(result, UJSONResponse)
+            ):
+                result_dict = json.loads(str(result.body, 'utf-8'))
+            else:
+                if request_from_swagger or request_from_redoc:
+                    result_dict = {}
+                else:
+                    if result.status_code == 200:
+                        result_dict = {'code': result.status_code, 'message': '获取成功'}
+                    else:
+                        result_dict = {'code': result.status_code, 'message': '获取失败'}
+            json_result = json.dumps(result_dict, ensure_ascii=False)
+            # 根据响应结果获取响应状态及异常信息
+            status = 1
+            error_msg = ''
+            if result_dict.get('code') == 200:
+                status = 0
+            else:
+                error_msg = result_dict.get('msg')
+            # 根据日志类型向对应的日志表插入数据
+            if self.log_type == 'login':
+                # 登录请求来自于api文档时不记录登录日志，其余情况则记录
+                if request_from_swagger or request_from_redoc:
+                    pass
+                else:
+                    user = kwargs.get('form_data')
+                    user_name = user.username
+                    login_log['loginTime'] = oper_time
+                    login_log['userName'] = user_name
+                    login_log['status'] = str(status)
+                    login_log['msg'] = result_dict.get('msg')
+
+                    await LoginLogService.add_login_log_services(query_db, LogininforModel(**login_log))
+            else:
+                current_user = await LoginService.get_current_user(request, token, query_db)
+                oper_name = current_user.user.user_name
+                dept_name = current_user.user.dept.dept_name if current_user.user.dept else None
+                operation_log = OperLogModel(
+                    title=self.title,
+                    businessType=self.business_type,
+                    method=func_path,
+                    requestMethod=request_method,
+                    operatorType=operator_type,
+                    operName=oper_name,
+                    deptName=dept_name,
+                    operUrl=oper_url,
+                    operIp=oper_ip,
+                    operLocation=oper_location,
+                    operParam=oper_param,
+                    jsonResult=json_result,
+                    status=status,
+                    errorMsg=error_msg,
+                    operTime=oper_time,
+                    costTime=int(cost_time),
+                )
+                await OperationLogService.add_operation_log_services(query_db, operation_log)
+
+            return result
+
+        return wrapper
+
+
 def log_decorator(
     title: str,
     business_type: Union[Literal[0, 1, 2, 3, 4, 5, 6, 7, 8, 9], BusinessType],
@@ -33,9 +204,8 @@ def log_decorator(
     warnings.simplefilter('always', category=DeprecationWarning)
     if isinstance(business_type, BusinessType):
         business_type = business_type.value
-    else:
     warnings.warn(
-            '@log_decorator的business_type参数未来版本将不再支持int类型，请使用BusinessType枚举类型',
+        '未来版本将会移除@log_decorator装饰器，请使用@Log装饰器',
         category=DeprecationWarning,
         stacklevel=2,
     )

ruoyi-fastapi-backend/module_admin/controller/config_controller.py

@@ -4,7 +4,7 @@ from pydantic_validation_decorator import ValidateFields
 from sqlalchemy.ext.asyncio import AsyncSession
 from config.enums import BusinessType
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.entity.vo.config_vo import ConfigModel, ConfigPageQueryModel, DeleteConfigModel
 from module_admin.entity.vo.user_vo import CurrentUserModel
@@ -36,7 +36,7 @@ async def get_system_config_list(
 
 @configController.post('', dependencies=[Depends(CheckUserInterfaceAuth('system:config:add'))])
 @ValidateFields(validate_model='add_config')
-@log_decorator(title='参数管理', business_type=BusinessType.INSERT)
+@Log(title='参数管理', business_type=BusinessType.INSERT)
 async def add_system_config(
     request: Request,
     add_config: ConfigModel,
@@ -55,7 +55,7 @@ async def add_system_config(
 
 @configController.put('', dependencies=[Depends(CheckUserInterfaceAuth('system:config:edit'))])
 @ValidateFields(validate_model='edit_config')
-@log_decorator(title='参数管理', business_type=BusinessType.UPDATE)
+@Log(title='参数管理', business_type=BusinessType.UPDATE)
 async def edit_system_config(
     request: Request,
     edit_config: ConfigModel,
@@ -71,7 +71,7 @@ async def edit_system_config(
 
 
 @configController.delete('/refreshCache', dependencies=[Depends(CheckUserInterfaceAuth('system:config:remove'))])
-@log_decorator(title='参数管理', business_type=BusinessType.UPDATE)
+@Log(title='参数管理', business_type=BusinessType.UPDATE)
 async def refresh_system_config(request: Request, query_db: AsyncSession = Depends(get_db)):
     refresh_config_result = await ConfigService.refresh_sys_config_services(request, query_db)
     logger.info(refresh_config_result.message)
@@ -80,7 +80,7 @@ async def refresh_system_config(request: Request, query_db: AsyncSession = Depen
 
 
 @configController.delete('/{config_ids}', dependencies=[Depends(CheckUserInterfaceAuth('system:config:remove'))])
-@log_decorator(title='参数管理', business_type=BusinessType.DELETE)
+@Log(title='参数管理', business_type=BusinessType.DELETE)
 async def delete_system_config(request: Request, config_ids: str, query_db: AsyncSession = Depends(get_db)):
     delete_config = DeleteConfigModel(configIds=config_ids)
     delete_config_result = await ConfigService.delete_config_services(request, query_db, delete_config)
@@ -109,7 +109,7 @@ async def query_system_config(request: Request, config_key: str):
 
 
 @configController.post('/export', dependencies=[Depends(CheckUserInterfaceAuth('system:config:export'))])
-@log_decorator(title='参数管理', business_type=BusinessType.EXPORT)
+@Log(title='参数管理', business_type=BusinessType.EXPORT)
 async def export_system_config_list(
     request: Request,
     config_page_query: ConfigPageQueryModel = Depends(ConfigPageQueryModel.as_form),

ruoyi-fastapi-backend/module_admin/controller/dept_controller.py

@@ -5,7 +5,7 @@ from sqlalchemy.ext.asyncio import AsyncSession
 from typing import List
 from config.enums import BusinessType
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.data_scope import GetDataScope
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.entity.vo.dept_vo import DeleteDeptModel, DeptModel, DeptQueryModel
@@ -54,7 +54,7 @@ async def get_system_dept_list(
 
 @deptController.post('', dependencies=[Depends(CheckUserInterfaceAuth('system:dept:add'))])
 @ValidateFields(validate_model='add_dept')
-@log_decorator(title='部门管理', business_type=BusinessType.INSERT)
+@Log(title='部门管理', business_type=BusinessType.INSERT)
 async def add_system_dept(
     request: Request,
     add_dept: DeptModel,
@@ -73,7 +73,7 @@ async def add_system_dept(
 
 @deptController.put('', dependencies=[Depends(CheckUserInterfaceAuth('system:dept:edit'))])
 @ValidateFields(validate_model='edit_dept')
-@log_decorator(title='部门管理', business_type=BusinessType.UPDATE)
+@Log(title='部门管理', business_type=BusinessType.UPDATE)
 async def edit_system_dept(
     request: Request,
     edit_dept: DeptModel,
@@ -92,7 +92,7 @@ async def edit_system_dept(
 
 
 @deptController.delete('/{dept_ids}', dependencies=[Depends(CheckUserInterfaceAuth('system:dept:remove'))])
-@log_decorator(title='部门管理', business_type=BusinessType.DELETE)
+@Log(title='部门管理', business_type=BusinessType.DELETE)
 async def delete_system_dept(
     request: Request,
     dept_ids: str,

ruoyi-fastapi-backend/module_admin/controller/dict_controller.py

@@ -5,7 +5,7 @@ from sqlalchemy.ext.asyncio import AsyncSession
 from typing import List
 from config.enums import BusinessType
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.entity.vo.dict_vo import (
     DeleteDictDataModel,
@@ -46,7 +46,7 @@ async def get_system_dict_type_list(
 
 @dictController.post('/type', dependencies=[Depends(CheckUserInterfaceAuth('system:dict:add'))])
 @ValidateFields(validate_model='add_dict_type')
-@log_decorator(title='字典管理', business_type=BusinessType.INSERT)
+@Log(title='字典类型', business_type=BusinessType.INSERT)
 async def add_system_dict_type(
     request: Request,
     add_dict_type: DictTypeModel,
@@ -65,7 +65,7 @@ async def add_system_dict_type(
 
 @dictController.put('/type', dependencies=[Depends(CheckUserInterfaceAuth('system:dict:edit'))])
 @ValidateFields(validate_model='edit_dict_type')
-@log_decorator(title='字典管理', business_type=BusinessType.UPDATE)
+@Log(title='字典类型', business_type=BusinessType.UPDATE)
 async def edit_system_dict_type(
     request: Request,
     edit_dict_type: DictTypeModel,
@@ -81,7 +81,7 @@ async def edit_system_dict_type(
 
 
 @dictController.delete('/type/refreshCache', dependencies=[Depends(CheckUserInterfaceAuth('system:dict:remove'))])
-@log_decorator(title='字典管理', business_type=BusinessType.UPDATE)
+@Log(title='字典类型', business_type=BusinessType.UPDATE)
 async def refresh_system_dict(request: Request, query_db: AsyncSession = Depends(get_db)):
     refresh_dict_result = await DictTypeService.refresh_sys_dict_services(request, query_db)
     logger.info(refresh_dict_result.message)
@@ -90,7 +90,7 @@ async def refresh_system_dict(request: Request, query_db: AsyncSession = Depends
 
 
 @dictController.delete('/type/{dict_ids}', dependencies=[Depends(CheckUserInterfaceAuth('system:dict:remove'))])
-@log_decorator(title='字典管理', business_type=BusinessType.DELETE)
+@Log(title='字典类型', business_type=BusinessType.DELETE)
 async def delete_system_dict_type(request: Request, dict_ids: str, query_db: AsyncSession = Depends(get_db)):
     delete_dict_type = DeleteDictTypeModel(dictIds=dict_ids)
     delete_dict_type_result = await DictTypeService.delete_dict_type_services(request, query_db, delete_dict_type)
@@ -120,7 +120,7 @@ async def query_detail_system_dict_type(request: Request, dict_id: int, query_db
 
 
 @dictController.post('/type/export', dependencies=[Depends(CheckUserInterfaceAuth('system:dict:export'))])
-@log_decorator(title='字典管理', business_type=BusinessType.EXPORT)
+@Log(title='字典类型', business_type=BusinessType.EXPORT)
 async def export_system_dict_type_list(
     request: Request,
     dict_type_page_query: DictTypePageQueryModel = Depends(DictTypePageQueryModel.as_form),
@@ -166,7 +166,7 @@ async def get_system_dict_data_list(
 
 @dictController.post('/data', dependencies=[Depends(CheckUserInterfaceAuth('system:dict:add'))])
 @ValidateFields(validate_model='add_dict_data')
-@log_decorator(title='字典管理', business_type=BusinessType.INSERT)
+@Log(title='字典数据', business_type=BusinessType.INSERT)
 async def add_system_dict_data(
     request: Request,
     add_dict_data: DictDataModel,
@@ -185,7 +185,7 @@ async def add_system_dict_data(
 
 @dictController.put('/data', dependencies=[Depends(CheckUserInterfaceAuth('system:dict:edit'))])
 @ValidateFields(validate_model='edit_dict_data')
-@log_decorator(title='字典管理', business_type=BusinessType.UPDATE)
+@Log(title='字典数据', business_type=BusinessType.UPDATE)
 async def edit_system_dict_data(
     request: Request,
     edit_dict_data: DictDataModel,
@@ -201,7 +201,7 @@ async def edit_system_dict_data(
 
 
 @dictController.delete('/data/{dict_codes}', dependencies=[Depends(CheckUserInterfaceAuth('system:dict:remove'))])
-@log_decorator(title='字典管理', business_type=BusinessType.DELETE)
+@Log(title='字典数据', business_type=BusinessType.DELETE)
 async def delete_system_dict_data(request: Request, dict_codes: str, query_db: AsyncSession = Depends(get_db)):
     delete_dict_data = DeleteDictDataModel(dictCodes=dict_codes)
     delete_dict_data_result = await DictDataService.delete_dict_data_services(request, query_db, delete_dict_data)
@@ -223,7 +223,7 @@ async def query_detail_system_dict_data(request: Request, dict_code: int, query_
 
 
 @dictController.post('/data/export', dependencies=[Depends(CheckUserInterfaceAuth('system:dict:export'))])
-@log_decorator(title='字典管理', business_type=BusinessType.EXPORT)
+@Log(title='字典数据', business_type=BusinessType.EXPORT)
 async def export_system_dict_data_list(
     request: Request,
     dict_data_page_query: DictDataPageQueryModel = Depends(DictDataPageQueryModel.as_form),

ruoyi-fastapi-backend/module_admin/controller/job_controller.py

@@ -4,7 +4,7 @@ from pydantic_validation_decorator import ValidateFields
 from sqlalchemy.ext.asyncio import AsyncSession
 from config.enums import BusinessType
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.entity.vo.job_vo import (
     DeleteJobLogModel,
@@ -44,7 +44,7 @@ async def get_system_job_list(
 
 @jobController.post('/job', dependencies=[Depends(CheckUserInterfaceAuth('monitor:job:add'))])
 @ValidateFields(validate_model='add_job')
-@log_decorator(title='定时任务管理', business_type=BusinessType.INSERT)
+@Log(title='定时任务', business_type=BusinessType.INSERT)
 async def add_system_job(
     request: Request,
     add_job: JobModel,
@@ -63,7 +63,7 @@ async def add_system_job(
 
 @jobController.put('/job', dependencies=[Depends(CheckUserInterfaceAuth('monitor:job:edit'))])
 @ValidateFields(validate_model='edit_job')
-@log_decorator(title='定时任务管理', business_type=BusinessType.UPDATE)
+@Log(title='定时任务', business_type=BusinessType.UPDATE)
 async def edit_system_job(
     request: Request,
     edit_job: EditJobModel,
@@ -79,7 +79,7 @@ async def edit_system_job(
 
 
 @jobController.put('/job/changeStatus', dependencies=[Depends(CheckUserInterfaceAuth('monitor:job:changeStatus'))])
-@log_decorator(title='定时任务管理', business_type=BusinessType.UPDATE)
+@Log(title='定时任务', business_type=BusinessType.UPDATE)
 async def change_system_job_status(
     request: Request,
     change_job: EditJobModel,
@@ -100,7 +100,7 @@ async def change_system_job_status(
 
 
 @jobController.put('/job/run', dependencies=[Depends(CheckUserInterfaceAuth('monitor:job:changeStatus'))])
-@log_decorator(title='定时任务管理', business_type=BusinessType.UPDATE)
+@Log(title='定时任务', business_type=BusinessType.UPDATE)
 async def execute_system_job(request: Request, execute_job: JobModel, query_db: AsyncSession = Depends(get_db)):
     execute_job_result = await JobService.execute_job_once_services(query_db, execute_job)
     logger.info(execute_job_result.message)
@@ -109,7 +109,7 @@ async def execute_system_job(request: Request, execute_job: JobModel, query_db:
 
 
 @jobController.delete('/job/{job_ids}', dependencies=[Depends(CheckUserInterfaceAuth('monitor:job:remove'))])
-@log_decorator(title='定时任务管理', business_type=BusinessType.DELETE)
+@Log(title='定时任务', business_type=BusinessType.DELETE)
 async def delete_system_job(request: Request, job_ids: str, query_db: AsyncSession = Depends(get_db)):
     delete_job = DeleteJobModel(jobIds=job_ids)
     delete_job_result = await JobService.delete_job_services(query_db, delete_job)
@@ -129,7 +129,7 @@ async def query_detail_system_job(request: Request, job_id: int, query_db: Async
 
 
 @jobController.post('/job/export', dependencies=[Depends(CheckUserInterfaceAuth('monitor:job:export'))])
-@log_decorator(title='定时任务管理', business_type=BusinessType.EXPORT)
+@Log(title='定时任务', business_type=BusinessType.EXPORT)
 async def export_system_job_list(
     request: Request,
     job_page_query: JobPageQueryModel = Depends(JobPageQueryModel.as_form),
@@ -161,7 +161,7 @@ async def get_system_job_log_list(
 
 
 @jobController.delete('/jobLog/clean', dependencies=[Depends(CheckUserInterfaceAuth('monitor:job:remove'))])
-@log_decorator(title='定时任务日志管理', business_type=BusinessType.CLEAN)
+@Log(title='定时任务调度日志', business_type=BusinessType.CLEAN)
 async def clear_system_job_log(request: Request, query_db: AsyncSession = Depends(get_db)):
     clear_job_log_result = await JobLogService.clear_job_log_services(query_db)
     logger.info(clear_job_log_result.message)
@@ -170,7 +170,7 @@ async def clear_system_job_log(request: Request, query_db: AsyncSession = Depend
 
 
 @jobController.delete('/jobLog/{job_log_ids}', dependencies=[Depends(CheckUserInterfaceAuth('monitor:job:remove'))])
-@log_decorator(title='定时任务日志管理', business_type=BusinessType.DELETE)
+@Log(title='定时任务调度日志', business_type=BusinessType.DELETE)
 async def delete_system_job_log(request: Request, job_log_ids: str, query_db: AsyncSession = Depends(get_db)):
     delete_job_log = DeleteJobLogModel(jobLogIds=job_log_ids)
     delete_job_log_result = await JobLogService.delete_job_log_services(query_db, delete_job_log)
@@ -180,7 +180,7 @@ async def delete_system_job_log(request: Request, job_log_ids: str, query_db: As
 
 
 @jobController.post('/jobLog/export', dependencies=[Depends(CheckUserInterfaceAuth('monitor:job:export'))])
-@log_decorator(title='定时任务日志管理', business_type=BusinessType.EXPORT)
+@Log(title='定时任务调度日志', business_type=BusinessType.EXPORT)
 async def export_system_job_log_list(
     request: Request,
     job_log_page_query: JobLogPageQueryModel = Depends(JobLogPageQueryModel.as_form),

ruoyi-fastapi-backend/module_admin/controller/log_controller.py

@@ -2,7 +2,7 @@ from fastapi import APIRouter, Depends, Request
 from sqlalchemy.ext.asyncio import AsyncSession
 from config.enums import BusinessType
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.entity.vo.log_vo import (
     DeleteLoginLogModel,
@@ -42,7 +42,7 @@ async def get_system_operation_log_list(
 
 
 @logController.delete('/operlog/clean', dependencies=[Depends(CheckUserInterfaceAuth('monitor:operlog:remove'))])
-@log_decorator(title='操作日志管理', business_type=BusinessType.CLEAN)
+@Log(title='操作日志', business_type=BusinessType.CLEAN)
 async def clear_system_operation_log(request: Request, query_db: AsyncSession = Depends(get_db)):
     clear_operation_log_result = await OperationLogService.clear_operation_log_services(query_db)
     logger.info(clear_operation_log_result.message)
@@ -51,7 +51,7 @@ async def clear_system_operation_log(request: Request, query_db: AsyncSession =
 
 
 @logController.delete('/operlog/{oper_ids}', dependencies=[Depends(CheckUserInterfaceAuth('monitor:operlog:remove'))])
-@log_decorator(title='操作日志管理', business_type=BusinessType.DELETE)
+@Log(title='操作日志', business_type=BusinessType.DELETE)
 async def delete_system_operation_log(request: Request, oper_ids: str, query_db: AsyncSession = Depends(get_db)):
     delete_operation_log = DeleteOperLogModel(operIds=oper_ids)
     delete_operation_log_result = await OperationLogService.delete_operation_log_services(
@@ -63,7 +63,7 @@ async def delete_system_operation_log(request: Request, oper_ids: str, query_db:
 
 
 @logController.post('/operlog/export', dependencies=[Depends(CheckUserInterfaceAuth('monitor:operlog:export'))])
-@log_decorator(title='操作日志管理', business_type=BusinessType.EXPORT)
+@Log(title='操作日志', business_type=BusinessType.EXPORT)
 async def export_system_operation_log_list(
     request: Request,
     operation_log_page_query: OperLogPageQueryModel = Depends(OperLogPageQueryModel.as_form),
@@ -101,7 +101,7 @@ async def get_system_login_log_list(
 
 
 @logController.delete('/logininfor/clean', dependencies=[Depends(CheckUserInterfaceAuth('monitor:logininfor:remove'))])
-@log_decorator(title='登录日志管理', business_type=BusinessType.CLEAN)
+@Log(title='登录日志', business_type=BusinessType.CLEAN)
 async def clear_system_login_log(request: Request, query_db: AsyncSession = Depends(get_db)):
     clear_login_log_result = await LoginLogService.clear_login_log_services(query_db)
     logger.info(clear_login_log_result.message)
@@ -112,7 +112,7 @@ async def clear_system_login_log(request: Request, query_db: AsyncSession = Depe
 @logController.delete(
     '/logininfor/{info_ids}', dependencies=[Depends(CheckUserInterfaceAuth('monitor:logininfor:remove'))]
 )
-@log_decorator(title='登录日志管理', business_type=BusinessType.DELETE)
+@Log(title='登录日志', business_type=BusinessType.DELETE)
 async def delete_system_login_log(request: Request, info_ids: str, query_db: AsyncSession = Depends(get_db)):
     delete_login_log = DeleteLoginLogModel(infoIds=info_ids)
     delete_login_log_result = await LoginLogService.delete_login_log_services(query_db, delete_login_log)
@@ -124,7 +124,7 @@ async def delete_system_login_log(request: Request, info_ids: str, query_db: Asy
 @logController.get(
     '/logininfor/unlock/{user_name}', dependencies=[Depends(CheckUserInterfaceAuth('monitor:logininfor:unlock'))]
 )
-@log_decorator(title='登录日志管理', business_type=BusinessType.OTHER)
+@Log(title='账户解锁', business_type=BusinessType.OTHER)
 async def unlock_system_user(request: Request, user_name: str, query_db: AsyncSession = Depends(get_db)):
     unlock_user = UnlockUser(userName=user_name)
     unlock_user_result = await LoginLogService.unlock_user_services(request, unlock_user)
@@ -134,7 +134,7 @@ async def unlock_system_user(request: Request, user_name: str, query_db: AsyncSe
 
 
 @logController.post('/logininfor/export', dependencies=[Depends(CheckUserInterfaceAuth('monitor:logininfor:export'))])
-@log_decorator(title='登录日志管理', business_type=BusinessType.EXPORT)
+@Log(title='登录日志', business_type=BusinessType.EXPORT)
 async def export_system_login_log_list(
     request: Request,
     login_log_page_query: LoginLogPageQueryModel = Depends(LoginLogPageQueryModel.as_form),

ruoyi-fastapi-backend/module_admin/controller/login_controller.py

@@ -7,7 +7,7 @@ from typing import Optional
 from config.enums import BusinessType
 from config.env import AppConfig, JwtConfig, RedisInitKeyConfig
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.entity.vo.common_vo import CrudResponseModel
 from module_admin.entity.vo.login_vo import UserLogin, UserRegister, Token
 from module_admin.entity.vo.user_vo import CurrentUserModel, EditUserModel
@@ -21,7 +21,7 @@ loginController = APIRouter()
 
 
 @loginController.post('/login', response_model=Token)
-@log_decorator(title='用户登录', business_type=BusinessType.OTHER, log_type='login')
+@Log(title='用户登录', business_type=BusinessType.OTHER, log_type='login')
 async def login(
     request: Request, form_data: CustomOAuth2PasswordRequestForm = Depends(), query_db: AsyncSession = Depends(get_db)
 ):

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

@@ -5,7 +5,7 @@ from sqlalchemy.ext.asyncio import AsyncSession
 from typing import List
 from config.enums import BusinessType
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.entity.vo.menu_vo import DeleteMenuModel, MenuModel, MenuQueryModel
 from module_admin.entity.vo.user_vo import CurrentUserModel
@@ -60,7 +60,7 @@ async def get_system_menu_list(
 
 @menuController.post('', dependencies=[Depends(CheckUserInterfaceAuth('system:menu:add'))])
 @ValidateFields(validate_model='add_menu')
-@log_decorator(title='菜单管理', business_type=BusinessType.INSERT)
+@Log(title='菜单管理', business_type=BusinessType.INSERT)
 async def add_system_menu(
     request: Request,
     add_menu: MenuModel,
@@ -79,7 +79,7 @@ async def add_system_menu(
 
 @menuController.put('', dependencies=[Depends(CheckUserInterfaceAuth('system:menu:edit'))])
 @ValidateFields(validate_model='edit_menu')
-@log_decorator(title='菜单管理', business_type=BusinessType.UPDATE)
+@Log(title='菜单管理', business_type=BusinessType.UPDATE)
 async def edit_system_menu(
     request: Request,
     edit_menu: MenuModel,
@@ -95,7 +95,7 @@ async def edit_system_menu(
 
 
 @menuController.delete('/{menu_ids}', dependencies=[Depends(CheckUserInterfaceAuth('system:menu:remove'))])
-@log_decorator(title='菜单管理', business_type=BusinessType.DELETE)
+@Log(title='菜单管理', business_type=BusinessType.DELETE)
 async def delete_system_menu(request: Request, menu_ids: str, query_db: AsyncSession = Depends(get_db)):
     delete_menu = DeleteMenuModel(menuIds=menu_ids)
     delete_menu_result = await MenuService.delete_menu_services(query_db, delete_menu)

ruoyi-fastapi-backend/module_admin/controller/notice_controller.py

@@ -4,7 +4,7 @@ from pydantic_validation_decorator import ValidateFields
 from sqlalchemy.ext.asyncio import AsyncSession
 from config.enums import BusinessType
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.entity.vo.notice_vo import DeleteNoticeModel, NoticeModel, NoticePageQueryModel
 from module_admin.entity.vo.user_vo import CurrentUserModel
@@ -35,7 +35,7 @@ async def get_system_notice_list(
 
 @noticeController.post('', dependencies=[Depends(CheckUserInterfaceAuth('system:notice:add'))])
 @ValidateFields(validate_model='add_notice')
-@log_decorator(title='通知公告管理', business_type=BusinessType.INSERT)
+@Log(title='通知公告', business_type=BusinessType.INSERT)
 async def add_system_notice(
     request: Request,
     add_notice: NoticeModel,
@@ -54,7 +54,7 @@ async def add_system_notice(
 
 @noticeController.put('', dependencies=[Depends(CheckUserInterfaceAuth('system:notice:edit'))])
 @ValidateFields(validate_model='edit_notice')
-@log_decorator(title='通知公告管理', business_type=BusinessType.UPDATE)
+@Log(title='通知公告', business_type=BusinessType.UPDATE)
 async def edit_system_notice(
     request: Request,
     edit_notice: NoticeModel,
@@ -70,7 +70,7 @@ async def edit_system_notice(
 
 
 @noticeController.delete('/{notice_ids}', dependencies=[Depends(CheckUserInterfaceAuth('system:notice:remove'))])
-@log_decorator(title='通知公告管理', business_type=BusinessType.DELETE)
+@Log(title='通知公告', business_type=BusinessType.DELETE)
 async def delete_system_notice(request: Request, notice_ids: str, query_db: AsyncSession = Depends(get_db)):
     delete_notice = DeleteNoticeModel(noticeIds=notice_ids)
     delete_notice_result = await NoticeService.delete_notice_services(query_db, delete_notice)

ruoyi-fastapi-backend/module_admin/controller/online_controller.py

@@ -2,7 +2,7 @@ from fastapi import APIRouter, Depends, Request
 from sqlalchemy.ext.asyncio import AsyncSession
 from config.enums import BusinessType
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.entity.vo.online_vo import DeleteOnlineModel, OnlineQueryModel
 from module_admin.service.login_service import LoginService
@@ -31,7 +31,7 @@ async def get_monitor_online_list(
 
 
 @onlineController.delete('/{token_ids}', dependencies=[Depends(CheckUserInterfaceAuth('monitor:online:forceLogout'))])
-@log_decorator(title='在线用户', business_type=BusinessType.FORCE)
+@Log(title='在线用户', business_type=BusinessType.FORCE)
 async def delete_monitor_online(request: Request, token_ids: str, query_db: AsyncSession = Depends(get_db)):
     delete_online = DeleteOnlineModel(tokenIds=token_ids)
     delete_online_result = await OnlineService.delete_online_services(request, delete_online)

ruoyi-fastapi-backend/module_admin/controller/post_controler.py

@@ -4,7 +4,7 @@ from pydantic_validation_decorator import ValidateFields
 from sqlalchemy.ext.asyncio import AsyncSession
 from config.enums import BusinessType
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.service.login_service import LoginService
 from module_admin.service.post_service import PostService
@@ -36,7 +36,7 @@ async def get_system_post_list(
 
 @postController.post('', dependencies=[Depends(CheckUserInterfaceAuth('system:post:add'))])
 @ValidateFields(validate_model='add_post')
-@log_decorator(title='岗位管理', business_type=BusinessType.INSERT)
+@Log(title='岗位管理', business_type=BusinessType.INSERT)
 async def add_system_post(
     request: Request,
     add_post: PostModel,
@@ -55,7 +55,7 @@ async def add_system_post(
 
 @postController.put('', dependencies=[Depends(CheckUserInterfaceAuth('system:post:edit'))])
 @ValidateFields(validate_model='edit_post')
-@log_decorator(title='岗位管理', business_type=BusinessType.UPDATE)
+@Log(title='岗位管理', business_type=BusinessType.UPDATE)
 async def edit_system_post(
     request: Request,
     edit_post: PostModel,
@@ -71,7 +71,7 @@ async def edit_system_post(
 
 
 @postController.delete('/{post_ids}', dependencies=[Depends(CheckUserInterfaceAuth('system:post:remove'))])
-@log_decorator(title='岗位管理', business_type=BusinessType.DELETE)
+@Log(title='岗位管理', business_type=BusinessType.DELETE)
 async def delete_system_post(request: Request, post_ids: str, query_db: AsyncSession = Depends(get_db)):
     delete_post = DeletePostModel(postIds=post_ids)
     delete_post_result = await PostService.delete_post_services(query_db, delete_post)
@@ -91,7 +91,7 @@ async def query_detail_system_post(request: Request, post_id: int, query_db: Asy
 
 
 @postController.post('/export', dependencies=[Depends(CheckUserInterfaceAuth('system:post:export'))])
-@log_decorator(title='岗位管理', business_type=BusinessType.EXPORT)
+@Log(title='岗位管理', business_type=BusinessType.EXPORT)
 async def export_system_post_list(
     request: Request,
     post_page_query: PostPageQueryModel = Depends(PostPageQueryModel.as_form),

ruoyi-fastapi-backend/module_admin/controller/role_controller.py

@@ -4,7 +4,7 @@ from pydantic_validation_decorator import ValidateFields
 from sqlalchemy.ext.asyncio import AsyncSession
 from config.enums import BusinessType
 from config.get_db import get_db
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.data_scope import GetDataScope
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.entity.vo.dept_vo import DeptModel
@@ -57,7 +57,7 @@ async def get_system_role_list(
 
 @roleController.post('', dependencies=[Depends(CheckUserInterfaceAuth('system:role:add'))])
 @ValidateFields(validate_model='add_role')
-@log_decorator(title='角色管理', business_type=BusinessType.INSERT)
+@Log(title='角色管理', business_type=BusinessType.INSERT)
 async def add_system_role(
     request: Request,
     add_role: AddRoleModel,
@@ -76,7 +76,7 @@ async def add_system_role(
 
 @roleController.put('', dependencies=[Depends(CheckUserInterfaceAuth('system:role:edit'))])
 @ValidateFields(validate_model='edit_role')
-@log_decorator(title='角色管理', business_type=BusinessType.UPDATE)
+@Log(title='角色管理', business_type=BusinessType.UPDATE)
 async def edit_system_role(
     request: Request,
     edit_role: AddRoleModel,
@@ -96,7 +96,7 @@ async def edit_system_role(
 
 
 @roleController.put('/dataScope', dependencies=[Depends(CheckUserInterfaceAuth('system:role:edit'))])
-@log_decorator(title='角色管理', business_type=BusinessType.GRANT)
+@Log(title='角色管理', business_type=BusinessType.GRANT)
 async def edit_system_role_datascope(
     request: Request,
     role_data_scope: AddRoleModel,
@@ -122,7 +122,7 @@ async def edit_system_role_datascope(
 
 
 @roleController.delete('/{role_ids}', dependencies=[Depends(CheckUserInterfaceAuth('system:role:remove'))])
-@log_decorator(title='角色管理', business_type=BusinessType.DELETE)
+@Log(title='角色管理', business_type=BusinessType.DELETE)
 async def delete_system_role(
     request: Request,
     role_ids: str,
@@ -161,7 +161,7 @@ async def query_detail_system_role(
 
 
 @roleController.post('/export', dependencies=[Depends(CheckUserInterfaceAuth('system:role:export'))])
-@log_decorator(title='角色管理', business_type=BusinessType.EXPORT)
+@Log(title='角色管理', business_type=BusinessType.EXPORT)
 async def export_system_role_list(
     request: Request,
     role_page_query: RolePageQueryModel = Depends(RolePageQueryModel.as_form),
@@ -179,7 +179,7 @@ async def export_system_role_list(
 
 
 @roleController.put('/changeStatus', dependencies=[Depends(CheckUserInterfaceAuth('system:role:edit'))])
-@log_decorator(title='角色管理', business_type=BusinessType.UPDATE)
+@Log(title='角色管理', business_type=BusinessType.UPDATE)
 async def reset_system_role_status(
     request: Request,
     change_role: AddRoleModel,
@@ -242,7 +242,7 @@ async def get_system_unallocated_user_list(
 
 
 @roleController.put('/authUser/selectAll', dependencies=[Depends(CheckUserInterfaceAuth('system:role:edit'))])
-@log_decorator(title='角色管理', business_type=BusinessType.GRANT)
+@Log(title='角色管理', business_type=BusinessType.GRANT)
 async def add_system_role_user(
     request: Request,
     add_role_user: CrudUserRoleModel = Depends(CrudUserRoleModel.as_query),
@@ -259,7 +259,7 @@ async def add_system_role_user(
 
 
 @roleController.put('/authUser/cancel', dependencies=[Depends(CheckUserInterfaceAuth('system:role:edit'))])
-@log_decorator(title='角色管理', business_type=BusinessType.GRANT)
+@Log(title='角色管理', business_type=BusinessType.GRANT)
 async def cancel_system_role_user(
     request: Request, cancel_user_role: CrudUserRoleModel, query_db: AsyncSession = Depends(get_db)
 ):
@@ -270,7 +270,7 @@ async def cancel_system_role_user(
 
 
 @roleController.put('/authUser/cancelAll', dependencies=[Depends(CheckUserInterfaceAuth('system:role:edit'))])
-@log_decorator(title='角色管理', business_type=BusinessType.GRANT)
+@Log(title='角色管理', business_type=BusinessType.GRANT)
 async def batch_cancel_system_role_user(
     request: Request,
     batch_cancel_user_role: CrudUserRoleModel = Depends(CrudUserRoleModel.as_query),

ruoyi-fastapi-backend/module_admin/controller/user_controller.py

@@ -6,7 +6,7 @@ from typing import Optional, Union
 from pydantic_validation_decorator import ValidateFields
 from config.get_db import get_db
 from config.env import UploadConfig
-from module_admin.annotation.log_annotation import log_decorator
+from module_admin.annotation.log_annotation import Log
 from module_admin.aspect.data_scope import GetDataScope
 from module_admin.aspect.interface_auth import CheckUserInterfaceAuth
 from module_admin.entity.vo.dept_vo import DeptModel
@@ -72,7 +72,7 @@ async def get_system_user_list(
 
 @userController.post('', dependencies=[Depends(CheckUserInterfaceAuth('system:user:add'))])
 @ValidateFields(validate_model='add_user')
-@log_decorator(title='用户管理', business_type=BusinessType.INSERT)
+@Log(title='用户管理', business_type=BusinessType.INSERT)
 async def add_system_user(
     request: Request,
     add_user: AddUserModel,
@@ -97,7 +97,7 @@ async def add_system_user(
 
 @userController.put('', dependencies=[Depends(CheckUserInterfaceAuth('system:user:edit'))])
 @ValidateFields(validate_model='edit_user')
-@log_decorator(title='用户管理', business_type=BusinessType.UPDATE)
+@Log(title='用户管理', business_type=BusinessType.UPDATE)
 async def edit_system_user(
     request: Request,
     edit_user: EditUserModel,
@@ -121,7 +121,7 @@ async def edit_system_user(
 
 
 @userController.delete('/{user_ids}', dependencies=[Depends(CheckUserInterfaceAuth('system:user:remove'))])
-@log_decorator(title='用户管理', business_type=BusinessType.DELETE)
+@Log(title='用户管理', business_type=BusinessType.DELETE)
 async def delete_system_user(
     request: Request,
     user_ids: str,
@@ -146,7 +146,7 @@ async def delete_system_user(
 
 
 @userController.put('/resetPwd', dependencies=[Depends(CheckUserInterfaceAuth('system:user:resetPwd'))])
-@log_decorator(title='用户管理', business_type=BusinessType.UPDATE)
+@Log(title='用户管理', business_type=BusinessType.UPDATE)
 async def reset_system_user_pwd(
     request: Request,
     reset_user: EditUserModel,
@@ -171,7 +171,7 @@ async def reset_system_user_pwd(
 
 
 @userController.put('/changeStatus', dependencies=[Depends(CheckUserInterfaceAuth('system:user:edit'))])
-@log_decorator(title='用户管理', business_type=BusinessType.UPDATE)
+@Log(title='用户管理', business_type=BusinessType.UPDATE)
 async def change_system_user_status(
     request: Request,
     change_user: EditUserModel,
@@ -229,7 +229,7 @@ async def query_detail_system_user(
 
 
 @userController.post('/profile/avatar')
-@log_decorator(title='个人信息', business_type=BusinessType.UPDATE)
+@Log(title='个人信息', business_type=BusinessType.UPDATE)
 async def change_system_user_profile_avatar(
     request: Request,
     avatarfile: bytes = File(),
@@ -264,7 +264,7 @@ async def change_system_user_profile_avatar(
 
 
 @userController.put('/profile')
-@log_decorator(title='个人信息', business_type=BusinessType.UPDATE)
+@Log(title='个人信息', business_type=BusinessType.UPDATE)
 async def change_system_user_profile_info(
     request: Request,
     user_info: UserInfoModel,
@@ -288,7 +288,7 @@ async def change_system_user_profile_info(
 
 
 @userController.put('/profile/updatePwd')
-@log_decorator(title='个人信息', business_type=BusinessType.UPDATE)
+@Log(title='个人信息', business_type=BusinessType.UPDATE)
 async def reset_system_user_password(
     request: Request,
     reset_password: ResetPasswordModel = Depends(ResetPasswordModel.as_query),
@@ -309,7 +309,7 @@ async def reset_system_user_password(
 
 
 @userController.post('/importData', dependencies=[Depends(CheckUserInterfaceAuth('system:user:import'))])
-@log_decorator(title='用户管理', business_type=BusinessType.IMPORT)
+@Log(title='用户管理', business_type=BusinessType.IMPORT)
 async def batch_import_system_user(
     request: Request,
     file: UploadFile = File(...),
@@ -336,7 +336,7 @@ async def export_system_user_template(request: Request, query_db: AsyncSession =
 
 
 @userController.post('/export', dependencies=[Depends(CheckUserInterfaceAuth('system:user:export'))])
-@log_decorator(title='用户管理', business_type=BusinessType.EXPORT)
+@Log(title='用户管理', business_type=BusinessType.EXPORT)
 async def export_system_user_list(
     request: Request,
     user_page_query: UserPageQueryModel = Depends(UserPageQueryModel.as_form),
@@ -373,7 +373,7 @@ async def get_system_allocated_role_list(request: Request, user_id: int, query_d
     response_model=UserRoleResponseModel,
     dependencies=[Depends(CheckUserInterfaceAuth('system:user:edit'))],
 )
-@log_decorator(title='用户管理', business_type=BusinessType.GRANT)
+@Log(title='用户管理', business_type=BusinessType.GRANT)
 async def update_system_role_user(
     request: Request,
     user_id: int = Query(alias='userId'),