From cd131ba7a2a55b86d45525093672b29843907a64 Mon Sep 17 00:00:00 2001 From: insistence <3055204202@qq.com> Date: Fri, 5 Jul 2024 08:50:42 +0800 Subject: [PATCH] =?UTF-8?q?feat&perf:=20=E5=AE=9A=E6=97=B6=E4=BB=BB?= =?UTF-8?q?=E5=8A=A1=E7=AE=A1=E7=90=86=E6=A8=A1=E5=9D=97vo=E5=B1=82?= =?UTF-8?q?=E4=BC=98=E5=8C=96=EF=BC=8C=E6=96=B0=E5=A2=9E=E5=AD=97=E6=AE=B5?= =?UTF-8?q?=E6=A0=A1=E9=AA=8C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../module_admin/entity/vo/job_vo.py | 97 +++++++++++-------- 1 file changed, 56 insertions(+), 41 deletions(-) diff --git a/ruoyi-fastapi-backend/module_admin/entity/vo/job_vo.py b/ruoyi-fastapi-backend/module_admin/entity/vo/job_vo.py index f6f91d3..c3efb7f 100644 --- a/ruoyi-fastapi-backend/module_admin/entity/vo/job_vo.py +++ b/ruoyi-fastapi-backend/module_admin/entity/vo/job_vo.py @@ -1,8 +1,9 @@ -from pydantic import BaseModel, ConfigDict +from pydantic import BaseModel, ConfigDict, Field from pydantic.alias_generators import to_camel -from typing import Union, Optional, List +from typing import Union, Optional, List, Literal from datetime import datetime from module_admin.annotation.pydantic_annotation import as_query, as_form +from module_admin.annotation.validate_annotation import NotBlank, Size class JobModel(BaseModel): @@ -11,22 +12,36 @@ class JobModel(BaseModel): """ model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) - job_id: Optional[int] = None - job_name: Optional[str] = None - job_group: Optional[str] = None - job_executor: Optional[str] = None - invoke_target: Optional[str] = None - job_args: Optional[str] = None - job_kwargs: Optional[str] = None - cron_expression: Optional[str] = None - misfire_policy: Optional[str] = None - concurrent: Optional[str] = None - status: Optional[str] = None - create_by: Optional[str] = None - create_time: Optional[datetime] = None - update_by: Optional[str] = None - update_time: Optional[datetime] = None - remark: Optional[str] = None + job_id: Optional[int] = Field(default=None, description='任务ID') + job_name: Optional[str] = Field(default=None, description='任务名称') + job_group: Optional[str] = Field(default=None, description='任务组名') + job_executor: Optional[str] = Field(default=None, description='任务执行器') + invoke_target: Optional[str] = Field(default=None, description='调用目标字符串') + job_args: Optional[str] = Field(default=None, description='位置参数') + job_kwargs: Optional[str] = Field(default=None, description='关键字参数') + cron_expression: Optional[str] = Field(default=None, description='cron执行表达式') + misfire_policy: Optional[Literal['1', '2', '3']] = Field(default=None, description='计划执行错误策略（1立即执行 2执行一次 3放弃执行）') + concurrent: Optional[Literal['0', '1']] = Field(default=None, description='是否并发执行（0允许 1禁止）') + status: Optional[Literal['0', '1']] = Field(default=None, description='状态（0正常 1暂停）') + create_by: Optional[str] = Field(default=None, description='创建者') + create_time: Optional[datetime] = Field(default=None, description='创建时间') + update_by: Optional[str] = Field(default=None, description='更新者') + update_time: Optional[datetime] = Field(default=None, description='更新时间') + remark: Optional[str] = Field(default=None, description='备注信息') + + @NotBlank(field_name='invoke_target', message='调用目标字符串不能为空') + @Size(field_name='invoke_target', min_length=0, max_length=500, message='调用目标字符串长度不能超过500个字符') + def get_invoke_target(self): + return self.invoke_target + + @NotBlank(field_name='cron_expression', message='Cron执行表达式不能为空') + @Size(field_name='cron_expression', min_length=0, max_length=255, message='Cron执行表达式不能超过255个字符') + def get_cron_expression(self): + return self.cron_expression + + def validate_fields(self): + self.get_invoke_target() + self.get_cron_expression() class JobLogModel(BaseModel): @@ -35,26 +50,26 @@ class JobLogModel(BaseModel): """ model_config = ConfigDict(alias_generator=to_camel, from_attributes=True) - job_log_id: Optional[int] = None - job_name: Optional[str] = None - job_group: Optional[str] = None - job_executor: Optional[str] = None - invoke_target: Optional[str] = None - job_args: Optional[str] = None - job_kwargs: Optional[str] = None - job_trigger: Optional[str] = None - job_message: Optional[str] = None - status: Optional[str] = None - exception_info: Optional[str] = None - create_time: Optional[datetime] = None + job_log_id: Optional[int] = Field(default=None, description='任务日志ID') + job_name: Optional[str] = Field(default=None, description='任务名称') + job_group: Optional[str] = Field(default=None, description='任务组名') + job_executor: Optional[str] = Field(default=None, description='任务执行器') + invoke_target: Optional[str] = Field(default=None, description='调用目标字符串') + job_args: Optional[str] = Field(default=None, description='位置参数') + job_kwargs: Optional[str] = Field(default=None, description='关键字参数') + job_trigger: Optional[str] = Field(default=None, description='任务触发器') + job_message: Optional[str] = Field(default=None, description='日志信息') + status: Optional[Literal['0', '1']] = Field(default=None, description='执行状态（0正常 1失败）') + exception_info: Optional[str] = Field(default=None, description='异常信息') + create_time: Optional[datetime] = Field(default=None, description='创建时间') class JobQueryModel(JobModel): """ 定时任务管理不分页查询模型 """ - begin_time: Optional[str] = None - end_time: Optional[str] = None + begin_time: Optional[str] = Field(default=None, description='开始时间') + end_time: Optional[str] = Field(default=None, description='结束时间') @as_query @@ -63,15 +78,15 @@ class JobPageQueryModel(JobQueryModel): """ 定时任务管理分页查询模型 """ - page_num: int = 1 - page_size: int = 10 + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') class EditJobModel(JobModel): """ 编辑定时任务模型 """ - type: Optional[str] = None + type: Optional[str] = Field(default=None, description='操作类型') class DeleteJobModel(BaseModel): @@ -80,15 +95,15 @@ class DeleteJobModel(BaseModel): """ model_config = ConfigDict(alias_generator=to_camel) - job_ids: str + job_ids: str = Field(description='需要删除的定时任务ID') class JobLogQueryModel(JobLogModel): """ 定时任务日志不分页查询模型 """ - begin_time: Optional[str] = None - end_time: Optional[str] = None + begin_time: Optional[str] = Field(default=None, description='开始时间') + end_time: Optional[str] = Field(default=None, description='结束时间') @as_query @@ -97,8 +112,8 @@ class JobLogPageQueryModel(JobLogQueryModel): """ 定时任务日志管理分页查询模型 """ - page_num: int = 1 - page_size: int = 10 + page_num: int = Field(default=1, description='当前页码') + page_size: int = Field(default=10, description='每页记录数') class DeleteJobLogModel(BaseModel): @@ -107,4 +122,4 @@ class DeleteJobLogModel(BaseModel): """ model_config = ConfigDict(alias_generator=to_camel) - job_log_ids: str + job_log_ids: str = Field(description='需要删除的定时任务日志ID')