mirror of
https://github.com/fastapiadmin/FastapiAdmin.git
synced 2026-09-20 20:39:55 +00:00
- 新增根据配置键获取参数详情接口get_obj_by_key_controller - 新增根据配置键获取参数值接口get_config_value_by_key_controller - 修改参数名称、键名最大长度为500,添加参数状态字段status - 修改ParamsCRUD中获取配置详情方法键名参数名称 - 规范参数接口日志输出,修正部分接口路径及权限标识 - 更新参数导出文件名及相关描述信息 - 新增演示模式相关系统参数配置数据,包括白名单、黑名单等 - 添加对应权限控制和异常处理机制
216 lines
9.2 KiB
Python
216 lines
9.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
import json
|
|
from typing import Any, Dict, List
|
|
|
|
from redis.asyncio.client import Redis
|
|
from fastapi import UploadFile
|
|
from redis.asyncio.client import Redis
|
|
|
|
from app.common.enums import RedisInitKeyConfig
|
|
from app.core.database import AsyncSessionLocal
|
|
from app.core.redis_crud import RedisCURD
|
|
from app.utils.excel_util import ExcelUtil
|
|
from app.utils.upload_util import UploadUtil
|
|
from app.core.base_schema import UploadResponseSchema
|
|
from app.core.exceptions import CustomException
|
|
from app.core.logger import logger
|
|
from ..auth.schema import AuthSchema
|
|
from .param import ParamsQueryParams
|
|
from .schema import ParamsOutSchema, ParamsUpdateSchema, ParamsCreateSchema, UpdateSystemParamsSchema
|
|
from .crud import ParamsCRUD
|
|
|
|
|
|
class ParamsService:
|
|
"""
|
|
配置管理模块服务层
|
|
"""
|
|
@classmethod
|
|
async def get_obj_detail_service(cls, auth: AuthSchema, id: int) -> Dict:
|
|
obj = await ParamsCRUD(auth).get_obj_by_id_crud(id=id)
|
|
return ParamsOutSchema.model_validate(obj).model_dump()
|
|
|
|
@classmethod
|
|
async def get_obj_by_key_service(cls, auth: AuthSchema, config_key: str) -> Dict:
|
|
"""根据配置键获取配置详情"""
|
|
obj = await ParamsCRUD(auth).get_obj_by_key_crud(key=config_key)
|
|
if not obj:
|
|
raise CustomException(msg=f'配置键 {config_key} 不存在')
|
|
return ParamsOutSchema.model_validate(obj).model_dump()
|
|
|
|
@classmethod
|
|
async def get_config_value_by_key_service(cls, auth: AuthSchema, config_key: str) -> str:
|
|
"""根据配置键获取配置值"""
|
|
obj = await ParamsCRUD(auth).get_obj_by_key_crud(key=config_key)
|
|
if not obj:
|
|
raise CustomException(msg=f'配置键 {config_key} 不存在')
|
|
return obj.config_value
|
|
|
|
@classmethod
|
|
async def get_obj_list_service(cls, auth: AuthSchema, search: ParamsQueryParams = None, order_by: List[Dict[str, str]] = None) -> List[Dict]:
|
|
if order_by:
|
|
order_by = eval(order_by)
|
|
obj_list = None
|
|
if search:
|
|
obj_list = await ParamsCRUD(auth).get_obj_list_crud(search=search.__dict__, order_by=order_by)
|
|
else:
|
|
obj_list = await ParamsCRUD(auth).get_obj_list_crud()
|
|
return [ParamsOutSchema.model_validate(obj).model_dump() for obj in obj_list]
|
|
|
|
@classmethod
|
|
async def create_obj_service(cls, auth: AuthSchema, redis: Redis, data: ParamsCreateSchema) -> Dict:
|
|
exist_obj = await ParamsCRUD(auth).get(config_key=data.config_key)
|
|
if exist_obj:
|
|
raise CustomException(msg='创建失败,该配置key已存在')
|
|
obj = await ParamsCRUD(auth).create_obj_crud(data=data)
|
|
|
|
new_obj_dict = ParamsOutSchema.model_validate(obj).model_dump()
|
|
|
|
# 同步redis
|
|
redis_key = f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:{data.config_key}"
|
|
try:
|
|
result = await RedisCURD(redis).set(
|
|
key=redis_key,
|
|
value="",
|
|
)
|
|
if not result:
|
|
logger.error(f"同步配置到缓存失败: {new_obj_dict}")
|
|
raise CustomException(msg="同步配置到缓存失败")
|
|
except Exception as e:
|
|
logger.error(f"创建字典类型失败: {e}")
|
|
raise CustomException(msg=f"创建字典类型失败 {e}")
|
|
|
|
return new_obj_dict
|
|
|
|
@classmethod
|
|
async def update_obj_service(cls, auth: AuthSchema, redis: Redis, id:int, data: ParamsUpdateSchema) -> Dict:
|
|
exist_obj = await ParamsCRUD(auth).get_obj_by_id_crud(id=id)
|
|
if not exist_obj:
|
|
raise CustomException(msg='更新失败,该数系统配置不存在')
|
|
if exist_obj.config_key != data.config_key:
|
|
raise CustomException(msg='更新失败,系统配置key不允许修改')
|
|
|
|
new_obj = await ParamsCRUD(auth).update_obj_crud(id=id, data=data)
|
|
new_obj_dict = ParamsOutSchema.model_validate(new_obj).model_dump()
|
|
|
|
# 同步redis
|
|
redis_key = f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:{new_obj.config_key}"
|
|
try:
|
|
value = json.dumps(new_obj_dict, ensure_ascii=False)
|
|
result = await RedisCURD(redis).set(
|
|
key=redis_key,
|
|
value=value,
|
|
)
|
|
if not result:
|
|
logger.error(f"同步配置到缓存失败: {new_obj_dict}")
|
|
raise CustomException(msg="同步配置到缓存失败")
|
|
except Exception as e:
|
|
logger.error(f"更新系统配置失败: {e}")
|
|
raise CustomException(msg="更新系统配置失败")
|
|
|
|
return new_obj_dict
|
|
|
|
@classmethod
|
|
async def delete_obj_service(cls, auth: AuthSchema, redis: Redis, ids: list[int]) -> None:
|
|
if len(ids) < 1:
|
|
raise CustomException(msg='删除失败,删除对象不能为空')
|
|
for id in ids:
|
|
exist_obj = await ParamsCRUD(auth).get_obj_by_id_crud(id=id)
|
|
if not exist_obj:
|
|
raise CustomException(msg='删除失败,该数据字典类型不存在')
|
|
# 检查是否是否初始化类型
|
|
if exist_obj.config_type:
|
|
# 如果有字典数据,不能删除
|
|
raise CustomException(msg=f'{exist_obj.config_name} 删除失败,系统初始化配置不可以删除')
|
|
|
|
await ParamsCRUD(auth).delete_obj_crud(ids=ids)
|
|
# 同步删除Redis缓存
|
|
redis_key = f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:{exist_obj.config_key}"
|
|
try:
|
|
await RedisCURD(redis).delete(redis_key)
|
|
logger.info(f"删除系统配置成功: {id}")
|
|
except Exception as e:
|
|
logger.error(f"删除系统配置失败: {e}")
|
|
raise CustomException(msg="删除字典类型失败")
|
|
|
|
@classmethod
|
|
async def export_obj_service(cls, data_list: List[Dict[str, Any]]) -> bytes:
|
|
"""导出系统配置列表"""
|
|
mapping_dict = {
|
|
'id': '编号',
|
|
'config_name': '参数名称',
|
|
'config_key': '参数键名',
|
|
'config_value': '参数键值',
|
|
'config_type': '系统内置((True:是 False:否))',
|
|
'description': '备注',
|
|
'created_at': '创建时间',
|
|
'updated_at': '更新时间',
|
|
'creator_id': '创建者ID',
|
|
'creator': '创建者',
|
|
}
|
|
|
|
# 复制数据并转换状态
|
|
data = data_list.copy()
|
|
for item in data:
|
|
# 处理状态
|
|
item['config_type'] = '是' if item.get('config_type') else '否'
|
|
item['creator'] = item.get('creator', {}).get('name', '未知') if isinstance(item.get('creator'), dict) else '未知'
|
|
|
|
return ExcelUtil.export_list2excel(list_data=data, mapping_dict=mapping_dict)
|
|
|
|
@classmethod
|
|
async def upload_service(cls, base_url: str, file: UploadFile) -> Dict:
|
|
"""上传文件"""
|
|
if not file:
|
|
raise CustomException(msg="请选择要上传的文件")
|
|
filename, filepath, file_url = await UploadUtil.upload_file(file=file, base_url=base_url)
|
|
|
|
return UploadResponseSchema(
|
|
file_path=f'{filepath}',
|
|
file_name=filename,
|
|
origin_name=file.filename,
|
|
file_url=f'{file_url}',
|
|
).model_dump()
|
|
|
|
@classmethod
|
|
async def init_config_service(cls, redis: Redis) -> bool:
|
|
async with AsyncSessionLocal() as session:
|
|
async with session.begin():
|
|
auth = AuthSchema(db=session)
|
|
config_obj = await ParamsCRUD(auth).get_obj_list_crud()
|
|
if not config_obj:
|
|
raise CustomException(msg="系统配置不存在")
|
|
try:
|
|
# 保存到Redis并设置过期时间
|
|
for config in config_obj:
|
|
redis_key = (f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:{config.config_key}")
|
|
config_obj_dict = ParamsOutSchema.model_validate(config).model_dump()
|
|
value = json.dumps(config_obj_dict, ensure_ascii=False)
|
|
result = await RedisCURD(redis).set(
|
|
key=redis_key,
|
|
value=value,
|
|
)
|
|
if not result:
|
|
logger.error(f"初始化系统配置失败: {config_obj_dict}")
|
|
raise CustomException(msg="初始化系统配置失败")
|
|
except Exception as e:
|
|
logger.error(f"初始化系统配置失败: {e}")
|
|
raise CustomException(msg="初始化系统配置失败")
|
|
|
|
@classmethod
|
|
async def get_init_config_service(cls, redis: Redis) -> Dict:
|
|
"""获取系统配置"""
|
|
redis_keys = await RedisCURD(redis).get_keys(f"{RedisInitKeyConfig.SYSTEM_CONFIG.key}:*")
|
|
redis_configs = await RedisCURD(redis).mget(*redis_keys)
|
|
configs = []
|
|
for config in redis_configs:
|
|
if not config:
|
|
continue
|
|
try:
|
|
new_config = json.loads(config)
|
|
configs.append(new_config)
|
|
except Exception as e:
|
|
logger.error(f"解析系统配置数据失败: {e}")
|
|
continue
|
|
|
|
return configs |