253 lines
10 KiB
Python
253 lines
10 KiB
Python
# +======================================================================
|
||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||
# +----------------------------------------------------------------------
|
||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||
# +----------------------------------------------------------------------
|
||
# | 开源协议: Apache-2.0
|
||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||
# +----------------------------------------------------------------------
|
||
# | 官方网站: https://www.djangoadmin.cn
|
||
# +----------------------------------------------------------------------
|
||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||
# +======================================================================
|
||
# | 版权和免责声明:
|
||
# | 一、知识产权声明
|
||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||
# | 二、使用限制与禁止条款
|
||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||
# | 三、责任豁免
|
||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||
# | 四、违约与法律责任
|
||
# | 如发现任何违反本声明的行为，本团队有权：
|
||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||
# | 五、许可范围说明
|
||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||
# | 成的一切经济损失及商誉损害。
|
||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||
# | 许可协议》附件为准。
|
||
# +======================================================================
|
||
|
||
"""
|
||
定时任务表单验证模块
|
||
=============================================================
|
||
|
||
该模块定义了定时任务管理功能中使用的表单验证类。
|
||
用于对前端提交的任务数据进行验证，确保数据符合业务规则和数据库约束。
|
||
"""
|
||
|
||
from django import forms
|
||
from application.job import models
|
||
|
||
|
||
# =============================================================
|
||
# 定时任务表单验证类
|
||
# =============================================================
|
||
|
||
class JobForm(forms.ModelForm):
|
||
"""
|
||
定时任务表单验证类
|
||
|
||
用于创建和更新定时任务信息时的表单验证。
|
||
"""
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务名称
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务的显示名称
|
||
# 字段类型: 字符型（CharField）
|
||
# 验证规则: 必填（required=True），最大长度255字符
|
||
# 业务说明: 用于前端展示和日志记录
|
||
jobName = forms.CharField(
|
||
required=True,
|
||
max_length=255,
|
||
error_messages={
|
||
'required': '任务名称不能为空',
|
||
'max_length': '任务名称长度不得超过255个字符',
|
||
}
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务别名
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务的别名
|
||
# 字段类型: 字符型（CharField）
|
||
# 验证规则: 可选填（required=False），最大长度255字符
|
||
# 业务说明: 用于展示更友好的任务名称
|
||
jobAlias = forms.CharField(
|
||
required=False,
|
||
max_length=255,
|
||
error_messages={
|
||
'max_length': '任务别名长度不得超过255个字符',
|
||
}
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务分组
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务所属分组
|
||
# 字段类型: 字符型（CharField）
|
||
# 验证规则: 可选填（required=False），最大长度255字符
|
||
# 业务说明: 对任务进行分类管理，便于批量操作
|
||
jobGroup = forms.CharField(
|
||
required=False,
|
||
max_length=255,
|
||
error_messages={
|
||
'max_length': '任务分组长度不得超过255个字符',
|
||
}
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务触发器
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务触发器标识
|
||
# 字段类型: 字符型（CharField）
|
||
# 验证规则: 可选填（required=False），最大长度255字符
|
||
# 业务说明: 映射到具体的执行方法，用于内部方法调用
|
||
jobTrigger = forms.CharField(
|
||
required=False,
|
||
max_length=255,
|
||
error_messages={
|
||
'max_length': '任务触发器长度不得超过255个字符',
|
||
}
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务状态
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务的运行状态
|
||
# 字段类型: 整型（IntegerField）
|
||
# 验证规则: 必填（required=True），取值范围0-3
|
||
# 可选值: 0-未发布, 1-运行中, 2-暂停, 3-删除
|
||
status = forms.IntegerField(
|
||
required=True,
|
||
min_value=0,
|
||
max_value=3,
|
||
error_messages={
|
||
'required': '任务状态不能为空',
|
||
'min_value': '任务状态值在0~3之间',
|
||
'max_value': '任务状态值在0~3之间',
|
||
}
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# Cron表达式
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务的调度规则
|
||
# 字段类型: 字符型（CharField）
|
||
# 验证规则: 可选填（required=False），最大长度255字符
|
||
# 业务说明: 定义任务的执行时间规则，如"0 2 * * *"表示每天凌晨2点执行
|
||
cronExpression = forms.CharField(
|
||
required=False,
|
||
max_length=255,
|
||
error_messages={
|
||
'max_length': 'Cron表达式长度不得超过255个字符',
|
||
}
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 执行策略
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务触发后的执行策略
|
||
# 字段类型: 整型（IntegerField）
|
||
# 验证规则: 必填（required=True），取值范围1-3
|
||
# 可选值: 1-立即执行, 2-执行一次, 3-放弃执行
|
||
executePolicy = forms.IntegerField(
|
||
required=True,
|
||
min_value=1,
|
||
max_value=3,
|
||
error_messages={
|
||
'required': '执行策略不能为空',
|
||
'min_value': '执行策略值在1~3之间',
|
||
'max_value': '执行策略值在1~3之间',
|
||
}
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 是否同步执行
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务是否同步执行
|
||
# 字段类型: 整型（IntegerField）
|
||
# 验证规则: 必填（required=True），取值范围0-1
|
||
# 可选值: 0-异步, 1-同步
|
||
isSync = forms.IntegerField(
|
||
required=True,
|
||
min_value=0,
|
||
max_value=1,
|
||
error_messages={
|
||
'required': '是否同步任务不能为空',
|
||
'min_value': '是否同步任务值在0~1之间',
|
||
'max_value': '是否同步任务值在0~1之间',
|
||
}
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务URL
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务调用的URL地址
|
||
# 字段类型: 字符型（CharField）
|
||
# 验证规则: 可选填（required=False），最大长度255字符
|
||
# 业务说明: 当任务通过HTTP方式执行时，调用此URL
|
||
url = forms.CharField(
|
||
required=False,
|
||
max_length=255,
|
||
error_messages={
|
||
'max_length': '任务URL长度不得超过255个字符',
|
||
}
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务备注
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务的说明信息
|
||
# 字段类型: 字符型（CharField）
|
||
# 验证规则: 可选填（required=False），最大长度255字符
|
||
# 业务说明: 存储任务的描述信息，如用途、注意事项等
|
||
note = forms.CharField(
|
||
required=False,
|
||
max_length=255,
|
||
error_messages={
|
||
'max_length': '任务备注长度不得超过255个字符',
|
||
}
|
||
)
|
||
|
||
# =============================================================
|
||
# 表单元数据配置
|
||
# =============================================================
|
||
|
||
class Meta:
|
||
"""
|
||
表单元数据配置类
|
||
|
||
定义表单绑定的模型和需要验证的字段。
|
||
"""
|
||
|
||
# 绑定模型
|
||
# 指定该表单对应的数据模型为 Job（定时任务）
|
||
model = models.Job
|
||
|
||
# 指定需要验证的字段
|
||
fields = [
|
||
'jobName',
|
||
'jobAlias',
|
||
'jobGroup',
|
||
'jobTrigger',
|
||
'status',
|
||
'cronExpression',
|
||
'executePolicy',
|
||
'isSync',
|
||
'url',
|
||
'note'
|
||
]
|