320 lines
13 KiB
Python
320 lines
13 KiB
Python
# +======================================================================
|
||
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者，助力企业发展 ]
|
||
# +----------------------------------------------------------------------
|
||
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
|
||
# +----------------------------------------------------------------------
|
||
# | 开源协议: Apache-2.0
|
||
# | 重要声明: 未经书面许可，不得移除或修改本框架相关版权标识。
|
||
# +----------------------------------------------------------------------
|
||
# | 官方网站: https://www.djangoadmin.cn
|
||
# +----------------------------------------------------------------------
|
||
# | 研发团队: 小蚂蚁云团队 荣誉出品
|
||
# +======================================================================
|
||
# | 版权和免责声明:
|
||
# | 一、知识产权声明
|
||
# | 本团队对该软件框架产品（以下简称“本产品”）拥有完整知识产权，包括但不限于商标权、专利权、
|
||
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权，
|
||
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
|
||
# | 二、使用限制与禁止条款
|
||
# | 您理解并同意，禁止将本产品用于以下任何行为：
|
||
# | 1. 任何违反中华人民共和国法律法规的用途；
|
||
# | 2. 任何侵害他人合法权益（包括但不限于人身权、财产权、知识产权等）的行为；
|
||
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
|
||
# | 三、责任豁免
|
||
# | 因使用本产品而产生的任何损失或法律纠纷（包括但不限于直接损失、间接损失、附带损失、衍生损失
|
||
# | 以及因违约、侵权等引发的责任），本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
|
||
# | 方提起索赔或行政机关进行调查，您应独立承担全部责任。
|
||
# | 四、违约与法律责任
|
||
# | 如发现任何违反本声明的行为，本团队有权：
|
||
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作；
|
||
# | 2. 依法追究相关方的民事责任，并要求赔偿全部损失；
|
||
# | 3. 保留进一步采取刑事控告等法律措施的权利。
|
||
# | 五、许可范围说明
|
||
# | 1、被授权方应视本产品源代码为核心机密信息，负有最高标准的保密与保管义务。禁止以任何形式（包
|
||
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
|
||
# | 过网络服务提供给任何第三方）泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
|
||
# | 传播行为均构成对本团队知识产权的严重侵权，本团队有权依法追究其全部法律责任，并要求赔偿因此造
|
||
# | 成的一切经济损失及商誉损害。
|
||
# | 2、本产品仅限于公司或个人在法律允许范围内，用于内部且合规的软件产品研发。具体权利义务以《软件
|
||
# | 许可协议》附件为准。
|
||
# +======================================================================
|
||
|
||
"""
|
||
定时任务日志模型模块
|
||
=============================================================
|
||
|
||
该模块定义了定时任务执行日志相关的数据库模型。
|
||
用于记录定时任务的每次执行情况，包括执行状态、耗时、异常信息等。
|
||
"""
|
||
|
||
from django.db import models
|
||
|
||
from application.models import BaseModel
|
||
from utils.common import get_table_name
|
||
|
||
|
||
# =============================================================
|
||
# 定时任务日志模型类
|
||
# =============================================================
|
||
|
||
class JobLog(BaseModel):
|
||
"""
|
||
定时任务日志模型类
|
||
|
||
用于存储系统中定时任务的执行日志信息，记录每次任务的执行情况。
|
||
包括任务的基本信息、执行状态、开始结束时间、耗时、异常信息等。
|
||
继承自 BaseModel，自动包含：
|
||
- id: 主键
|
||
- is_delete: 逻辑删除标识
|
||
- create_user: 创建人
|
||
- create_time: 创建时间
|
||
- update_user: 更新人
|
||
- update_time: 更新时间
|
||
|
||
主要业务字段：
|
||
- job_id: 关联的任务ID
|
||
- job_name: 任务名称
|
||
- job_group: 任务分组
|
||
- job_trigger: 任务触发器
|
||
- job_message: 任务日志信息
|
||
- cron_expression: 定时表达式
|
||
- status: 执行状态（0-正常 1-失败）
|
||
- start_time: 执行开始时间
|
||
- end_time: 执行结束时间
|
||
- consume_time: 执行耗时（毫秒）
|
||
- exception_info: 异常信息
|
||
"""
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务ID
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 关联的任务ID
|
||
# 字段类型: 无符号整数（PositiveIntegerField）
|
||
# 约束: 非空（null=False），默认值为0
|
||
# 索引: 添加了数据库索引（db_index=True）以提升查询效率
|
||
# 作用: 关联到 Job 表的主键ID，用于查询特定任务的所有日志
|
||
job_id = models.PositiveIntegerField(
|
||
null=False,
|
||
default=0,
|
||
db_index=True,
|
||
verbose_name="任务ID",
|
||
help_text="任务ID",
|
||
db_comment='任务ID', # 数据库字段注释
|
||
db_default=0
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务名称
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务的名称
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 非空（null=False），最大长度255字符
|
||
# 作用: 存储任务的具体名称，便于识别和日志展示
|
||
job_name = models.CharField(
|
||
null=False,
|
||
max_length=255,
|
||
verbose_name="任务名称",
|
||
help_text="任务名称",
|
||
db_comment='任务名称' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务分组
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务所属分组
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 允许为空（null=True, blank=True），最大长度255字符
|
||
# 作用: 任务所属分组，用于分类管理和筛选
|
||
job_group = models.CharField(
|
||
null=True,
|
||
blank=True,
|
||
max_length=255,
|
||
verbose_name="任务分组",
|
||
help_text="任务分组",
|
||
db_comment='任务分组' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务触发器
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 触发任务的触发器类型或名称
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 允许为空（null=True, blank=True），最大长度255字符
|
||
# 作用: 记录触发任务执行的触发器标识
|
||
job_trigger = models.CharField(
|
||
null=True,
|
||
blank=True,
|
||
max_length=255,
|
||
verbose_name="任务触发器",
|
||
help_text="任务触发器",
|
||
db_comment='任务触发器' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 任务日志信息
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务执行时的日志消息
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 允许为空（null=True, blank=True），最大长度500字符
|
||
# 作用: 记录任务执行时的简要日志信息
|
||
job_message = models.CharField(
|
||
null=True,
|
||
blank=True,
|
||
max_length=500,
|
||
verbose_name="任务日志信息",
|
||
help_text="任务日志信息",
|
||
db_comment='任务日志信息' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# Cron表达式
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务的定时规则表达式
|
||
# 字段类型: 字符串（CharField）
|
||
# 约束: 允许为空（null=True, blank=True），最大长度255字符
|
||
# 作用: 记录任务执行时使用的 Cron 表达式
|
||
cron_expression = models.CharField(
|
||
null=True,
|
||
blank=True,
|
||
max_length=255,
|
||
verbose_name="Cron表达式",
|
||
help_text="Cron表达式",
|
||
db_comment='Cron表达式' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 执行状态
|
||
# ----------------------------------------------------------
|
||
# 状态常量定义
|
||
STATUS_CHOICES = (
|
||
(0, "正常"), # 执行成功
|
||
(1, "失败"), # 执行失败
|
||
)
|
||
|
||
# 字段说明: 任务的执行结果状态
|
||
# 字段类型: 无符号整数（PositiveIntegerField）
|
||
# 约束: 使用 STATUS_CHOICES 限制可选值，默认值为0（正常）
|
||
# 索引: 添加了数据库索引（db_index=True）以支持状态筛选
|
||
# 可选值: 0-正常, 1-失败
|
||
status = models.PositiveIntegerField(
|
||
choices=STATUS_CHOICES,
|
||
null=False,
|
||
default=0,
|
||
db_index=True,
|
||
verbose_name="执行状态：0-正常 1-失败",
|
||
help_text="执行状态：0-正常 1-失败",
|
||
db_comment='执行状态：0-正常 1-失败', # 数据库字段注释
|
||
db_default=0
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 执行开始时间
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务开始执行的时间点
|
||
# 字段类型: 日期时间（DateTimeField）
|
||
# 约束: 允许为空（null=True, blank=True）
|
||
# 作用: 记录任务开始执行的时间，用于计算耗时和性能分析
|
||
start_time = models.DateTimeField(
|
||
null=True,
|
||
blank=True,
|
||
verbose_name="执行开始时间",
|
||
help_text="执行开始时间",
|
||
db_comment='执行开始时间' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 执行结束时间
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务执行结束的时间点
|
||
# 字段类型: 日期时间（DateTimeField）
|
||
# 约束: 允许为空（null=True, blank=True）
|
||
# 作用: 记录任务执行结束的时间，用于计算耗时和性能分析
|
||
end_time = models.DateTimeField(
|
||
null=True,
|
||
blank=True,
|
||
verbose_name="执行结束时间",
|
||
help_text="执行结束时间",
|
||
db_comment='执行结束时间' # 数据库字段注释
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 执行耗时
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务执行消耗的时间
|
||
# 字段类型: 无符号整数（PositiveIntegerField）
|
||
# 约束: 非空（null=False），默认值为0
|
||
# 单位: 毫秒（ms）
|
||
# 作用: 记录任务执行耗时，用于性能监控
|
||
consume_time = models.PositiveIntegerField(
|
||
null=False,
|
||
default=0,
|
||
verbose_name="执行耗时(毫秒)",
|
||
help_text="执行耗时，单位：毫秒"
|
||
)
|
||
|
||
# ----------------------------------------------------------
|
||
# 异常信息
|
||
# ----------------------------------------------------------
|
||
# 字段说明: 任务执行失败时的异常信息
|
||
# 字段类型: 文本（TextField）
|
||
# 约束: 允许为空（null=True, blank=True）
|
||
# 作用: 记录任务执行失败时的详细异常堆栈，便于排错
|
||
exception_info = models.TextField(
|
||
null=True,
|
||
blank=True,
|
||
verbose_name="异常信息",
|
||
help_text="异常信息",
|
||
db_comment='异常信息' # 数据库字段注释
|
||
)
|
||
|
||
# =============================================================
|
||
# 模型元数据配置
|
||
# =============================================================
|
||
|
||
class Meta:
|
||
"""
|
||
模型元数据配置类
|
||
|
||
定义模型在数据库中的表名、显示名称、默认排序规则等。
|
||
"""
|
||
|
||
# 数据表名
|
||
# 使用配置文件中的表前缀 + "job_log"
|
||
db_table = get_table_name('job_log')
|
||
|
||
# 数据表注释
|
||
db_table_comment = "任务ID"
|
||
|
||
# 模型在admin后台显示的友好名称（单数）
|
||
verbose_name = "定时任务日志表"
|
||
|
||
# 模型在admin后台显示的友好名称（复数）
|
||
verbose_name_plural = verbose_name
|
||
|
||
# 默认排序规则
|
||
# 按照创建时间倒序排列，最新的日志显示在最前面
|
||
ordering = ("-create_time",)
|
||
|
||
# 索引定义
|
||
# 为常用查询字段添加组合索引，提高查询效率
|
||
indexes = [
|
||
models.Index(fields=['job_id', 'status'], name='idx_job_status'),
|
||
models.Index(fields=['start_time'], name='idx_start_time'),
|
||
]
|
||
|
||
# =============================================================
|
||
# 实例方法
|
||
# =============================================================
|
||
|
||
def __str__(self):
|
||
"""
|
||
模型的字符串表示方法
|
||
|
||
当需要将模型实例转换为字符串时调用，如admin后台显示、日志输出等。
|
||
|
||
Returns:
|
||
str: 包含任务名称和执行状态的字符串
|
||
"""
|
||
status_str = "成功" if self.status == 0 else "失败"
|
||
return f"任务日志-{self.job_name}[{status_str}]"
|