feat(params): 新增根据配置键获取参数接口并优化参数模型

- 新增根据配置键获取参数详情接口get_obj_by_key_controller
- 新增根据配置键获取参数值接口get_config_value_by_key_controller
- 修改参数名称、键名最大长度为500,添加参数状态字段status
- 修改ParamsCRUD中获取配置详情方法键名参数名称
- 规范参数接口日志输出,修正部分接口路径及权限标识
- 更新参数导出文件名及相关描述信息
- 新增演示模式相关系统参数配置数据,包括白名单、黑名单等
- 添加对应权限控制和异常处理机制
This commit is contained in:
zhangtao
2025-09-15 02:05:40 +08:00
parent 693a521c9b
commit 02fefc7aae
5 changed files with 161 additions and 23 deletions
@@ -30,7 +30,27 @@ async def get_type_detail_controller(
return SuccessResponse(data=result_dict, msg="获取参数详情成功")
@ConfigRouter.get("/list", summary="获取配置", description="获取配置")
@ParamsRouter.get("/key/{config_key}", summary="根据配置键获取参数详情", description="根据配置键获取参数详情")
async def get_obj_by_key_controller(
config_key: str = Path(..., description="配置键"),
auth: AuthSchema = Depends(AuthPermission(permissions=["system:param:query"]))
) -> JSONResponse:
result_dict = await ParamsService.get_obj_by_key_service(config_key=config_key, auth=auth)
logger.info(f"根据配置键获取参数详情成功 {config_key}")
return SuccessResponse(data=result_dict, msg="根据配置键获取参数详情成功")
@ParamsRouter.get("/value/{config_key}", summary="根据配置键获取参数值", description="根据配置键获取参数值")
async def get_config_value_by_key_controller(
config_key: str = Path(..., description="配置键"),
auth: AuthSchema = Depends(AuthPermission(permissions=["system:param:query"]))
) -> JSONResponse:
result_value = await ParamsService.get_config_value_by_key_service(config_key=config_key, auth=auth)
logger.info(f"根据配置键获取参数值成功 {config_key}")
return SuccessResponse(data=result_value, msg="根据配置键获取参数值成功")
@ParamsRouter.get("/list", summary="获取参数列表", description="获取参数列表")
async def get_obj_list_controller(
auth: AuthSchema = Depends(AuthPermission(permissions=["system:param:query"])),
page: PaginationQueryParams = Depends(),
@@ -38,11 +58,11 @@ async def get_obj_list_controller(
) -> JSONResponse:
result_dict_list = await ParamsService.get_obj_list_service(auth=auth, search=search, order_by=page.order_by)
result_dict = await PaginationService.get_page_obj(data_list= result_dict_list, page_no= page.page_no, page_size = page.page_size)
logger.info(f"获取配置成功")
return SuccessResponse(data=result_dict, msg="查询配置列表成功")
logger.info(f"获取参数列表成功")
return SuccessResponse(data=result_dict, msg="查询参数列表成功")
@ConfigRouter.post("/create", summary="创建参数", description="创建参数")
@ParamsRouter.post("/create", summary="创建参数", description="创建参数")
async def create_obj_controller(
data: ParamsCreateSchema,
redis: Redis = Depends(redis_getter),
@@ -53,7 +73,7 @@ async def create_obj_controller(
return SuccessResponse(data=result_dict, msg="创建参数成功")
@ConfigRouter.put("/update/{id}", summary="修改配置", description="修改配置")
@ParamsRouter.put("/update/{id}", summary="修改参数", description="修改参数")
async def update_objs_controller(
data: ParamsUpdateSchema,
id: int = Path(..., description="参数ID"),
@@ -61,11 +81,11 @@ async def update_objs_controller(
auth: AuthSchema = Depends(AuthPermission(permissions=["system:param:update"]))
) -> JSONResponse:
result_dict = await ParamsService.update_obj_service(auth=auth, redis=redis, id=id, data=data)
logger.info(f"更新配置成功 {result_dict}")
return SuccessResponse(data=result_dict, msg="更新配置成功")
logger.info(f"更新参数成功 {result_dict}")
return SuccessResponse(data=result_dict, msg="更新参数成功")
@ConfigRouter.delete("/delete", summary="删除参数", description="删除参数")
@ParamsRouter.delete("/delete", summary="删除参数", description="删除参数")
async def delete_obj_controller(
redis: Redis = Depends(redis_getter),
ids: list[int] = Body(..., description="ID列表"),
@@ -76,9 +96,9 @@ async def delete_obj_controller(
return SuccessResponse(msg="删除参数成功")
@ConfigRouter.post('/export', summary="导出参数", description="导出参数")
@ParamsRouter.post('/export', summary="导出参数", description="导出参数")
async def export_obj_list_controller(
search: ConfigQueryParams = Depends(),
search: ParamsQueryParams = Depends(),
auth: AuthSchema = Depends(AuthPermission(permissions=["system:param:export"]))
) -> StreamingResponse:
# 获取全量数据
@@ -90,12 +110,12 @@ async def export_obj_list_controller(
data=bytes2file_response(export_result),
media_type='application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
headers = {
'Content-Disposition': 'attachment; filename=config.xlsx'
'Content-Disposition': 'attachment; filename=params.xlsx'
}
)
@ConfigRouter.post("/upload", summary="上传文件", dependencies=[Depends(AuthPermission(permissions=["system:config:upload"]))])
@ParamsRouter.post("/upload", summary="上传文件", dependencies=[Depends(AuthPermission(permissions=["system:param:upload"]))])
async def upload_file_controller(
file: UploadFile,
request: Request
@@ -105,10 +125,10 @@ async def upload_file_controller(
return SuccessResponse(data=result_str, msg='上传文件成功')
@ConfigRouter.get("/info", summary="获取初始化缓存参数", description="获取初始化缓存参数")
@ParamsRouter.get("/info", summary="获取初始化缓存参数", description="获取初始化缓存参数")
async def get_init_obj_controller(
redis: Redis = Depends(redis_getter),
) -> JSONResponse:
result_dict = await ParamsService.get_init_config_service(redis=redis)
logger.info(f"获取初始化缓存参数成功 {result_dict}")
return SuccessResponse(data=result_dict, msg="获取初始化缓存参数成功")
return SuccessResponse(data=result_dict, msg="获取初始化缓存参数成功")
@@ -5,7 +5,7 @@ from typing import Dict, List, Optional, Sequence
from app.core.base_crud import CRUDBase
from ..auth.schema import AuthSchema
from .model import ParamsModel
from .schema import ParamsCreateSchema,ParamsUpdateSchema
from .schema import ParamsCreateSchema, ParamsUpdateSchema
class ParamsCRUD(CRUDBase[ParamsModel, ParamsCreateSchema, ParamsUpdateSchema]):
@@ -22,7 +22,7 @@ class ParamsCRUD(CRUDBase[ParamsModel, ParamsCreateSchema, ParamsUpdateSchema]):
async def get_obj_by_key_crud(self, key: str) -> Optional[ParamsModel]:
"""根据key获取配置管理型详情"""
return await self.get(key=key)
return await self.get(config_key=key)
async def get_obj_list_crud(self, search: Dict = None, order_by: List[Dict[str, str]] = None) -> Sequence[ParamsModel]:
"""获取配置管理型列表"""
@@ -8,11 +8,12 @@ from app.core.base_schema import BaseSchema
class ParamsCreateSchema(BaseModel):
"""配置创建模型"""
config_name: str = Field(..., max_length=255, description="参数名称")
config_key: str = Field(..., max_length=255, description="参数键名")
config_value: str = Field(..., max_length=255, description="参数键值")
config_type: bool = Field(..., description="系统内置((True:是 False:否))")
description: Optional[str] = Field(default=None, max_length=255, description="描述")
config_name: str = Field(..., max_length=500, description="参数名称")
config_key: str = Field(..., max_length=500, description="参数键名")
config_value: Optional[str] = Field(default=None, description="参数键值")
config_type: bool = Field(default=False, description="系统内置(True:是 False:否)")
status: bool = Field(default=True, description="状态(True:正常 False:停用)")
description: Optional[str] = Field(default=None, max_length=500, description="描述")
class ParamsUpdateSchema(ParamsCreateSchema):
@@ -30,6 +30,21 @@ class ParamsService:
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]:
@@ -198,4 +213,4 @@ class ParamsService:
logger.error(f"解析系统配置数据失败: {e}")
continue
return configs
return configs