程序员之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Springboot动态定时任务

Springboot实现动态定时任务流程详解

 更新时间：2022年09月10日 11:41:17   作者：CzRger  
通过重写SchedulingConfigurer方法实现对定时任务的操作，单次执行、停止、启动三个主要的基本功能，动态的从数据库中获取配置的定时任务cron信息，通过反射的方式灵活定位到具体的类与方法中
（福利推荐：【腾讯云】服务器最新限时优惠活动，云服务器1核2G仅99元/年、2核4G仅768元/3年，立即抢购>>>：9i0i.cn/qcloud）

（福利推荐：你还在原价购买阿里云服务器？现在阿里云0.8折限时抢购活动来啦！4核8G企业云服务器仅2998元/3年，立即抢购>>>：9i0i.cn/aliyun）

一、静态

静态的定时任务可以直接使用注解@Scheduled，并在启动类上配置@EnableScheduling即可

  @PostMapping("/list/test1")
  @Async
  @Scheduled(cron = "0 * * * * ?")
  public void test1() throws Exception {
    Object obj = this.getClass().newInstance();
    log.info("执行静态定时任务时间/test1：param:{}", new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()));
  }

二、动态

动态的定时任务需要根据ScheduledTaskRegistrar的addTriggerTask方法进行实现，网上大多数资料是在Trigger中动态查询cron表达式来实现，但存在一个问题就是只有在下一次执行的时候才会刷新，比如一开始设置的每天12点执行一次，如果项目启动后，修改为每小时执行一次的话，需要等到下一次12点执行之后，才会刷新cron表达式，所以通过对ScheduledTaskRegistrar的源码分析，构建了以下解决方案，可以实现对定时任务的额单次额外执行、停止、启动三个基本功能。在此只列出关键代码，关于项目启动、数据库连接的代码等就不过多说明了。

1、基本代码

首先新建定时任务信息的库表及实体类

@Data
@EqualsAndHashCode(callSuper = false)
@TableName("cron")
public class Cron implements Serializable {
    private static final long serialVersionUID = 1L;
    @TableId(value = "id", type = IdType.ASSIGN_UUID)
    private String id;
    private String cronFlag;
    private String cronExpression;
    private String className;
    private String methodName;
}

用于获取bean实例的工具类

@Component
public class BeansUtils implements ApplicationContextAware {
  private static ApplicationContext context;
  public static <T> T getBean(Class<T> bean) {
    return context.getBean(bean);
  }
  public static <T> T getBean(String var1, @Nullable Class<T> var2){
    return context.getBean(var1, var2);
  }
  public static ApplicationContext getContext() {
    return context;
  }
  public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
    context = applicationContext;
  }
}

实现定时任务类

@Configuration
@EnableScheduling
@EnableAsync
@Slf4j
public class RCScheduleTask implements SchedulingConfigurer {
  @Autowired
  private ICronService iCronService;
  private static ScheduledTaskRegistrar scheduledTaskRegistrar;
  public static Map<String, TriggerTask> triggerTaskMap;
  @Override
  public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
    scheduledTaskRegistrar = taskRegistrar;
    Cron cron = new Cron();
    cron.setCronFlag("1");
    List<Cron> list = iCronService.getList(cron);
    if (list != null) {
      initTriggerTask(list);
    }
  }
  public void initTriggerTask(List<Cron> list) {
    triggerTaskMap = new HashMap<>();
    for (Cron cron : list) {
      TriggerTask triggerTask = new TriggerTask(getRunnable(cron), getTrigger(cron));
      scheduledTaskRegistrar.addTriggerTask(triggerTask);
      triggerTaskMap.put(cron.getId(), triggerTask);
    }
  }
  private static Runnable getRunnable(Cron cron) {
    return new Runnable() {
      @Override
      public void run() {
        Class<?> clazz;
        try {
          clazz = Class.forName(cron.getClassName());
          Object bean = BeansUtils.getBean(clazz);
          Method method = ReflectionUtils.findMethod(bean.getClass(), cron.getMethodName());
          ReflectionUtils.invokeMethod(method, bean);
        } catch (Exception e) {
          e.printStackTrace();
        }
      }
    };
  }
  private static Trigger getTrigger(Cron cron) {
    return new Trigger() {
      @Override
      public Date nextExecutionTime(TriggerContext triggerContext) {
        CronTrigger trigger = new CronTrigger(cron.getCronExpression());
        Date nextExec = trigger.nextExecutionTime(triggerContext);
        return nextExec;
      }
    };
  }
  public static boolean run(String id) {
    TriggerTask tt = triggerTaskMap.get(id);
    if (tt != null) {
      tt.getRunnable().run();
      return true;
    }
    return false;
  }
  public static boolean stop(String id) {
    TriggerTask tt = triggerTaskMap.get(id);
    if (tt != null) {
      Set<ScheduledTask> scheduledTasks = scheduledTaskRegistrar.getScheduledTasks();
      for (ScheduledTask st:scheduledTasks) {
        boolean b = st.getTask().getRunnable() == tt.getRunnable();
        if (b) {
          st.cancel();
          return true;
        }
      }
    }
    return false;
  }
  public static boolean start(Cron cron) throws Exception {
    try {
      triggerTaskMap.remove(cron.getId());
      TriggerTask tt = new TriggerTask(getRunnable(cron), getTrigger(cron));
      triggerTaskMap.put(cron.getId(), tt);
      scheduledTaskRegistrar.scheduleTriggerTask(tt);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
    }
    return false;
  }
}

控制调用类，RCResult为自定义封装的返回结果类，可自行定义

@RestController
@RequestMapping("/cron")
@Slf4j
public class CronController {
  @Autowired
  private ICronService iCronService;
  @Autowired
  private RCScheduleTask rcScheduleTask;
  @GetMapping("/task/1")
  @Async
  public void task1() {
    log.info("模拟任务1-执行时间:{}", new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()));
  }
  @GetMapping("/task/2")
  @Async
  public void task2() {
    log.info("模拟任务2-执行时间:{}", new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()));
  }
  @GetMapping("/task/3")
  @Async
  public void task3() {
    log.info("模拟任务3-执行时间:{}", new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()));
  }
  @GetMapping("/run/{id}")
  public RCResult run(@PathVariable("id") String id) {
    Boolean b = RCScheduleTask.run(id);
    if (b) {
      return RCResult.ok("执行任务" + id + "成功");
    }
    return RCResult.error("执行任务" + id + "失败");
  }
  @GetMapping("/stop/{id}")
  public RCResult stop(@PathVariable("id") String id) {
    Boolean b = RCScheduleTask.stop(id);
    if (b) {
      return RCResult.ok("停止任务" + id + "成功");
    }
    return RCResult.error("停止任务" + id + "失败");
  }
  @GetMapping("/start/{id}")
  public RCResult start(@PathVariable("id") String id) throws Exception {
    Cron cron = iCronService.getById(id);
    if (cron != null) {
      Boolean b = RCScheduleTask.start(cron);
      if (b) {
        return RCResult.ok("开始任务" + id + "成功");
      }
    }
    return RCResult.error("开始任务" + id + "失败");
  }
}

2、方案详解

2.1 初始化

通过@EnableScheduling和@EnableAsync两个标签，开启定时任务和多线程

@Configuration
@EnableScheduling
@EnableAsync
@Slf4j
public class RCScheduleTask implements SchedulingConfigurer {

重写SchedulingConfigurer的configureTasks方法，可以在项目启动时自动加载状态为启用（cron_flag为1）定时任务列表

@Override
  public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
    scheduledTaskRegistrar = taskRegistrar;
    Cron cron = new Cron();
    cron.setCronFlag("1");
    List<Cron> list = iCronService.getList(cron);
    if (list != null) {
      initTriggerTask(list);
    }
  }

TriggerTask创建的两个参数Runnable和Trigger可以理解为实现的操作和执行的周期，在Runnable中我们通过反射的方式，从库中取到调用方法的类名和方法名，来执行接口操作，在Trigger中我们根据库中的cron表达式来设置执行周期

public void initTriggerTask(List<Cron> list) {
    triggerTaskMap = new HashMap<>();
    for (Cron cron : list) {
      TriggerTask triggerTask = new TriggerTask(getRunnable(cron), getTrigger(cron));
      scheduledTaskRegistrar.addTriggerTask(triggerTask);
      triggerTaskMap.put(cron.getId(), triggerTask);
    }
  }
  private static Runnable getRunnable(Cron cron) {
    return new Runnable() {
      @Override
      public void run() {
        Class<?> clazz;
        try {
          clazz = Class.forName(cron.getClassName());
          Object bean = BeansUtils.getBean(clazz);
          Method method = ReflectionUtils.findMethod(bean.getClass(), cron.getMethodName());
          ReflectionUtils.invokeMethod(method, bean);
        } catch (Exception e) {
          e.printStackTrace();
        }
      }
    };
  }
  private static Trigger getTrigger(Cron cron) {
    return new Trigger() {
      @Override
      public Date nextExecutionTime(TriggerContext triggerContext) {
        CronTrigger trigger = new CronTrigger(cron.getCronExpression());
        Date nextExec = trigger.nextExecutionTime(triggerContext);
        return nextExec;
      }
    };
  }

库表数据

从执行结果中可以看到状态为已启用的task1和task2执行了，而task3并没有执行

2.2 单次执行

我们可以通过获取TriggerTask的Runnable来执行run()方法，来单次执行定时任务

任务类中定义run方法

public static boolean run(String id) {
    TriggerTask tt = triggerTaskMap.get(id);
    if (tt != null) {
      tt.getRunnable().run();
      return true;
    }
    return false;
  }

接口调用

@GetMapping("/run/{id}")
  public RCResult run(@PathVariable("id") String id) {
    Boolean b = RCScheduleTask.run(id);
    if (b) {
      return RCResult.ok("执行任务" + id + "成功");
    }
    return RCResult.error("执行任务" + id + "失败");
  }

模拟接口调用

从调用结果中可以看到，task1在06秒的时候单独执行了一次，并且没有影响后续执行

2.3 停止任务

停止任务需要执行ScheduledTask类的cancel()方法，由于在初始化时通过addTriggerTask方法并不会立刻加入到ScheduledTask列表中，所以需要在调用时通过ScheduledTaskRegistrar获取ScheduledTask列表，然后与TriggerTask的Runnable进行比较判断是否一致

任务类中定义stop

public static boolean stop(String id) {
    TriggerTask tt = triggerTaskMap.get(id);
    if (tt != null) {
      Set<ScheduledTask> scheduledTasks = scheduledTaskRegistrar.getScheduledTasks();
      for (ScheduledTask st:scheduledTasks) {
        boolean b = st.getTask().getRunnable() == tt.getRunnable();
        if (b) {
          st.cancel();
          return true;
        }
      }
    }
    return false;
  }

调用

@GetMapping("/stop/{id}")
  public RCResult stop(@PathVariable("id") String id) {
    Boolean b = RCScheduleTask.stop(id);
    if (b) {
      return RCResult.ok("停止任务" + id + "成功");
    }
    return RCResult.error("停止任务" + id + "失败");
  }

在调用结果中可以看到，task1不再执行了

2.4 启用任务

启用任务需要通过ScheduledTaskRegistrar的scheduleTriggerTask()方法进行调用，由于源码中并未提供针对Runnable或Trigger的单独修改方法，所以在这里我们通过新建实例进行替换，在执行前先停止任务

public static boolean start(Cron cron) throws Exception {
    try {
      stop(cron.getId());
      triggerTaskMap.remove(cron.getId());
      TriggerTask tt = new TriggerTask(getRunnable(cron), getTrigger(cron));
      triggerTaskMap.put(cron.getId(), tt);
      scheduledTaskRegistrar.scheduleTriggerTask(tt);
      return true;
    } catch (Exception e) {
      e.printStackTrace();
    }
    return false;
  }

调用

@GetMapping("/start/{id}")
  public RCResult start(@PathVariable("id") String id) throws Exception {
    Cron cron = iCronService.getById(id);
    if (cron != null) {
      Boolean b = RCScheduleTask.start(cron);
      if (b) {
        return RCResult.ok("开始任务" + id + "成功");
      }
    }
    return RCResult.error("开始任务" + id + "失败");
  }

通过调用结果，可以看到在启用后，task1重新加入到定时任务队列中了

在修改task1的执行周期后再次调用start方法

从调用结果中可以看到，task1的周期已被更改

三、小结

昨天刚接触定时任务，一开始也是在网上搜索资料，后来发现案例都无法满足自身需求，或者只是讲解怎么使用，根本无法映射到实际业务上，所以通过对源码的分析，一层层的梳理，模拟了此篇关于定时任务的解决方案，由于时间原因，在此省略了前端界面的编写，但大多数实际需求无非也就是通过一个开关或按钮来对任务进行启用、停止操作，或者额外需要单次执行任务，在此对动态定时任务的方案进行记录，同时也希望能帮助到遇到同样问题的同学们

到此这篇关于Springboot实现动态定时任务流程详解的文章就介绍到这了,更多相关Springboot动态定时任务内容请搜索程序员之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持程序员之家！

您可能感兴趣的文章:

相关文章

  • 深入剖析java中的集合框架

    深入剖析java中的集合框架

    下面小编就为大家带来一篇深入剖析java中的集合框架。小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2016-05-05
  • 通过反射实现Java下的委托机制代码详解

    通过反射实现Java下的委托机制代码详解

    这篇文章主要介绍了通过反射实现Java下的委托机制代码详解，具有一定借鉴价值，需要的朋友可以参考下。
    2017-12-12
  • Spring一步到位精通拦截器

    Spring一步到位精通拦截器

    拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行。本文将详细讲讲SpringMVC中拦截器的概念及入门案例，感兴趣的可以尝试一下
    2023-01-01
  • IDEA添加Java类注释模版的方法

    IDEA添加Java类注释模版的方法

    本篇文章主要介绍了IDEA添加Java类注释模版的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-12-12
  • java高效实现大文件拷贝功能

    java高效实现大文件拷贝功能

    这篇文章主要为大家详细介绍了java高效实现大文件拷贝功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2019-05-05
  • Java调用shell命令涉及管道、重定向时不生效问题及解决

    Java调用shell命令涉及管道、重定向时不生效问题及解决

    这篇文章主要介绍了Java调用shell命令涉及管道、重定向时不生效问题及解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-12-12
  • springboot中Excel文件下载踩坑大全

    springboot中Excel文件下载踩坑大全

    本文主要介绍了springboot中Excel文件下载，但是却容易遇到很多坑，文中通过示例代码介绍的非常详细，感兴趣的小伙伴们可以参考一下
    2021-07-07
  • 十道java华为编程大赛题目

    十道java华为编程大赛题目

    这篇文章主要为大家分享了十道java华为编程大赛题目，代码经过调试，经典的java编程题，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-03-03
  • 从Java的jar文件中读取数据的方法

    从Java的jar文件中读取数据的方法

    这篇文章主要介绍了从Java的jar文件中读取数据的方法,实例分析了java档案文件的相关操作技巧,需要的朋友可以参考下
    2015-06-06
  • 基于maven的springboot的"过时"用法解析

    基于maven的springboot的"过时"用法解析

    这篇文章主要为大家介绍了基于maven的springboot"过时"用法示例解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2023-09-09

最新评论

?


http://www.vxiaotou.com