PowLu/RuoYi-Vue3-FastAPI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

perf: 优化参数管理模块service层及异常处理

Browse Source
This commit is contained in:
insistence
2024-07-09 16:25:27 +08:00
parent 2fef16e58b
commit 2b19022e29
2 changed files with 55 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
ruoyi-fastapi-backend/module_admin/controller/config_controller.py
View File

@@ -18,121 +18,81 @@ configController = APIRouter(prefix='/system/config', dependencies=[Depends(Logi
@configController.get("/list", response_model=PageResponseModel, dependencies=[Depends(CheckUserInterfaceAuth('system:config:list'))]) @configController.get("/list", response_model=PageResponseModel, dependencies=[Depends(CheckUserInterfaceAuth('system:config:list'))])
async def get_system_config_list(request: Request, config_page_query: ConfigPageQueryModel = Depends(ConfigPageQueryModel.as_query), query_db: AsyncSession = Depends(get_db)): async def get_system_config_list(request: Request, config_page_query: ConfigPageQueryModel = Depends(ConfigPageQueryModel.as_query), query_db: AsyncSession = Depends(get_db)):
try: # 获取分页数据
# 获取分页数据 config_page_query_result = await ConfigService.get_config_list_services(query_db, config_page_query, is_page=True)
config_page_query_result = await ConfigService.get_config_list_services(query_db, config_page_query, is_page=True) logger.info('获取成功')
logger.info('获取成功')
return ResponseUtil.success(model_content=config_page_query_result) return ResponseUtil.success(model_content=config_page_query_result)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@configController.post("", dependencies=[Depends(CheckUserInterfaceAuth('system:config:add'))]) @configController.post("", dependencies=[Depends(CheckUserInterfaceAuth('system:config:add'))])
@ValidateFields(validate_model='add_config') @ValidateFields(validate_model='add_config')
@log_decorator(title='参数管理', business_type=BusinessType.INSERT) @log_decorator(title='参数管理', business_type=BusinessType.INSERT)
async def add_system_config(request: Request, add_config: ConfigModel, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)): async def add_system_config(request: Request, add_config: ConfigModel, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)):
try: add_config.create_by = current_user.user.user_name
add_config.create_by = current_user.user.user_name add_config.create_time = datetime.now()
add_config.create_time = datetime.now() add_config.update_by = current_user.user.user_name
add_config.update_by = current_user.user.user_name add_config.update_time = datetime.now()
add_config.update_time = datetime.now() add_config_result = await ConfigService.add_config_services(request, query_db, add_config)
add_config_result = await ConfigService.add_config_services(request, query_db, add_config) logger.info(add_config_result.message)
if add_config_result.is_success:
logger.info(add_config_result.message) return ResponseUtil.success(msg=add_config_result.message)
return ResponseUtil.success(msg=add_config_result.message)
else:
logger.warning(add_config_result.message)
return ResponseUtil.failure(msg=add_config_result.message)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@configController.put("", dependencies=[Depends(CheckUserInterfaceAuth('system:config:edit'))]) @configController.put("", dependencies=[Depends(CheckUserInterfaceAuth('system:config:edit'))])
@ValidateFields(validate_model='edit_config') @ValidateFields(validate_model='edit_config')
@log_decorator(title='参数管理', business_type=BusinessType.UPDATE) @log_decorator(title='参数管理', business_type=BusinessType.UPDATE)
async def edit_system_config(request: Request, edit_config: ConfigModel, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)): async def edit_system_config(request: Request, edit_config: ConfigModel, query_db: AsyncSession = Depends(get_db), current_user: CurrentUserModel = Depends(LoginService.get_current_user)):
try: edit_config.update_by = current_user.user.user_name
edit_config.update_by = current_user.user.user_name edit_config.update_time = datetime.now()
edit_config.update_time = datetime.now() edit_config_result = await ConfigService.edit_config_services(request, query_db, edit_config)
edit_config_result = await ConfigService.edit_config_services(request, query_db, edit_config) logger.info(edit_config_result.message)
if edit_config_result.is_success:
logger.info(edit_config_result.message) return ResponseUtil.success(msg=edit_config_result.message)
return ResponseUtil.success(msg=edit_config_result.message)
else:
logger.warning(edit_config_result.message)
return ResponseUtil.failure(msg=edit_config_result.message)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@configController.delete("/refreshCache", dependencies=[Depends(CheckUserInterfaceAuth('system:config:remove'))]) @configController.delete("/refreshCache", dependencies=[Depends(CheckUserInterfaceAuth('system:config:remove'))])
@log_decorator(title='参数管理', business_type=BusinessType.UPDATE) @log_decorator(title='参数管理', business_type=BusinessType.UPDATE)
async def refresh_system_config(request: Request, query_db: AsyncSession = Depends(get_db)): async def refresh_system_config(request: Request, query_db: AsyncSession = Depends(get_db)):
try: refresh_config_result = await ConfigService.refresh_sys_config_services(request, query_db)
refresh_config_result = await ConfigService.refresh_sys_config_services(request, query_db) logger.info(refresh_config_result.message)
if refresh_config_result.is_success:
logger.info(refresh_config_result.message) return ResponseUtil.success(msg=refresh_config_result.message)
return ResponseUtil.success(msg=refresh_config_result.message)
else:
logger.warning(refresh_config_result.message)
return ResponseUtil.failure(msg=refresh_config_result.message)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@configController.delete("/{config_ids}", dependencies=[Depends(CheckUserInterfaceAuth('system:config:remove'))]) @configController.delete("/{config_ids}", dependencies=[Depends(CheckUserInterfaceAuth('system:config:remove'))])
@log_decorator(title='参数管理', business_type=BusinessType.DELETE) @log_decorator(title='参数管理', business_type=BusinessType.DELETE)
async def delete_system_config(request: Request, config_ids: str, query_db: AsyncSession = Depends(get_db)): async def delete_system_config(request: Request, config_ids: str, query_db: AsyncSession = Depends(get_db)):
try: delete_config = DeleteConfigModel(configIds=config_ids)
delete_config = DeleteConfigModel(configIds=config_ids) delete_config_result = await ConfigService.delete_config_services(request, query_db, delete_config)
delete_config_result = await ConfigService.delete_config_services(request, query_db, delete_config) logger.info(delete_config_result.message)
if delete_config_result.is_success:
logger.info(delete_config_result.message) return ResponseUtil.success(msg=delete_config_result.message)
return ResponseUtil.success(msg=delete_config_result.message)
else:
logger.warning(delete_config_result.message)
return ResponseUtil.failure(msg=delete_config_result.message)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@configController.get("/{config_id}", response_model=ConfigModel, dependencies=[Depends(CheckUserInterfaceAuth('system:config:query'))]) @configController.get("/{config_id}", response_model=ConfigModel, dependencies=[Depends(CheckUserInterfaceAuth('system:config:query'))])
async def query_detail_system_config(request: Request, config_id: int, query_db: AsyncSession = Depends(get_db)): async def query_detail_system_config(request: Request, config_id: int, query_db: AsyncSession = Depends(get_db)):
try: config_detail_result = await ConfigService.config_detail_services(query_db, config_id)
config_detail_result = await ConfigService.config_detail_services(query_db, config_id) logger.info(f'获取config_id为{config_id}的信息成功')
logger.info(f'获取config_id为{config_id}的信息成功')
return ResponseUtil.success(data=config_detail_result) return ResponseUtil.success(data=config_detail_result)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@configController.get("/configKey/{config_key}") @configController.get("/configKey/{config_key}")
async def query_system_config(request: Request, config_key: str): async def query_system_config(request: Request, config_key: str):
try: # 获取全量数据
# 获取全量数据 config_query_result = await ConfigService.query_config_list_from_cache_services(request.app.state.redis, config_key)
config_query_result = await ConfigService.query_config_list_from_cache_services(request.app.state.redis, config_key) logger.info('获取成功')
logger.info('获取成功')
return ResponseUtil.success(msg=config_query_result) return ResponseUtil.success(msg=config_query_result)
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))
@configController.post("/export", dependencies=[Depends(CheckUserInterfaceAuth('system:config:export'))]) @configController.post("/export", dependencies=[Depends(CheckUserInterfaceAuth('system:config:export'))])
@log_decorator(title='参数管理', business_type=BusinessType.EXPORT) @log_decorator(title='参数管理', business_type=BusinessType.EXPORT)
async def export_system_config_list(request: Request, config_page_query: ConfigPageQueryModel = Depends(ConfigPageQueryModel.as_form), query_db: AsyncSession = Depends(get_db)): async def export_system_config_list(request: Request, config_page_query: ConfigPageQueryModel = Depends(ConfigPageQueryModel.as_form), query_db: AsyncSession = Depends(get_db)):
try: # 获取全量数据
# 获取全量数据 config_query_result = await ConfigService.get_config_list_services(query_db, config_page_query, is_page=False)
config_query_result = await ConfigService.get_config_list_services(query_db, config_page_query, is_page=False) config_export_result = await ConfigService.export_config_list_services(config_query_result)
config_export_result = await ConfigService.export_config_list_services(config_query_result) logger.info('导出成功')
logger.info('导出成功')
return ResponseUtil.streaming(data=bytes2file_response(config_export_result)) return ResponseUtil.streaming(data=bytes2file_response(config_export_result))
except Exception as e:
logger.exception(e)
return ResponseUtil.error(msg=str(e))

29
ruoyi-fastapi-backend/module_admin/service/config_service.py
View File

@@ -1,8 +1,9 @@
from fastapi import Request from fastapi import Request
from config.constant import CommonConstant
from config.env import RedisInitKeyConfig
from module_admin.dao.config_dao import * from module_admin.dao.config_dao import *
from module_admin.entity.vo.common_vo import CrudResponseModel from module_admin.entity.vo.common_vo import CrudResponseModel
from config.constant import CommonConstant
from config.env import RedisInitKeyConfig
from exceptions.exception import ServiceException
from utils.common_util import export_list2excel, CamelCaseUtil from utils.common_util import export_list2excel, CamelCaseUtil
@@ -77,19 +78,17 @@ class ConfigService:
:return: 新增参数配置校验结果 :return: 新增参数配置校验结果
""" """
if not await cls.check_config_key_unique_services(query_db, page_object): if not await cls.check_config_key_unique_services(query_db, page_object):
result = dict(is_success=False, message=f'新增参数{page_object.config_name}失败，参数键名已存在') raise ServiceException(message=f'新增参数{page_object.config_name}失败，参数键名已存在')
else: else:
try: try:
await ConfigDao.add_config_dao(query_db, page_object) await ConfigDao.add_config_dao(query_db, page_object)
await query_db.commit() await query_db.commit()
await request.app.state.redis.set(f"{RedisInitKeyConfig.SYS_CONFIG.get('key')}:{page_object.config_key}", page_object.config_value) await request.app.state.redis.set(f"{RedisInitKeyConfig.SYS_CONFIG.get('key')}:{page_object.config_key}", page_object.config_value)
result = dict(is_success=True, message='新增成功') return CrudResponseModel(is_success=True, message='新增成功')
except Exception as e: except Exception as e:
await query_db.rollback() await query_db.rollback()
raise e raise e
return CrudResponseModel(**result)
@classmethod @classmethod
async def edit_config_services(cls, request: Request, query_db: AsyncSession, page_object: ConfigModel): async def edit_config_services(cls, request: Request, query_db: AsyncSession, page_object: ConfigModel):
""" """
@@ -103,7 +102,7 @@ class ConfigService:
config_info = await cls.config_detail_services(query_db, page_object.config_id) config_info = await cls.config_detail_services(query_db, page_object.config_id)
if config_info.config_id: if config_info.config_id:
if not await cls.check_config_key_unique_services(query_db, page_object): if not await cls.check_config_key_unique_services(query_db, page_object):
result = dict(is_success=False, message=f'修改参数{page_object.config_name}失败，参数键名已存在') raise ServiceException(message=f'修改参数{page_object.config_name}失败，参数键名已存在')
else: else:
try: try:
await ConfigDao.edit_config_dao(query_db, edit_config) await ConfigDao.edit_config_dao(query_db, edit_config)
@@ -111,14 +110,12 @@ class ConfigService:
if config_info.config_key != page_object.config_key: if config_info.config_key != page_object.config_key:
await request.app.state.redis.delete(f"{RedisInitKeyConfig.SYS_CONFIG.get('key')}:{config_info.config_key}") await request.app.state.redis.delete(f"{RedisInitKeyConfig.SYS_CONFIG.get('key')}:{config_info.config_key}")
await request.app.state.redis.set(f"{RedisInitKeyConfig.SYS_CONFIG.get('key')}:{page_object.config_key}", page_object.config_value) await request.app.state.redis.set(f"{RedisInitKeyConfig.SYS_CONFIG.get('key')}:{page_object.config_key}", page_object.config_value)
result = dict(is_success=True, message='更新成功') return CrudResponseModel(is_success=True, message='更新成功')
except Exception as e: except Exception as e:
await query_db.rollback() await query_db.rollback()
raise e raise e
else: else:
result = dict(is_success=False, message='参数配置不存在') raise ServiceException(message='参数配置不存在')
return CrudResponseModel(**result)
@classmethod @classmethod
async def delete_config_services(cls, request: Request, query_db: AsyncSession, page_object: DeleteConfigModel): async def delete_config_services(cls, request: Request, query_db: AsyncSession, page_object: DeleteConfigModel):
@@ -136,20 +133,19 @@ class ConfigService:
for config_id in config_id_list: for config_id in config_id_list:
config_info = await cls.config_detail_services(query_db, int(config_id)) config_info = await cls.config_detail_services(query_db, int(config_id))
if config_info.config_type == CommonConstant.YES: if config_info.config_type == CommonConstant.YES:
return CrudResponseModel(is_success=False, message=f'内置参数{config_info.config_key}不能删除') raise ServiceException(message=f'内置参数{config_info.config_key}不能删除')
else: else:
await ConfigDao.delete_config_dao(query_db, ConfigModel(configId=int(config_id))) await ConfigDao.delete_config_dao(query_db, ConfigModel(configId=int(config_id)))
delete_config_key_list.append(f"{RedisInitKeyConfig.SYS_CONFIG.get('key')}:{config_info.config_key}") delete_config_key_list.append(f"{RedisInitKeyConfig.SYS_CONFIG.get('key')}:{config_info.config_key}")
await query_db.commit() await query_db.commit()
if delete_config_key_list: if delete_config_key_list:
await request.app.state.redis.delete(*delete_config_key_list) await request.app.state.redis.delete(*delete_config_key_list)
result = dict(is_success=True, message='删除成功') return CrudResponseModel(is_success=True, message='删除成功')
except Exception as e: except Exception as e:
await query_db.rollback() await query_db.rollback()
raise e raise e
else: else:
result = dict(is_success=False, message='传入参数配置id为空') raise ServiceException(message='传入参数配置id为空')
return CrudResponseModel(**result)
@classmethod @classmethod
async def config_detail_services(cls, query_db: AsyncSession, config_id: int): async def config_detail_services(cls, query_db: AsyncSession, config_id: int):
@@ -209,6 +205,5 @@ class ConfigService:
:return: 刷新字典缓存校验结果 :return: 刷新字典缓存校验结果
""" """
await cls.init_cache_sys_config_services(query_db, request.app.state.redis) await cls.init_cache_sys_config_services(query_db, request.app.state.redis)
result = dict(is_success=True, message='刷新成功')
return CrudResponseModel(**result) return CrudResponseModel(is_success=True, message='刷新成功')