mirror of
https://github.com/fastapiadmin/FastapiAdmin.git
synced 2026-09-21 04:46:26 +00:00
zhangtao
00b7fe54ba
本次提交主要包含以下变更： 1. 新增任务管理模块，支持定时任务的创建、更新、删除和状态管理 2. 新增字典管理模块，用于维护系统中常用的固定数据 3. 优化系统配置，移除Celery，改用APScheduler进行任务调度 4. 修复部分前端组件的样式问题，统一输入框宽度 5. 更新文档和相关图片资源，完善系统功能描述 这些变更旨在增强系统的可维护性和功能性，提供更灵活的任务调度机制和更便捷的字典数据管理方式。
340 lines
12 KiB
Python
340 lines
12 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
from pydantic import BaseModel
|
|
from typing import TypeVar, Sequence, Generic, Dict, Any, List, Union, Optional
|
|
from sqlalchemy.sql.elements import ColumnElement
|
|
from sqlalchemy.orm import selectinload, DeclarativeBase
|
|
from sqlalchemy.engine import Result
|
|
from sqlalchemy.ext.asyncio import AsyncSession
|
|
from sqlalchemy import asc, func, select, delete, Select, desc, update, or_, and_
|
|
|
|
from app.api.v1.schemas.system.auth_schema import AuthSchema
|
|
from app.api.v1.models.system.dept_model import DeptModel
|
|
from app.api.v1.models.system.user_model import UserModel
|
|
from app.utils.common_util import get_child_id_map, get_child_recursion
|
|
from app.core.exceptions import CustomException
|
|
|
|
ModelType = TypeVar("ModelType", bound=DeclarativeBase)
|
|
CreateSchemaType = TypeVar("CreateSchemaType", bound=BaseModel)
|
|
UpdateSchemaType = TypeVar("UpdateSchemaType", bound=BaseModel)
|
|
|
|
|
|
class CRUDBase(Generic[ModelType, CreateSchemaType, UpdateSchemaType]):
|
|
"""基础数据层"""
|
|
|
|
def __init__(self, model: ModelType, auth: AuthSchema) -> None:
|
|
"""
|
|
初始化CRUDBase类
|
|
|
|
Args:
|
|
model: 数据模型
|
|
auth: 认证信息
|
|
"""
|
|
self.model = model
|
|
self.auth = auth
|
|
self.db: AsyncSession = auth.db
|
|
self.current_user = auth.user
|
|
async def get(self, **kwargs) -> Optional[ModelType]:
|
|
"""
|
|
根据条件获取单个对象
|
|
|
|
Args:
|
|
**kwargs: 查询条件
|
|
|
|
Returns:
|
|
Optional[ModelType]: 对象实例
|
|
|
|
Raises:
|
|
CustomException: 查询失败时抛出异常
|
|
"""
|
|
try:
|
|
conditions = await self.__build_conditions(**kwargs)
|
|
sql = (select(self.model)
|
|
.where(*conditions)
|
|
.distinct())
|
|
if hasattr(self.model, "creator"):
|
|
sql = sql.options(selectinload(self.model.creator))
|
|
|
|
result: Result = await self.db.execute(sql)
|
|
obj = result.scalars().unique().first()
|
|
return obj
|
|
except Exception as e:
|
|
raise CustomException(msg=f"获取查询失败: {str(e)}")
|
|
|
|
async def list(self, search: Dict = None, order_by: List[Dict[str, str]] = None) -> Sequence[ModelType]:
|
|
"""
|
|
根据条件获取对象列表和总数
|
|
|
|
Args:
|
|
search: 查询条件,格式为 {'id': value, 'name': value}
|
|
order_by: 排序字段,格式为 [{'id': 'asc'}, {'name': 'desc'}]
|
|
|
|
Returns:
|
|
Sequence[ModelType]: 对象列表
|
|
|
|
Raises:
|
|
CustomException: 查询失败时抛出异常
|
|
"""
|
|
try:
|
|
conditions = await self.__build_conditions(**search) if search else []
|
|
order = order_by or [{'id': 'asc'}]
|
|
sql = (select(self.model)
|
|
.where(*conditions)
|
|
.order_by(*self.__order_by(order))
|
|
.distinct())
|
|
sql = await self.__filter_permissions(sql)
|
|
result: Result = await self.db.execute(sql)
|
|
return result.scalars().unique().all()
|
|
except Exception as e:
|
|
raise CustomException(msg=f"列表查询失败: {str(e)}")
|
|
|
|
async def create(self, data: Union[CreateSchemaType, Dict]) -> ModelType:
|
|
"""
|
|
创建新对象
|
|
|
|
Args:
|
|
data: 对象属性
|
|
|
|
Returns:
|
|
ModelType: 新创建的对象实例
|
|
|
|
Raises:
|
|
CustomException: 创建失败时抛出异常
|
|
"""
|
|
try:
|
|
obj_dict = data if isinstance(data, dict) else data.model_dump()
|
|
obj = self.model(**obj_dict)
|
|
|
|
if hasattr(self.model, "creator") and self.current_user:
|
|
# 设置创建人ID
|
|
obj.creator_id = self.current_user.id
|
|
# 设置创建人对象
|
|
obj.creator = self.current_user
|
|
|
|
self.db.add(obj)
|
|
await self.db.flush()
|
|
await self.db.refresh(obj)
|
|
return obj
|
|
except Exception as e:
|
|
raise CustomException(msg=f"创建失败: {str(e)}")
|
|
|
|
async def update(self, id: int, data: Union[UpdateSchemaType, Dict]) -> ModelType:
|
|
"""
|
|
更新对象
|
|
|
|
Args:
|
|
id: 对象ID
|
|
data: 更新的属性及值
|
|
|
|
Returns:
|
|
ModelType: 更新后的对象实例
|
|
|
|
Raises:
|
|
CustomException: 更新失败时抛出异常
|
|
"""
|
|
try:
|
|
obj_dict = data if isinstance(data, dict) else data.model_dump(exclude_unset=True, exclude={"id"})
|
|
obj = await self.get(id=id)
|
|
|
|
for key, value in obj_dict.items():
|
|
if hasattr(obj, key):
|
|
setattr(obj, key, value)
|
|
|
|
await self.db.flush()
|
|
await self.db.refresh(obj)
|
|
return obj
|
|
except Exception as e:
|
|
raise CustomException(msg=f"更新失败: {str(e)}")
|
|
|
|
async def delete(self, ids: List[int]) -> None:
|
|
"""
|
|
删除对象
|
|
|
|
Args:
|
|
ids: 对象ID列表
|
|
|
|
Raises:
|
|
CustomException: 删除失败时抛出异常
|
|
"""
|
|
try:
|
|
sql = delete(self.model).where(self.model.id.in_(ids))
|
|
sql = await self.__filter_permissions(sql)
|
|
await self.db.execute(sql)
|
|
await self.db.flush()
|
|
except Exception as e:
|
|
raise CustomException(msg=f"删除失败: {str(e)}")
|
|
|
|
async def clear(self) -> None:
|
|
"""
|
|
清空对象表
|
|
|
|
Raises:
|
|
CustomException: 清空失败时抛出异常
|
|
"""
|
|
try:
|
|
sql = delete(self.model)
|
|
await self.db.execute(sql)
|
|
await self.db.flush()
|
|
except Exception as e:
|
|
raise CustomException(msg=f"清空失败: {str(e)}")
|
|
|
|
async def set(self, ids: List[int], **kwargs) -> None:
|
|
"""
|
|
批量更新对象
|
|
|
|
Args:
|
|
ids: 对象ID列表
|
|
**kwargs: 更新的属性及值
|
|
|
|
Raises:
|
|
CustomException: 更新失败时抛出异常
|
|
"""
|
|
try:
|
|
sql = update(self.model).where(self.model.id.in_(ids)).values(**kwargs)
|
|
await self.db.execute(sql)
|
|
await self.db.flush()
|
|
except Exception as e:
|
|
raise CustomException(msg=f"批量更新失败: {str(e)}")
|
|
|
|
async def update_relationships(self, objs_to_update: List[ModelType], relationship_field: str, related_objs: List[ModelType]) -> None:
|
|
"""
|
|
更新对象关系
|
|
|
|
Args:
|
|
objs_to_update: 需要更新关系的对象列表
|
|
relationship_field: 关系字段名称
|
|
related_objs: 关联对象列表
|
|
|
|
Raises:
|
|
CustomException: 更新关系失败时抛出异常
|
|
"""
|
|
try:
|
|
for obj in objs_to_update:
|
|
relationship = getattr(obj, relationship_field)
|
|
relationship.clear()
|
|
relationship.extend(related_objs)
|
|
await self.db.flush()
|
|
except Exception as e:
|
|
raise CustomException(msg=f"更新关系失败: {str(e)}")
|
|
|
|
async def __filter_permissions(self, sql: Select[Any]) -> Select[Any]:
|
|
"""过滤数据权限"""
|
|
# 1. 如果模型没有creator字段,则不需要过滤
|
|
if not hasattr(self.model, "creator"):
|
|
return sql
|
|
|
|
sql = sql.options(selectinload(self.model.creator))
|
|
|
|
# 2. 超级管理员可以查看所有数据
|
|
if not self.current_user or self.current_user.is_superuser:
|
|
return sql
|
|
|
|
# 3. 如果用户没有部门或角色,则只能查看自己的数据
|
|
if not self.current_user.dept_id or not self.current_user.roles:
|
|
return sql.where(self.model.creator_id == self.current_user.id)
|
|
|
|
# 4. 获取用户所有角色的权限范围
|
|
data_scopes = set()
|
|
dept_ids = set()
|
|
|
|
# data_scope 数据权限范围说明:
|
|
# 1: 仅本人数据权限
|
|
# 2: 本部门数据权限
|
|
# 3: 本部门及以下数据权限
|
|
# 4: 全部数据权限
|
|
# 5: 自定义数据权限
|
|
# 5. 处理各种数据权限范围
|
|
for role in self.current_user.roles:
|
|
# 如果有全部数据权限,直接返回所有数据
|
|
if role.data_scope == 4:
|
|
return sql
|
|
|
|
data_scopes.add(role.data_scope)
|
|
# 如果是自定义权限,添加自定义部门
|
|
if role.data_scope == 5:
|
|
dept_ids.update({dept.id for dept in role.depts})
|
|
|
|
conditions = []
|
|
|
|
# 5. 处理各种数据权限范围
|
|
if 1 in data_scopes:
|
|
# 1、仅本人数据
|
|
conditions.append(self.model.creator_id == self.current_user.id)
|
|
|
|
if 2 in data_scopes:
|
|
# 2、本部门数据
|
|
dept_ids.add(self.current_user.dept_id)
|
|
|
|
if 3 in data_scopes:
|
|
# 3、本部门及以下数据
|
|
dept_objs = await CRUDBase(DeptModel, self.auth).list()
|
|
id_map = get_child_id_map(dept_objs)
|
|
dept_child_ids = get_child_recursion(id=self.current_user.dept_id, id_map=id_map)
|
|
dept_ids.update(dept_child_ids)
|
|
|
|
if dept_ids:
|
|
conditions.append(self.model.creator.has(UserModel.dept_id.in_(list(dept_ids))))
|
|
|
|
# 6. 组合所有条件
|
|
if conditions:
|
|
return sql.where(and_(*conditions))
|
|
|
|
return sql.where(self.model.creator_id == self.current_user.id)
|
|
|
|
def __order_by(self, order_by: List[Dict[str, str]]) -> List[ColumnElement]:
|
|
"""
|
|
获取排序字段
|
|
|
|
Args:
|
|
order_by: 排序字段列表,格式为 [{'id': 'asc'}, {'name': 'desc'}]
|
|
|
|
Returns:
|
|
List[ColumnElement]: 排序字段列表
|
|
"""
|
|
columns = []
|
|
for order in order_by:
|
|
for field, direction in order.items():
|
|
column = getattr(self.model, field)
|
|
columns.append(desc(column) if direction.lower() == 'desc' else asc(column))
|
|
return columns
|
|
|
|
async def __build_conditions(self, **kwargs) -> List[ColumnElement]:
|
|
"""
|
|
构建查询条件
|
|
|
|
Args:
|
|
**kwargs: 查询参数
|
|
|
|
Returns:
|
|
List[ColumnElement]: SQL条件表达式列表
|
|
"""
|
|
conditions = []
|
|
for key, value in kwargs.items():
|
|
if value is None or value == "":
|
|
continue
|
|
|
|
attr = getattr(self.model, key)
|
|
if isinstance(value, tuple):
|
|
seq, val = value
|
|
if seq == "None":
|
|
conditions.append(attr.is_(None))
|
|
elif seq == "not None":
|
|
conditions.append(attr.isnot(None))
|
|
elif seq == "date" and val:
|
|
conditions.append(func.date_format(attr, "%Y-%m-%d") == val)
|
|
elif seq == "month" and val:
|
|
conditions.append(func.date_format(attr, "%Y-%m") == val)
|
|
elif seq == "like" and val:
|
|
conditions.append(attr.like(f"%{val}%"))
|
|
elif seq == "in" and val:
|
|
conditions.append(attr.in_(val))
|
|
elif seq == "between" and isinstance(val, (list, tuple)) and len(val) == 2:
|
|
conditions.append(attr.between(val[0], val[1]))
|
|
elif seq == "!=" and val:
|
|
conditions.append(attr != val)
|
|
elif seq in [">", ">=", "<=", "=="] and val:
|
|
conditions.append(getattr(attr, seq.replace("==", "__eq__"))(val))
|
|
else:
|
|
conditions.append(attr == value)
|
|
return conditions
|