feat: 后端配置文件新增IP归属区域查询开关配置

ruoyi-fastapi-backend/.env.dev

@@ -13,6 +13,8 @@ APP_PORT = 9099
 APP_VERSION= '1.0.3'
 # 应用是否开启热重载
 APP_RELOAD = true
+# 应用是否开启IP归属区域查询
+APP_IP_LOCATION_QUERY = true
 
 # -------- Jwt配置 --------
 # Jwt秘钥

ruoyi-fastapi-backend/.env.prod

@@ -13,6 +13,8 @@ APP_PORT = 9099
 APP_VERSION= '1.0.3'
 # 应用是否开启热重载
 APP_RELOAD = false
+# 应用是否开启IP归属区域查询
+APP_IP_LOCATION_QUERY = true
 
 # -------- Jwt配置 --------
 # Jwt秘钥

ruoyi-fastapi-backend/config/env.py

@@ -17,6 +17,7 @@ class AppSettings(BaseSettings):
     app_port: int = 9099
     app_version: str = '1.0.0'
     app_reload: bool = True
+    app_ip_location_query: bool = True
 
 
 class JwtSettings(BaseSettings):

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

@@ -12,6 +12,7 @@ from typing import Optional
 from module_admin.service.login_service import LoginService
 from module_admin.service.log_service import OperationLogService, LoginLogService
 from module_admin.entity.vo.log_vo import OperLogModel, LogininforModel
+from config.env import AppConfig
 
 
 def log_decorator(title: str, business_type: int, log_type: Optional[str] = 'operation'):
@@ -50,126 +51,126 @@ def log_decorator(title: str, business_type: int, log_type: Optional[str] = 'ope
             # 获取请求的ip及ip归属区域
             oper_ip = request.headers.get("X-Forwarded-For")
             oper_location = '内网IP'
-            try:
-                if oper_ip != '127.0.0.1' and oper_ip != 'localhost':
-                    ip_result = requests.get(f'https://qifu-api.baidubce.com/ip/geo/v1/district?ip={oper_ip}')
-                    if ip_result.status_code == 200:
-                        prov = ip_result.json().get('data').get('prov')
-                        city = ip_result.json().get('data').get('city')
-                        if prov or city:
-                            oper_location = f'{prov}-{city}'
+            if AppConfig.app_ip_location_query:
+                try:
+                    if oper_ip != '127.0.0.1' and oper_ip != 'localhost':
+                        ip_result = requests.get(f'https://qifu-api.baidubce.com/ip/geo/v1/district?ip={oper_ip}')
+                        if ip_result.status_code == 200:
+                            prov = ip_result.json().get('data').get('prov')
+                            city = ip_result.json().get('data').get('city')
+                            if prov or city:
+                                oper_location = f'{prov}-{city}'
+                            else:
+                                oper_location = '未知'
                         else:
                             oper_location = '未知'
-                    else:
-                        oper_location = '未知'
-            except Exception as e:
-                oper_location = '未知'
-                print(e)
-            finally:
-                # 根据不同的请求类型使用不同的方法获取请求参数
-                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 = '请求参数过长'
+                except Exception as e:
+                    oper_location = '未知'
+                    print(e)
+            # 根据不同的请求类型使用不同的方法获取请求参数
+            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 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'))
+            # 获取操作时间
+            oper_time = datetime.now()
+            # 此处在登录之前向原始函数传递一些登录信息，用于监测在线用户的相关信息
+            login_log = {}
+            if 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 request_from_swagger or request_from_redoc:
-                        result_dict = {}
+                    if result.status_code == 200:
+                        result_dict = {'code': result.status_code, 'message': '获取成功'}
                     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
+                        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 log_type == 'login':
+                # 登录请求来自于api文档时不记录登录日志，其余情况则记录
+                if request_from_swagger or request_from_redoc:
+                    pass
                 else:
-                    error_msg = result_dict.get('msg')
-                # 根据日志类型向对应的日志表插入数据
-                if 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')
+                    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')
 
-                        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=title,
-                        businessType=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)
-                    )
-                    OperationLogService.add_operation_log_services(query_db, operation_log)
+                    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=title,
+                    businessType=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)
+                )
+                OperationLogService.add_operation_log_services(query_db, operation_log)
 
-                return result
+            return result
 
         return wrapper