签入版本

This commit is contained in:
2026-09-12 11:46:38 +08:00
commit c5a9d20cb8
932 changed files with 116861 additions and 0 deletions
View File
+3
View File
@@ -0,0 +1,3 @@
from django.contrib import admin
# Register your models here.
+64
View File
@@ -0,0 +1,64 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
定时任务日志应用配置模块
=============================================================
该模块定义了定时任务日志管理应用的配置类,用于Django应用注册和初始化。
"""
from django.apps import AppConfig
class JobLogConfig(AppConfig):
"""定时任务日志应用配置类"""
# 指定默认的主键字段类型
# 使用 BigAutoField 可以支持更大的数据量,适合高并发场景
default_auto_field = 'django.db.models.BigAutoField'
# 指定该应用在项目中的Python导入路径
# 格式为 '应用所在模块.应用名称'
name = 'application.job_log'
# 应用在admin后台显示的友好名称
verbose_name = "定时任务日志管理"
View File
@@ -0,0 +1,44 @@
# Generated by Django 6.0.3 on 2026-09-04 11:44
from django.db import migrations, models
class Migration(migrations.Migration):
initial = True
dependencies = [
]
operations = [
migrations.CreateModel(
name='JobLog',
fields=[
('job_id', models.PositiveIntegerField(db_comment='任务ID', db_default=0, db_index=True, default=0, help_text='任务ID', verbose_name='任务ID')),
('job_name', models.CharField(db_comment='任务名称', help_text='任务名称', max_length=255, verbose_name='任务名称')),
('job_group', models.CharField(blank=True, db_comment='任务分组', help_text='任务分组', max_length=255, null=True, verbose_name='任务分组')),
('job_trigger', models.CharField(blank=True, db_comment='任务触发器', help_text='任务触发器', max_length=255, null=True, verbose_name='任务触发器')),
('job_message', models.CharField(blank=True, db_comment='任务日志信息', help_text='任务日志信息', max_length=500, null=True, verbose_name='任务日志信息')),
('cron_expression', models.CharField(blank=True, db_comment='Cron表达式', help_text='Cron表达式', max_length=255, null=True, verbose_name='Cron表达式')),
('status', models.PositiveIntegerField(choices=[(0, '正常'), (1, '失败')], db_comment='执行状态:0-正常 1-失败', db_default=0, db_index=True, default=0, help_text='执行状态:0-正常 1-失败', verbose_name='执行状态:0-正常 1-失败')),
('start_time', models.DateTimeField(blank=True, db_comment='执行开始时间', help_text='执行开始时间', null=True, verbose_name='执行开始时间')),
('end_time', models.DateTimeField(blank=True, db_comment='执行结束时间', help_text='执行结束时间', null=True, verbose_name='执行结束时间')),
('consume_time', models.PositiveIntegerField(default=0, help_text='执行耗时,单位:毫秒', verbose_name='执行耗时(毫秒)')),
('exception_info', models.TextField(blank=True, db_comment='异常信息', help_text='异常信息', null=True, verbose_name='异常信息')),
('id', models.AutoField(auto_created=True, db_comment='主键ID', primary_key=True, serialize=False, verbose_name='主键ID')),
('create_user', models.CharField(db_comment='创建人', db_default=None, default=None, max_length=50, null=True, verbose_name='创建人')),
('create_time', models.DateTimeField(auto_now_add=True, db_comment='创建时间', max_length=11, null=True, verbose_name='创建时间')),
('update_user', models.CharField(db_comment='更新人', db_default=None, default=None, max_length=50, null=True, verbose_name='更新人')),
('update_time', models.DateTimeField(auto_now=True, db_comment='更新时间', max_length=11, null=True, verbose_name='更新时间')),
('is_delete', models.BooleanField(db_comment='逻辑删除:0-正常 1-已删除', db_default=0, default=0, verbose_name='逻辑删除')),
],
options={
'verbose_name': '定时任务日志表',
'verbose_name_plural': '定时任务日志表',
'db_table': 'django_job_log',
'db_table_comment': '任务ID',
'ordering': ('-create_time',),
'indexes': [models.Index(fields=['job_id', 'status'], name='idx_job_status'), models.Index(fields=['start_time'], name='idx_start_time')],
},
),
]
+319
View File
@@ -0,0 +1,319 @@
# +======================================================================
# | 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}]"
+418
View File
@@ -0,0 +1,418 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
定时任务日志服务模块
=============================================================
该模块实现了定时任务日志管理相关的所有业务逻辑。
包括日志的分页查询、详情查询、清理、导出等功能。
定时任务日志用于记录系统中所有定时任务的执行情况,便于监控和排错。
功能模块:
1. 分页查询:支持按任务名称、状态、时间范围等条件筛选
2. 详情查询:根据ID获取单条日志的详细信息
3. 日志清理:支持按时间或条件批量清理历史日志
4. 统计功能:统计任务执行成功率、平均耗时等
5. 数据导出:导出日志数据用于分析
"""
import logging
from datetime import datetime, timedelta
from django.core.paginator import Paginator, PageNotAnInteger, InvalidPage, EmptyPage
from application.job_log.models import JobLog
from constant.constants import PAGE_SIZE
from utils import R
from utils.common import format_datetime, parse_request_body
# =============================================================
# 分页查询服务
# =============================================================
def get_job_log_page(request):
"""
查询定时任务日志分页数据
Args:
request: HttpRequest对象,包含查询参数
- pageNo: 当前页码(可选,默认为1)
- pageSize: 每页记录数(可选,默认为PAGE_SIZE)
- jobName: 任务名称(可选,模糊查询)
- jobGroup: 任务分组(可选,精确匹配)
- status: 执行状态(可选,0-正常 1-失败)
- startTime: 开始时间范围起始(可选)
- endTime: 开始时间范围结束(可选)
Returns:
R: 包含分页数据的JSON响应
"""
try:
# 获取分页参数
page_no = int(request.GET.get('pageNo', 1))
page_size = int(request.GET.get('pageSize', PAGE_SIZE))
# 构建基础查询(只查询未删除的)
query = JobLog.objects.filter(is_delete=False)
# 应用筛选条件
query = _apply_filters(query, request)
# 排序(默认按创建时间倒序)
query = query.order_by("-create_time")
# 分页查询
paginator = Paginator(query, page_size)
try:
page_list = paginator.page(page_no)
except (PageNotAnInteger, InvalidPage, EmptyPage):
page_list = paginator.page(1)
page_no = 1
# 构建返回数据
page_data = _build_page_data(page_list, paginator, page_no, page_size)
return R.ok(data=page_data)
except Exception as e:
logging.error(f"查询定时任务日志分页数据异常: {str(e)}")
return R.failed(msg="查询失败,请稍后重试")
def _apply_filters(queryset, request):
"""
应用查询筛选条件
Args:
queryset: 初始查询集
request: HttpRequest对象
Returns:
QuerySet: 应用筛选后的查询集
"""
# 任务名称模糊筛选
job_name = request.GET.get('jobName')
if job_name:
queryset = queryset.filter(job_name__contains=job_name)
# 任务分组精确筛选
job_group = request.GET.get('jobGroup')
if job_group:
queryset = queryset.filter(job_group=job_group)
# 执行状态筛选
status = request.GET.get('status')
if status and status.isdigit():
queryset = queryset.filter(status=int(status))
# 任务ID筛选
job_id = request.GET.get('jobId')
if job_id and job_id.isdigit():
queryset = queryset.filter(job_id=int(job_id))
# 开始时间范围筛选
start_time = request.GET.get('startTime')
if start_time:
try:
queryset = queryset.filter(start_time__gte=start_time)
except Exception:
pass
end_time = request.GET.get('endTime')
if end_time:
try:
# 将结束日期加一天,包含当天的所有记录
end_date = datetime.strptime(end_time, '%Y-%m-%d')
next_day = end_date + timedelta(days=1)
queryset = queryset.filter(start_time__lt=next_day)
except Exception:
pass
return queryset
def _build_page_data(page_list, paginator, page_no, page_size):
"""
构建分页返回数据
Args:
page_list: 当前页数据列表
paginator: 分页器对象
page_no: 当前页码
page_size: 每页大小
Returns:
dict: 分页数据
"""
records = []
for item in page_list:
records.append({
'id': item.id,
'jobId': item.job_id,
'jobName': item.job_name,
'jobGroup': item.job_group,
'jobTrigger': item.job_trigger,
'jobMessage': item.job_message,
'cronExpression': item.cron_expression,
'status': item.status,
'startTime': format_datetime(item.start_time),
'endTime': format_datetime(item.end_time),
'consumeTime': item.consume_time,
'exceptionInfo': item.exception_info,
'createTime': format_datetime(item.create_time),
})
return {
'records': records,
'total': paginator.count,
'size': page_size,
'current': page_no,
'pages': paginator.num_pages
}
# =============================================================
# 详情查询服务
# =============================================================
def get_job_log_detail(log_id):
"""
根据ID查询定时任务日志详情
Args:
log_id: 日志ID
Returns:
dict/None: 日志详情或None
"""
try:
log = JobLog.objects.filter(is_delete=False, id=log_id).first()
if not log:
return None
return {
'id': log.id,
'jobId': log.job_id,
'jobName': log.job_name,
'jobGroup': log.job_group,
'jobTrigger': log.job_trigger,
'jobMessage': log.job_message,
'cronExpression': log.cron_expression,
'status': log.status,
'startTime': format_datetime(log.start_time),
'endTime': format_datetime(log.end_time),
'consumeTime': log.consume_time,
'exceptionInfo': log.exception_info,
'createUser': log.create_user,
'createTime': format_datetime(log.create_time),
}
except Exception as e:
logging.error(f"查询日志详情异常,ID: {log_id}, 错误: {str(e)}")
return None
# =============================================================
# 日志清理服务
# =============================================================
def clean_job_logs(request):
"""
清理定时任务日志(支持按条件清理)
Args:
request: HttpRequest对象,包含清理条件
- cleanType: 清理类型(1-保留最近30天,2-保留最近60天,3-保留最近90天,4-全部清理)
- jobId: 指定任务ID(可选)
- status: 指定状态(可选)
Returns:
R: 操作结果
"""
# 解析请求参数
data, error = parse_request_body(request)
if error:
return R.failed(msg=error)
try:
clean_type = data.get('cleanType')
if not clean_type:
return R.failed("请选择清理类型")
# 构建查询条件
query = JobLog.objects.filter(is_delete=False)
# 按清理类型设置时间条件
if clean_type in [1, 2, 3]:
days_map = {1: 30, 2: 60, 3: 90}
days = days_map.get(clean_type)
cutoff_date = datetime.now() - timedelta(days=days)
query = query.filter(create_time__lt=cutoff_date)
elif clean_type == 4:
# 全部清理,不添加时间条件
pass
else:
return R.failed("无效的清理类型")
# 可选:按任务ID筛选
job_id = data.get('jobId')
if job_id and str(job_id).isdigit():
query = query.filter(job_id=int(job_id))
# 可选:按状态筛选
status = data.get('status')
if status and str(status).isdigit():
query = query.filter(status=int(status))
# 统计要清理的记录数
clean_count = query.count()
if clean_count == 0:
return R.ok(msg="没有符合条件的日志需要清理")
# 执行清理(逻辑删除)
updated_count = query.update(is_delete=True)
return R.ok(msg=f"共清理{updated_count}条日志记录")
except Exception as e:
logging.error(f"清理定时任务日志异常: {str(e)}")
return R.failed(msg="清理失败,请稍后重试")
# =============================================================
# 删除服务(支持批量)
# =============================================================
def delete_job_logs(log_ids):
"""
批量删除定时任务日志(逻辑删除)
Args:
log_ids: 日志ID字符串,多个ID用逗号分隔
Returns:
R: 操作结果
"""
if not log_ids:
return R.failed("记录ID不存在")
try:
# 解析ID列表
id_list = [int(id_str.strip()) for id_str in log_ids.split(',') if id_str.strip()]
if not id_list:
return R.failed("无效的记录ID")
# 批量逻辑删除
updated_count = JobLog.objects.filter(
id__in=id_list,
is_delete=False
).update(is_delete=True)
return R.ok(msg=f"本次共删除{updated_count}条数据")
except ValueError:
return R.failed("记录ID格式错误")
except Exception as e:
logging.error(f"删除日志异常,IDs: {log_ids}, 错误: {str(e)}")
return R.failed(msg="删除失败,请稍后重试")
# =============================================================
# 日志导出服务
# =============================================================
def export_job_logs(request):
"""
导出定时任务日志数据
Args:
request: HttpRequest对象,包含筛选条件
Returns:
HttpResponse: CSV文件响应
"""
try:
# 构建查询
query = JobLog.objects.filter(is_delete=False)
# 应用筛选条件
query = _apply_filters(query, request)
# 限制导出数量
max_export = 10000
if query.count() > max_export:
return R.failed(f"导出数据不能超过{max_export}条,请缩小筛选范围")
# 排序
query = query.order_by("-create_time")
# 构建导出数据
import csv
from django.http import HttpResponse
response = HttpResponse(content_type='text/csv')
response[
'Content-Disposition'] = f'attachment; filename="job_logs_{datetime.now().strftime("%Y%m%d%H%M%S")}.csv"'
writer = csv.writer(response)
writer.writerow(['日志ID', '任务ID', '任务名称', '任务分组', '状态', '开始时间', '结束时间',
'耗时(ms)', '日志信息', 'Cron表达式'])
for log in query:
writer.writerow([
log.id,
log.job_id,
log.job_name,
log.job_group or '',
'成功' if log.status == 0 else '失败',
format_datetime(log.start_time) or '',
format_datetime(log.end_time) or '',
log.consume_time,
log.job_message or '',
log.cron_expression or ''
])
return response
except Exception as e:
logging.error(f"导出日志数据异常: {str(e)}")
return R.failed(msg="导出失败,请稍后重试")
+3
View File
@@ -0,0 +1,3 @@
from django.test import TestCase
# Create your tests here.
+106
View File
@@ -0,0 +1,106 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
定时任务日志模块路由配置
=============================================================
URL端点概览:
------------------------------------------------------------------------
| 功能说明 | 请求方法 | URL路径 | 视图类 |
|-----------------|----------|-----------------------------|-----------------------|
| 分页查询 | GET | /job/log/page | JobLogPageView |
| 详情查询 | GET | /job/log/detail/<id> | JobLogDetailView |
| 清理日志 | POST | /job/log/clean | JobLogCleanView |
| 统计信息 | GET | /job/log/statistics | JobLogStatisticsView |
| 删除日志 | DELETE | /job/log/delete/<ids> | JobLogDeleteView |
| 导出日志 | GET | /job/log/export | JobLogExportView |
------------------------------------------------------------------------
URL参数说明:
- log_id: int类型,日志ID(用于查询详情)
- log_ids: str类型,逗号分隔的日志ID字符串(用于批量删除)
使用示例:
1. 分页查询:GET /api/job/log/page?pageNo=1&pageSize=10&jobName=同步&status=0
2. 详情查询:GET /api/job/log/detail/5
3. 清理日志:POST /api/job/log/clean
4. 删除日志:DELETE /api/job/log/delete/1,2,3
5. 导出日志:GET /api/job/log/export?jobName=同步&startTime=2023-01-01
"""
from django.urls import path
from application.job_log import views
# 定时任务日志模块路由配置
urlpatterns = [
# 查询日志分页列表
# URL: /job/log/page
# 请求方法: GET
# 功能: 获取日志分页数据,支持按任务名称、状态、时间范围等条件筛选
path('page', views.JobLogPageView.as_view()),
# 查询日志详情
# URL: /job/log/detail/<int:log_id>
# 请求方法: GET
# URL参数: log_id - 日志ID(整数类型)
# 功能: 根据ID获取指定日志的详细信息
path('detail/<int:log_id>', views.JobLogDetailView.as_view()),
# 清理日志
# URL: /job/log/clean
# 请求方法: POST
# 功能: 按条件清理历史日志记录(如保留最近30天)
path('clean', views.JobLogCleanView.as_view()),
# 删除日志
# URL: /job/log/delete/<str:log_ids>
# 请求方法: DELETE
# URL参数: log_ids - 日志ID字符串,支持单个ID或逗号分隔的多个ID
# 功能: 删除指定日志(逻辑删除,设置is_delete=True)
path('delete/<str:log_ids>', views.JobLogDeleteView.as_view()),
# 导出日志数据
# URL: /job/log/export
# 请求方法: GET
# 功能: 导出符合条件的日志数据为CSV文件
path('export', views.JobLogExportView.as_view()),
]
+260
View File
@@ -0,0 +1,260 @@
# +======================================================================
# | DjangoAdmin 企业数字化开发平台 [ 赋能开发者,助力企业发展 ]
# +----------------------------------------------------------------------
# | Copyright (c) 2021-2026 小蚂蚁云团队 版权所有
# +----------------------------------------------------------------------
# | 开源协议: Apache-2.0
# | 重要声明: 未经书面许可,不得移除或修改本框架相关版权标识。
# +----------------------------------------------------------------------
# | 官方网站: https://www.djangoadmin.cn
# +----------------------------------------------------------------------
# | 研发团队: 小蚂蚁云团队 荣誉出品
# +======================================================================
# | 版权和免责声明:
# | 一、知识产权声明
# | 本团队对该软件框架产品(以下简称“本产品”)拥有完整知识产权,包括但不限于商标权、专利权、
# | 著作权、商业秘密等。前述权利均受中华人民共和国及相关国际法律法规保护。未经本团队书面授权,
# | 任何个人或单位不得基于本产品本身申请任何形式的知识产权。
# | 二、使用限制与禁止条款
# | 您理解并同意,禁止将本产品用于以下任何行为:
# | 1. 任何违反中华人民共和国法律法规的用途;
# | 2. 任何侵害他人合法权益(包括但不限于人身权、财产权、知识产权等)的行为;
# | 3. 任何危害国家安全、公共利益及社会道德风尚的行为。
# | 三、责任豁免
# | 因使用本产品而产生的任何损失或法律纠纷(包括但不限于直接损失、间接损失、附带损失、衍生损失
# | 以及因违约、侵权等引发的责任),本团队均不承担任何法律责任。若因违规使用本产品导致任何第三
# | 方提起索赔或行政机关进行调查,您应独立承担全部责任。
# | 四、违约与法律责任
# | 如发现任何违反本声明的行为,本团队有权:
# | 1. 无条件配合公安机关及其他有权机关的调查取证工作;
# | 2. 依法追究相关方的民事责任,并要求赔偿全部损失;
# | 3. 保留进一步采取刑事控告等法律措施的权利。
# | 五、许可范围说明
# | 1、被授权方应视本产品源代码为核心机密信息,负有最高标准的保密与保管义务。禁止以任何形式(包
# | 括但不限于直接或间接的分享、复制、传播、分发、转售、出租、开源、反向工程、反编译、反汇编或通
# | 过网络服务提供给任何第三方)泄露、披露或处置源代码的全部或部分内容。任何未经授权的复制、使用、
# | 传播行为均构成对本团队知识产权的严重侵权,本团队有权依法追究其全部法律责任,并要求赔偿因此造
# | 成的一切经济损失及商誉损害。
# | 2、本产品仅限于公司或个人在法律允许范围内,用于内部且合规的软件产品研发。具体权利义务以《软件
# | 许可协议》附件为准。
# +======================================================================
"""
定时任务日志视图模块
=============================================================
该模块定义了定时任务日志管理功能中使用的所有视图类。
用于处理定时任务日志信息的HTTP请求,包括分页查询、详情查询、
日志清理、统计信息、删除和导出等操作。
"""
from django.utils.decorators import method_decorator
from django.views import View
from application.job_log import services
from application.operation_log.constants import LogType
from application.operation_log.decorators import operation_log
from config.env import DJANGO_DEMO
from middleware.login_middleware import check_login
from middleware.permission_middleware import PermissionRequired
from utils import R
# =============================================================
# 分页查询视图
# =============================================================
@method_decorator(check_login, name="get")
class JobLogPageView(PermissionRequired, View):
"""
定时任务日志分页数据查询视图
处理GET请求,返回定时任务日志列表的分页数据。
支持按任务名称、状态、时间范围等条件筛选。
URL: /job/log/page
请求方法: GET
权限要求:sys:joblog:page
"""
# 方法权限标识
permission_required = ("sys:joblog:page",)
@operation_log(
title="定时任务日志-查询分页列表",
log_type=LogType.QUERY
)
def get(self, request):
"""
处理GET请求,返回日志分页数据
Args:
request: HttpRequest对象,包含分页参数和筛选条件
Returns:
JsonResponse: 包含分页数据的JSON响应
"""
result = services.get_job_log_page(request)
return result
# =============================================================
# 详情查询视图
# =============================================================
@method_decorator(check_login, name="get")
class JobLogDetailView(PermissionRequired, View):
"""
日志详情查询视图
处理GET请求,根据日志ID返回详细信息。
URL: /job/log/detail/<int:log_id>
请求方法: GET
URL参数: log_id - 日志ID
权限要求:sys:joblog:detail
"""
# 方法权限标识
permission_required = ("sys:joblog:detail",)
@operation_log(
title="定时任务日志-查询记录详情",
log_type=LogType.QUERY
)
def get(self, request, log_id):
"""
处理GET请求,返回日志详情
Args:
request: HttpRequest对象
log_id: int, 日志ID
Returns:
JsonResponse: 包含日志详细信息的JSON响应
"""
data = services.get_job_log_detail(log_id)
if data:
return R.ok(data=data)
return R.failed(msg="日志不存在")
# =============================================================
# 日志清理视图
# =============================================================
@method_decorator(check_login, name="post")
class JobLogCleanView(PermissionRequired, View):
"""
日志清理视图
处理POST请求,按条件清理历史日志记录。
URL: /job/log/clean
请求方法: POST
权限要求:sys:joblog:clean
"""
# 方法权限标识
permission_required = ("sys:joblog:clean",)
@operation_log(
title="定时任务日志-清空记录",
log_type=LogType.CLEAN
)
def post(self, request):
"""
处理POST请求,清理日志
Args:
request: HttpRequest对象,包含清理条件
Returns:
JsonResponse: 包含操作结果的JSON响应
"""
# 演示环境禁止操作
if DJANGO_DEMO:
return R.failed("演示环境,暂无操作权限")
result = services.clean_job_logs(request)
return result
# =============================================================
# 删除视图(支持批量)
# =============================================================
@method_decorator(check_login, name="delete")
class JobLogDeleteView(PermissionRequired, View):
"""
删除日志视图
处理DELETE请求,删除指定日志(支持批量删除)。
URL: /job/log/delete/<str:log_ids>
请求方法: DELETE
URL参数: log_ids - 日志ID字符串,多个ID用逗号分隔
权限要求:sys:joblog:delete
"""
# 方法权限标识
permission_required = ('sys:joblog:delete',)
@operation_log(
title="定时任务日志-删除记录",
log_type=LogType.DELETE
)
def delete(self, request, log_ids):
"""
处理DELETE请求,删除日志
Args:
request: HttpRequest对象
log_ids: str, 日志ID字符串,多个ID用逗号分隔
Returns:
JsonResponse: 包含操作结果的JSON响应
"""
# 演示环境禁止操作
if DJANGO_DEMO:
return R.failed("演示环境,暂无操作权限")
result = services.delete_job_logs(log_ids)
return result
# =============================================================
# 日志导出视图
# =============================================================
@method_decorator(check_login, name="get")
class JobLogExportView(PermissionRequired, View):
"""
日志导出视图
处理GET请求,导出符合条件的日志数据为CSV文件。
URL: /job/log/export
请求方法: GET
权限要求:sys:joblog:export
"""
# 方法权限标识
permission_required = ("sys:joblog:export",)
@operation_log(
title="定时任务日志-导出Excel文件",
log_type=LogType.EXPORT
)
def get(self, request):
"""
处理GET请求,导出日志数据
Args:
request: HttpRequest对象,包含筛选条件
Returns:
HttpResponse: CSV文件响应或JSON错误信息
"""
result = services.export_job_logs(request)
return result