mirror of
https://github.com/fastapiadmin/FastapiAdmin.git
synced 2026-10-01 08:12:06 +00:00
- 将 ApplicationQueryParams 改为 ApplicationQueryParam - 同步更新相关导入和函数参数类型注解 - 修改 PaginationQueryParams 为 PaginationQueryParam refactor(demo): 重命名查询参数类以统一命名风格 - 将 DemoQueryParams 改为 DemoQueryParam - 同步更新相关导入和函数参数类型注解 - 修改 PaginationQueryParams 为 PaginationQueryParam refactor(gencode): 优化代码生成模块的模型和服务层结构 - 统一模型名称后缀为 Schema,调整相关引用 - 规范 Pydantic schema 的命名和定义 - 删除无用的 Python DAO 模板文件 - 调整导入路径,统一使用 app 目录下的模块路径 - 改进服务层方法签名,添加返回类型注解 - 使用自定义异常 CustomException 替代旧异常 - 统一成功响应格式为 SuccessResponse - 优化代码生成服务中的数据库操作 DAO 调用参数传递 - 优化代码生成业务表和字段模型的字段定义,添加注释和默认值 - 优化生成代码路径处理逻辑和异常信息提示 - 整合分页查询参数定义,统一分页模型 - 修正多个服务方法的参数类型和返回类型 - 删除无用的导入和多余注释,提升代码整洁度
186 lines
7.8 KiB
Python
186 lines
7.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
from typing import Any, List, Dict
|
|
|
|
from app.core.ap_scheduler import SchedulerUtil
|
|
from app.core.exceptions import CustomException
|
|
from app.utils.cron_util import CronUtil
|
|
from app.utils.excel_util import ExcelUtil
|
|
from app.api.v1.module_system.auth.schema import AuthSchema
|
|
from .schema import JobCreateSchema, JobUpdateSchema, JobOutSchema, JobLogOutSchema
|
|
from .param import JobQueryParam, JobLogQueryParam
|
|
from .crud import JobCRUD, JobLogCRUD
|
|
|
|
|
|
class JobService:
|
|
"""
|
|
定时任务管理模块服务层
|
|
"""
|
|
|
|
@classmethod
|
|
async def get_job_detail_service(cls, auth: AuthSchema, id: int) -> Dict:
|
|
obj = await JobCRUD(auth).get_obj_by_id_crud(id=id)
|
|
return JobOutSchema.model_validate(obj).model_dump()
|
|
|
|
@classmethod
|
|
async def get_job_list_service(cls, auth: AuthSchema, search: JobQueryParam = None, order_by: List[Dict[str, str]] = None) -> List[Dict]:
|
|
if order_by:
|
|
order_by = eval(order_by)
|
|
obj_list = await JobCRUD(auth).get_obj_list_crud(search=search.__dict__, order_by=order_by)
|
|
return [JobOutSchema.model_validate(obj).model_dump() for obj in obj_list]
|
|
|
|
@classmethod
|
|
async def create_job_service(cls, auth: AuthSchema, data: JobCreateSchema) -> Dict:
|
|
exist_obj = await JobCRUD(auth).get(name=data.name)
|
|
if exist_obj:
|
|
raise CustomException(msg='创建失败,该定时任务已存在')
|
|
if data.trigger == 'cron' and not CronUtil.validate_cron_expression(data.trigger_args):
|
|
raise CustomException(msg=f'新增定时任务{data.name}失败, Cron表达式不正确')
|
|
|
|
obj = await JobCRUD(auth).create_obj_crud(data=data)
|
|
SchedulerUtil().add_job(job_info=obj)
|
|
return JobOutSchema.model_validate(obj).model_dump()
|
|
|
|
@classmethod
|
|
async def update_job_service(cls, auth: AuthSchema, id:int, data: JobUpdateSchema) -> Dict:
|
|
exist_obj = await JobCRUD(auth).get_obj_by_id_crud(id=id)
|
|
if not exist_obj:
|
|
raise CustomException(msg='更新失败,该定时任务不存在')
|
|
if data.trigger == 'cron' and not CronUtil.validate_cron_expression(data.trigger_args):
|
|
raise CustomException(msg=f'新增定时任务{data.name}失败, Cron表达式不正确')
|
|
obj = await JobCRUD(auth).update_obj_crud(id=id, data=data)
|
|
SchedulerUtil().modify_job(job_id=obj.id)
|
|
return JobOutSchema.model_validate(obj).model_dump()
|
|
|
|
@classmethod
|
|
async def delete_job_service(cls, auth: AuthSchema, ids: list[int]) -> None:
|
|
if len(ids) < 1:
|
|
raise CustomException(msg='删除失败,删除对象不能为空')
|
|
for id in ids:
|
|
exist_obj = await JobCRUD(auth).get_obj_by_id_crud(id=id)
|
|
if not exist_obj:
|
|
raise CustomException(msg='删除失败,该数据定时任务不存在')
|
|
SchedulerUtil.remove_job(job_id=id)
|
|
await JobCRUD(auth).delete_obj_crud(ids=ids)
|
|
|
|
|
|
@classmethod
|
|
async def clear_job_service(cls, auth: AuthSchema) -> None:
|
|
SchedulerUtil().clear_jobs()
|
|
await JobCRUD(auth).clear_obj_crud()
|
|
|
|
@classmethod
|
|
async def option_job_service(cls, auth: AuthSchema, id: int, option: int) -> None:
|
|
# 1: 暂停 2: 恢复 3: 重启
|
|
obj = await JobCRUD(auth).get_obj_by_id_crud(id=id)
|
|
if not obj:
|
|
raise CustomException(msg='操作失败,该数据定时任务不存在')
|
|
if option == 1:
|
|
SchedulerUtil().pause_job(job_id=id)
|
|
await JobCRUD(auth).set_obj_field_crud(ids=[id], status=False)
|
|
elif option == 2:
|
|
SchedulerUtil().resume_job(job_id=id)
|
|
await JobCRUD(auth).set_obj_field_crud(ids=[id], status=True)
|
|
# elif option == 3:
|
|
# SchedulerUtil().reschedule_job(job_id=id)
|
|
# await JobCRUD(auth).set_obj_field_crud(ids=[id], status=False)
|
|
|
|
@classmethod
|
|
async def export_job_service(cls, data_list: List[Dict[str, Any]]) -> bytes:
|
|
"""导出公告列表"""
|
|
mapping_dict = {
|
|
'id': '编号',
|
|
'name': '任务名称',
|
|
'func': '任务函数',
|
|
'trigger': '触发器',
|
|
'args': '位置参数',
|
|
'kwargs': '关键字参数',
|
|
'coalesce': '是否合并运行',
|
|
'max_instances': '最大实例数',
|
|
'jobstore': '任务存储',
|
|
'executor': '任务执行器',
|
|
'trigger_args': '触发器参数',
|
|
'status': '任务状态',
|
|
'message': '日志信息',
|
|
'description': '备注',
|
|
'created_at': '创建时间',
|
|
'updated_at': '更新时间',
|
|
'creator_id': '创建者ID',
|
|
'creator': '创建者',
|
|
}
|
|
|
|
# 复制数据并转换状态
|
|
data = data_list.copy()
|
|
for item in data:
|
|
item['status'] = '已完成' if item['status'] == 0 else '运行中' if item['status'] == 1 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 JobLogService:
|
|
"""
|
|
定时任务日志管理模块服务层
|
|
"""
|
|
|
|
@classmethod
|
|
async def get_job_log_detail_service(cls, auth: AuthSchema, id: int) -> Dict:
|
|
"""获取定时任务日志详情"""
|
|
obj = await JobLogCRUD(auth).get_obj_log_by_id_crud(id=id)
|
|
return JobLogOutSchema.model_validate(obj).model_dump()
|
|
|
|
@classmethod
|
|
async def get_job_log_list_service(cls, auth: AuthSchema, search: JobLogQueryParam = None, order_by: List[Dict[str, str]] = None) -> List[Dict]:
|
|
"""获取定时任务日志列表"""
|
|
if order_by:
|
|
order_by = eval(order_by)
|
|
else:
|
|
order_by = [{"created_at": "desc"}]
|
|
obj_list = await JobLogCRUD(auth).get_obj_log_list_crud(search=search.__dict__, order_by=order_by)
|
|
return [JobLogOutSchema.model_validate(obj).model_dump() for obj in obj_list]
|
|
|
|
@classmethod
|
|
async def delete_job_log_service(cls, auth: AuthSchema, ids: list[int]) -> None:
|
|
"""删除定时任务日志"""
|
|
if len(ids) < 1:
|
|
raise CustomException(msg='删除失败,删除对象不能为空')
|
|
for id in ids:
|
|
exist_obj = await JobLogCRUD(auth).get_obj_log_by_id_crud(id=id)
|
|
if not exist_obj:
|
|
raise CustomException(msg='删除失败,该定时任务日志不存在')
|
|
await JobLogCRUD(auth).delete_obj_log_crud(ids=ids)
|
|
|
|
@classmethod
|
|
async def clear_job_log_service(cls, auth: AuthSchema) -> None:
|
|
"""清空定时任务日志"""
|
|
# 获取所有日志ID并批量删除
|
|
all_logs = await JobLogCRUD(auth).get_obj_log_list_crud()
|
|
if all_logs:
|
|
ids = [log.id for log in all_logs]
|
|
await JobLogCRUD(auth).delete_obj_log_crud(ids=ids)
|
|
|
|
@classmethod
|
|
async def export_job_log_service(cls, data_list: List[Dict[str, Any]]) -> bytes:
|
|
"""导出定时任务日志列表"""
|
|
mapping_dict = {
|
|
'id': '编号',
|
|
'job_name': '任务名称',
|
|
'job_group': '任务组名',
|
|
'job_executor': '任务执行器',
|
|
'invoke_target': '调用目标字符串',
|
|
'job_args': '位置参数',
|
|
'job_kwargs': '关键字参数',
|
|
'job_trigger': '任务触发器',
|
|
'job_message': '日志信息',
|
|
'status': '执行状态',
|
|
'exception_info': '异常信息',
|
|
'created_at': '创建时间',
|
|
}
|
|
|
|
# 复制数据并转换状态
|
|
data = data_list.copy()
|
|
for item in data:
|
|
item['status'] = '成功' if item.get('status') else '失败'
|
|
|
|
return ExcelUtil.export_list2excel(list_data=data, mapping_dict=mapping_dict)
|
|
|