django-celery-beat 获取下一次执行时间

前言

因为业务需要获取下一次执行时间在前端展示，查阅百度，谷歌都没能找到实现方式。通过官方文档https://django-celery-beat.readthedocs.io/en/latest/reference/django-celery-beat.tzcrontab.html了解到有相应的实现。

官方文档解读

在django_celery_beat.tzcrontab类下面有个is_due(last_run_at)是计算下一次执行时间的方法，它的返回值是（is_due， next_time_to_check）。
当is_due为true时，next_time_to_check是下一次执行时间距离last_run_at秒数。但是当is_due为false时，next_time_to_check是下一次的检查时间，不符合业务需要。

深入源码

1. 通过查看源码的实现，发现主要实现的逻辑在于这三句话，重点是调用了self.remaining_estimate去计算时间
   

2. 时间增量具体计算逻辑实现，通过解析cron表达式去计算下一次执行的时间相距多少。
   

3. 以下是remaining_delta的返回值
   

4. 拿到remaining_delta的返回值去计算开始时间+增量时间得到下一次执行时间的一个估算。
   

5. 代码具体实现

def get_next_time(task_name):
    per_task = celery_models.PeriodicTask.objects.filter(name=task_name).first()
    logger.info(f"per_task:{per_task}")
    if per_task and per_task.enabled:
        # 如果任务存在并且开启，则计算下次执行时间
        # 当前任务没有最后执行时间时，选择当前时间进行计算
        last_run_at = per_task.last_run_at or datetime.now(tz=pytz.timezone('Asia/Shanghai'))
        # per_task.last_run_at
        cron_exp = {
            "minute": per_task.crontab.minute,
            "hour": per_task.crontab.hour,
            "day_of_week": per_task.crontab.day_of_week,
            "day_of_month": per_task.crontab.day_of_month,
            "month_of_year": per_task.crontab.month_of_year,
            "tz": pytz.timezone('Asia/Shanghai')
        }
        tza = TzAwareCrontab(**cron_exp)
        tza.remaining_estimate(last_run_at)
        # 计算下次执行时间
        logger.info(f"任务表达式: {cron_exp}")
        logger.info(f"剩余_增量: {tza.remaining_delta(last_run_at)}")
        next_run_time = datetime.now() + tza.remaining_estimate(last_run_at)
        logger.info(f"【{task_name}】时间：{last_run_at}")
        logger.info(f"【{task_name}】时间差：{tza.remaining_estimate(last_run_at)}")
        logger.info(f"【{task_name}】计算表达式：{cron_exp}")
        logger.info(f"【{task_name}】下次运行时间：{next_run_time}")
        return str(next_run_time)
    else:
        return ''

6. 时区配置（重新配置时区后需要更新定时任务的时间，具体可以看官方文档，亦或者你把定时任务全删掉，重新添加也可行。）

celery配置文件加入这两行代码

# celery时区设置，建议与Django settings中TIME_ZONE同样时区，防止时差
# Django设置时区需同时设置USE_TZ=True和TIME_ZONE = 'Asia/Shanghai'
timezone = 'Asia/Shanghai'
# 避免时区的问题
enable_utc = True


django settings.py文件加入
TIME_ZONE = 'Asia/Shanghai'
USE_TZ = True
DJANGO_CELERY_BEAT_TZ_AWARE = False