Files
FastapiAdmin/backend/app/api/v1/module_system/position/service.py
T
zhangtao c2ca6d19ac refactor: 优化代码注释和文档字符串格式
style: 统一代码风格和格式

docs: 完善函数和方法的文档字符串

refactor(base_model): 移除冗余的表名和表参数生成方法

refactor(constant): 更新返回码注释格式

refactor(router_class): 添加路由处理器的详细文档

refactor(database): 完善数据库连接函数的文档

refactor(security): 添加认证类和方法的详细文档

refactor(validator): 更新验证器函数的文档格式

refactor(serialize): 优化序列化工具类的文档

refactor(response): 完善响应类的文档字符串

refactor(dependencies): 添加依赖函数的详细文档

refactor(initialize): 完善初始化脚本的文档

refactor(plugin): 添加生命周期和中间件注册的文档

refactor(service): 完善服务层方法的文档

refactor(controller): 添加控制器方法的详细文档

refactor(crud): 完善CRUD操作的文档字符串

refactor(schema): 简化模型类并移除冗余字段

refactor(param): 更新查询参数类的注释格式

refactor(template): 优化代码生成模板的格式

refactor(console): 添加控制台输出功能的实现

refactor(util): 完善工具函数的文档字符串
2025-10-18 16:31:28 +08:00

155 lines
5.3 KiB
Python

# -*- coding: utf-8 -*-
from typing import Any, Dict, List, Optional
from app.core.base_schema import BatchSetAvailable
from app.core.exceptions import CustomException
from app.utils.excel_util import ExcelUtil
from ..auth.schema import AuthSchema
from .param import PositionQueryParam
from .crud import PositionCRUD
from .schema import (
PositionCreateSchema,
PositionUpdateSchema,
PositionOutSchema,
)
class PositionService:
"""岗位模块服务层"""
@classmethod
async def get_position_detail_service(cls, auth: AuthSchema, id: int) -> Dict:
"""
获取岗位详情
参数:
- auth (AuthSchema): 认证信息模型
- id (int): 岗位ID
返回:
- Dict: 岗位详情对象
"""
position = await PositionCRUD(auth).get_by_id_crud(id=id)
return PositionOutSchema.model_validate(position).model_dump()
@classmethod
async def get_position_list_service(cls, auth: AuthSchema, search: Optional[PositionQueryParam] = None, order_by: Optional[List[Dict[str, str]]] = None) -> List[Dict]:
"""
获取岗位列表
参数:
- auth (AuthSchema): 认证信息模型
- search (PositionQueryParam | None): 查询参数对象
- order_by (List[Dict[str, str]] | None): 排序参数列表
返回:
- List[Dict]: 岗位列表对象
"""
position_list = await PositionCRUD(auth).get_list_crud(search=search.__dict__, order_by=order_by)
return [PositionOutSchema.model_validate(position).model_dump() for position in position_list]
@classmethod
async def create_position_service(cls, auth: AuthSchema, data: PositionCreateSchema) -> Dict:
"""
创建岗位
参数:
- auth (AuthSchema): 认证信息模型
- data (PositionCreateSchema): 岗位创建模型
返回:
- Dict: 创建的岗位对象
"""
position = await PositionCRUD(auth).get(name=data.name)
if position:
raise CustomException(msg='创建失败,该岗位已存在')
new_position = await PositionCRUD(auth).create(data=data)
return PositionOutSchema.model_validate(new_position).model_dump()
@classmethod
async def update_position_service(cls, auth: AuthSchema, id:int, data: PositionUpdateSchema) -> Dict:
"""
更新岗位
参数:
- auth (AuthSchema): 认证信息模型
- id (int): 岗位ID
- data (PositionUpdateSchema): 岗位更新模型
返回:
- Dict: 更新的岗位对象
"""
position = await PositionCRUD(auth).get_by_id_crud(id=id)
if not position:
raise CustomException(msg='更新失败,该岗位不存在')
exist_position = await PositionCRUD(auth).get(name=data.name)
if exist_position and exist_position.id != id:
raise CustomException(msg='更新失败,岗位名称重复')
updated_position = await PositionCRUD(auth).update(id=id, data=data)
return PositionOutSchema.model_validate(updated_position).model_dump()
@classmethod
async def delete_position_service(cls, auth: AuthSchema, ids: list[int]) -> None:
"""
删除岗位
参数:
- auth (AuthSchema): 认证信息模型
- ids (list[int]): 岗位ID列表
返回:
- None
"""
if len(ids) < 1:
raise CustomException(msg='删除失败,删除对象不能为空')
for id in ids:
position = await PositionCRUD(auth).get_by_id_crud(id=id)
if not position:
raise CustomException(msg='删除失败,该岗位不存在')
await PositionCRUD(auth).delete(ids=ids)
@classmethod
async def set_position_available_service(cls, auth: AuthSchema, data: BatchSetAvailable) -> None:
"""
设置岗位状态
参数:
- auth (AuthSchema): 认证信息模型
- data (BatchSetAvailable): 批量设置状态模型
返回:
- None
"""
await PositionCRUD(auth).set_available_crud(ids=data.ids, status=data.status)
@classmethod
async def export_position_list_service(cls, position_list: List[Dict[str, Any]]) -> bytes:
"""
导出岗位列表
参数:
- position_list (List[Dict[str, Any]]): 岗位列表对象
返回:
- bytes: 导出的Excel文件字节流
"""
mapping_dict = {
'id': '编号',
'name': '岗位名称',
'order': '显示顺序',
'status': '状态',
'description': '备注',
'created_at': '创建时间',
'updated_at': '更新时间',
'creator_id': '创建者ID',
'creator': '创建者',
}
# 复制数据并转换状态
data = position_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)