Files
FastapiAdmin/backend/app/api/v1/module_system/dict/service.py
T
zhangtao fce6333722 style: 优化代码格式和导入顺序
refactor: 重构数据库连接模块,提高可维护性

docs: 更新README.md项目描述

style: 调整日志输出格式和内容

refactor: 优化中间件日志记录逻辑

style: 统一代码中的空行和导入顺序

refactor: 分离数据库引擎和会话创建逻辑

style: 清理未使用的导入和代码

refactor: 重命名数据库会话变量

style: 调整jinja2模板变量命名

refactor: 优化异常处理和日志记录

style: 统一字符串格式化方式

refactor: 优化redis连接错误处理

style: 调整注释格式和位置

refactor: 优化数据库连接配置

style: 清理多余空行和注释
2025-11-16 18:43:30 +08:00

509 lines
20 KiB
Python

# -*- coding: utf-8 -*-
import json
from typing import Any, List, Dict, Optional
from redis.asyncio.client import Redis
from app.common.enums import RedisInitKeyConfig
from app.utils.excel_util import ExcelUtil
from app.core.database import async_db_session
from app.core.base_schema import BatchSetAvailable
from app.core.redis_crud import RedisCURD
from app.core.exceptions import CustomException
from app.core.logger import logger
from app.api.v1.module_system.auth.schema import AuthSchema
from .schema import DictDataCreateSchema,DictDataOutSchema,DictDataUpdateSchema,DictTypeCreateSchema,DictTypeOutSchema,DictTypeUpdateSchema
from .param import DictDataQueryParam, DictTypeQueryParam
from .crud import DictDataCRUD, DictTypeCRUD
class DictTypeService:
"""
字典类型管理模块服务层
"""
@classmethod
async def get_obj_detail_service(cls, auth: AuthSchema, id: int) -> Dict:
"""
获取数据字典类型详情
参数:
- auth (AuthSchema): 认证信息模型
- id (int): 数据字典类型ID
返回:
- Dict: 数据字典类型详情字典
"""
obj = await DictTypeCRUD(auth).get_obj_by_id_crud(id=id)
return DictTypeOutSchema.model_validate(obj).model_dump()
@classmethod
async def get_obj_list_service(cls, auth: AuthSchema, search: Optional[DictTypeQueryParam] = None, order_by: Optional[List[Dict[str, str]]] = None) -> List[Dict]:
"""
获取数据字典类型列表
参数:
- auth (AuthSchema): 认证信息模型
- search (DictTypeQueryParam | None): 搜索条件模型
- order_by (List[Dict[str, str]] | None): 排序字段列表
返回:
- List[Dict]: 数据字典类型详情字典列表
"""
obj_list = await DictTypeCRUD(auth).get_obj_list_crud(search=search.__dict__, order_by=order_by)
return [DictTypeOutSchema.model_validate(obj).model_dump() for obj in obj_list]
@classmethod
async def create_obj_service(cls, auth: AuthSchema, redis: Redis, data: DictTypeCreateSchema) -> Dict:
"""
创建数据字典类型
参数:
- auth (AuthSchema): 认证信息模型
- redis (Redis): Redis客户端
- data (DictTypeCreateSchema): 数据字典类型创建模型
返回:
- Dict: 数据字典类型详情字典
"""
exist_obj = await DictTypeCRUD(auth).get(dict_name=data.dict_name)
if exist_obj:
raise CustomException(msg='创建失败,该数据字典类型已存在')
obj = await DictTypeCRUD(auth).create_obj_crud(data=data)
new_obj_dict = DictTypeOutSchema.model_validate(obj).model_dump()
redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{data.dict_type}"
try:
await RedisCURD(redis).set(
key=redis_key,
value="",
)
logger.info(f"创建字典类型成功: {new_obj_dict}")
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: DictTypeUpdateSchema) -> Dict:
"""
更新数据字典类型
参数:
- auth (AuthSchema): 认证信息模型
- redis (Redis): Redis客户端
- id (int): 数据字典类型ID
- data (DictTypeUpdateSchema): 数据字典类型更新模型
返回:
- Dict: 数据字典类型详情字典
"""
exist_obj = await DictTypeCRUD(auth).get_obj_by_id_crud(id=id)
if not exist_obj:
raise CustomException(msg='更新失败,该数据字典类型不存在')
if exist_obj.dict_name != data.dict_name:
raise CustomException(msg='更新失败,数据字典类型名称不可以修改')
dict_data_list = []
# 如果字典类型修改或状态变更,则修改对应字典数据的类型和状态,并更新Redis缓存
if exist_obj.dict_type != data.dict_type or exist_obj.status != data.status:
# 检查字典数据类型是否被修改
exist_obj_type_list = await DictDataCRUD(auth).list(search={'dict_type': exist_obj.dict_type})
if exist_obj_type_list:
for item in exist_obj_type_list:
item.dict_type = data.dict_type
dict_data = DictDataUpdateSchema(
dict_sort=item.dict_sort,
dict_label=item.dict_label,
dict_value=item.dict_value,
dict_type=data.dict_type,
css_class=item.css_class,
list_class=item.list_class,
is_default=item.is_default,
status=data.status,
description=item.description
)
obj = await DictDataCRUD(auth).update_obj_crud(id=item.id, data=dict_data)
dict_data_list.append(DictDataOutSchema.model_validate(obj).model_dump())
obj = await DictTypeCRUD(auth).update_obj_crud(id=id, data=data)
new_obj_dict = DictTypeOutSchema.model_validate(obj).model_dump()
redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{data.dict_type}"
try:
# 获取当前字典类型的所有字典数据,确保包含最新状态
dict_data_list = await DictDataCRUD(auth).get_obj_list_crud(search={'dict_type': data.dict_type})
dict_data = [DictDataOutSchema.model_validate(row).model_dump() for row in dict_data_list if row]
value = json.dumps(dict_data, ensure_ascii=False)
await RedisCURD(redis).set(
key=redis_key,
value=value,
)
logger.info(f"更新字典类型成功并刷新缓存: {new_obj_dict}")
except Exception as e:
logger.error(f"更新字典类型缓存失败: {e}")
raise CustomException(msg=f"更新字典类型缓存失败 {e}")
return new_obj_dict
@classmethod
async def delete_obj_service(cls, auth: AuthSchema, redis: Redis, ids: list[int]) -> None:
"""
删除数据字典类型
参数:
- auth (AuthSchema): 认证信息模型
- redis (Redis): Redis客户端
- ids (list[int]): 数据字典类型ID列表
返回:
- None
"""
if len(ids) < 1:
raise CustomException(msg='删除失败,删除对象不能为空')
for id in ids:
exist_obj = await DictTypeCRUD(auth).get_obj_by_id_crud(id=id)
if not exist_obj:
raise CustomException(msg='删除失败,该数据字典类型不存在')
# 检查是否有字典数据
exist_obj_type_list = await DictDataCRUD(auth).list(search={'dict_type': id})
if len(exist_obj_type_list) > 0:
# 如果有字典数据,不能删除
raise CustomException(msg='删除失败,该数据字典类型下存在字典数据')
# 删除Redis缓存
redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{exist_obj.dict_type}"
try:
await RedisCURD(redis).delete(redis_key)
logger.info(f"删除字典类型成功: {id}")
except Exception as e:
logger.error(f"删除字典类型失败: {e}")
raise CustomException(msg=f"删除字典类型失败")
await DictTypeCRUD(auth).delete_obj_crud(ids=ids)
@classmethod
async def set_obj_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None:
"""
设置数据字典类型状态
参数:
- auth (AuthSchema): 认证信息模型
- data (BatchSetAvailable): 批量设置状态模型
返回:
- None
"""
await DictTypeCRUD(auth).set_obj_available_crud(ids=data.ids, status=data.status)
@classmethod
async def export_obj_service(cls, data_list: List[Dict[str, Any]]) -> bytes:
"""
导出数据字典类型列表
参数:
- data_list (List[Dict[str, Any]]): 数据字典类型列表
返回:
- bytes: Excel文件字节流
"""
mapping_dict = {
'id': '编号',
'dict_name': '字典名称',
'dict_type': '字典类型',
'status': '状态',
'description': '备注',
'created_at': '创建时间',
'updated_at': '更新时间',
'creator_id': '创建者ID',
'creator': '创建者',
}
# 复制数据并转换状态
data = data_list.copy()
for item in data:
# 处理状态
item['status'] = '正常' if item.get('status') 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)
class DictDataService:
"""
字典数据管理模块服务层
"""
@classmethod
async def get_obj_detail_service(cls, auth: AuthSchema, id: int) -> Dict:
"""
获取数据字典数据详情
参数:
- auth (AuthSchema): 认证信息模型
- id (int): 数据字典数据ID
返回:
- Dict: 数据字典数据详情字典
"""
obj = await DictDataCRUD(auth).get_obj_by_id_crud(id=id)
return DictDataOutSchema.model_validate(obj).model_dump()
@classmethod
async def get_obj_list_service(cls, auth: AuthSchema, search: Optional[DictDataQueryParam] = None, order_by: Optional[List[Dict[str, str]]] = None) -> List[Dict]:
"""
获取数据字典数据列表
参数:
- auth (AuthSchema): 认证信息模型
- search (DictDataQueryParam | None): 搜索条件模型
- order_by (List[Dict[str, str]] | None): 排序字段列表
返回:
- List[Dict]: 数据字典数据详情字典列表
"""
obj_list = await DictDataCRUD(auth).get_obj_list_crud(search=search.__dict__, order_by=order_by)
return [DictDataOutSchema.model_validate(obj).model_dump() for obj in obj_list]
@classmethod
async def init_dict_service(cls, redis: Redis):
"""
应用初始化: 获取所有字典类型对应的字典数据信息并缓存service
参数:
- redis (Redis): Redis客户端
返回:
- None
"""
async with async_db_session() as session:
async with session.begin():
auth = AuthSchema(db=session)
obj_list = await DictTypeCRUD(auth).get_obj_list_crud()
if not obj_list:
logger.warning("❗️ 未找到任何字典类型数据")
return
for obj in obj_list:
dict_type = obj.dict_type
dict_data_list = await DictDataCRUD(auth).get_obj_list_crud(search={'dict_type': dict_type})
if not dict_data_list:
logger.warning(f"❗️ 字典类型 {dict_type} 未找到对应的字典数据")
continue
dict_data = [DictDataOutSchema.model_validate(row).model_dump() for row in dict_data_list if row]
# 保存到Redis并设置过期时间
redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{dict_type}"
try:
value = json.dumps(dict_data, ensure_ascii=False)
await RedisCURD(redis).set(
key=redis_key,
value=value,
)
except Exception as e:
logger.error(f"❌️ 初始化字典数据失败: {e}")
raise CustomException(msg=f"初始化字典数据失败 {e}")
@classmethod
async def get_init_dict_service(cls, redis: Redis, dict_type: str)->List[Dict]:
"""
从缓存获取字典数据列表信息service
参数:
- redis (Redis): Redis客户端
- dict_type (str): 字典类型
返回:
- List[Dict]: 字典数据列表
"""
redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{dict_type}"
obj_list_dict = await RedisCURD(redis).get(redis_key)
if not obj_list_dict:
raise CustomException(msg="数据字典不存在")
return obj_list_dict
@classmethod
async def create_obj_service(cls, auth: AuthSchema, redis: Redis, data: DictDataCreateSchema) -> Dict:
"""
创建数据字典数据
参数:
- auth (AuthSchema): 认证信息模型
- redis (Redis): Redis客户端
- data (DictDataCreateSchema): 数据字典数据创建模型
返回:
- Dict: 数据字典数据详情字典
"""
exist_obj = await DictDataCRUD(auth).get(dict_label=data.dict_label)
if exist_obj:
raise CustomException(msg='创建失败,该字典数据已存在')
obj = await DictDataCRUD(auth).create_obj_crud(data=data)
redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{data.dict_type}"
try:
# 获取当前字典类型的所有字典数据
dict_data_list = await DictDataCRUD(auth).get_obj_list_crud(search={'dict_type': data.dict_type})
dict_data = [DictDataOutSchema.model_validate(row).model_dump() for row in dict_data_list if row]
value = json.dumps(dict_data, ensure_ascii=False)
await RedisCURD(redis).set(
key=redis_key,
value=value,
)
logger.info(f"创建字典数据写入缓存成功: {obj}")
except Exception as e:
logger.error(f"创建字典数据写入缓存失败: {e}")
raise CustomException(msg=f"创建字典数据失败 {e}")
return DictDataOutSchema.model_validate(obj).model_dump()
@classmethod
async def update_obj_service(cls, auth: AuthSchema, redis: Redis, id:int, data: DictDataUpdateSchema) -> Dict:
"""
更新数据字典数据
参数:
- auth (AuthSchema): 认证信息模型
- redis (Redis): Redis客户端
- id (int): 数据字典数据ID
- data (DictDataUpdateSchema): 数据字典数据更新模型
返回:
- Dict: 数据字典数据详情字典
"""
exist_obj = await DictDataCRUD(auth).get_obj_by_id_crud(id=id)
if not exist_obj:
raise CustomException(msg='更新失败,该字典数据不存在')
if exist_obj.id != id:
raise CustomException(msg='更新失败,数据字典数据重复')
# 如果字典类型变更,仅刷新旧类型缓存,不联动字典类型状态
if exist_obj.dict_type != data.dict_type:
dict_type = await DictTypeCRUD(auth).get(dict_type=exist_obj.dict_type)
if dict_type:
redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{dict_type.dict_type}"
try:
dict_data_list = await DictDataCRUD(auth).get_obj_list_crud(search={'dict_type': dict_type.dict_type})
dict_data = [DictDataOutSchema.model_validate(row).model_dump() for row in dict_data_list if row]
value = json.dumps(dict_data, ensure_ascii=False)
await RedisCURD(redis).set(
key=redis_key,
value=value,
)
except Exception as e:
logger.error(f"更新字典数据类型变更时刷新旧缓存失败: {e}")
obj = await DictDataCRUD(auth).update_obj_crud(id=id, data=data)
redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{data.dict_type}"
try:
# 获取当前字典类型的所有字典数据
dict_data_list = await DictDataCRUD(auth).get_obj_list_crud(search={'dict_type': data.dict_type})
dict_data = [DictDataOutSchema.model_validate(row).model_dump() for row in dict_data_list if row]
value = json.dumps(dict_data, ensure_ascii=False)
await RedisCURD(redis).set(
key=redis_key,
value=value,
)
logger.info(f"更新字典数据写入缓存成功: {obj}")
except Exception as e:
logger.error(f"更新字典数据写入缓存失败: {e}")
raise CustomException(msg=f"更新字典数据失败 {e}")
return DictDataOutSchema.model_validate(obj).model_dump()
@classmethod
async def delete_obj_service(cls, auth: AuthSchema, redis: Redis, ids: list[int]) -> None:
"""
删除数据字典数据
参数:
- auth (AuthSchema): 认证信息模型
- redis (Redis): Redis客户端
- ids (list[int]): 数据字典数据ID列表
返回:
- None
"""
if len(ids) < 1:
raise CustomException(msg='删除失败,删除对象不能为空')
for id in ids:
exist_obj = await DictDataCRUD(auth).get_obj_by_id_crud(id=id)
if not exist_obj:
raise CustomException(msg=f'{id} 删除失败,该字典数据不存在')
# 新增:系统默认字典数据不允许删除(通过 is_default 判断)
if exist_obj.is_default:
raise CustomException(msg='删除失败,系统默认字典数据不允许删除')
# 删除Redis缓存
redis_key = f"{RedisInitKeyConfig.SYSTEM_DICT.key}:{exist_obj.dict_type}"
try:
# 删除Redis缓存
await RedisCURD(redis).delete(redis_key)
logger.info(f"删除字典数据成功: {id}")
except Exception as e:
logger.error(f"删除字典数据失败: {e}")
raise CustomException(msg=f"删除字典数据失败 {e}")
await DictDataCRUD(auth).delete_obj_crud(ids=ids)
@classmethod
async def set_obj_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None:
"""
批量修改数据字典数据状态
参数:
- auth (AuthSchema): 认证信息模型
- data (BatchSetAvailable): 批量修改数据字典数据状态负载模型
返回:
- None
"""
await DictDataCRUD(auth).set_obj_available_crud(ids=data.ids, status=data.status)
@classmethod
async def export_obj_service(cls, data_list: List[Dict[str, Any]]) -> bytes:
"""
导出数据字典数据列表
参数:
- data_list (List[Dict[str, Any]]): 数据字典数据列表
返回:
- bytes: Excel文件字节流
"""
mapping_dict = {
'id': '编号',
'dict_sort': '字典排序',
'dict_label': '字典标签',
'dict_value': '字典键值',
'dict_type': '字典类型',
'css_class': '样式属性',
'list_class': '表格回显样式',
'is_default': '是否默认',
'status': '状态',
'description': '备注',
'created_at': '创建时间',
'updated_at': '更新时间',
'creator_id': '创建者ID',
'creator': '创建者',
}
# 复制数据并转换状态
data = data_list.copy()
for item in data:
# 处理状态
item['status'] = '正常' if item.get('status') else '停用'
# 处理是否默认
item['is_default'] = '是' if item.get('is_default') 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)