Springboot动态创建定时任务

原创沐清沐清的小屋

“ Springboot提供了@Scheduled注解来方便我们创建定时任务，可是如果我们需要动态创建定时任务呢？今天我们就一起来看下Springboot如何动态创建定时任务。”

动态创建定时任务，我最开始想到的是quartz框架。可是我们的动态定时任务需求比较简单，仅仅需要在某个时刻执行某个任务即可，不需要这么强大的框架。因此，我们的首要方案就是看能不能利用Springboot自带的工具来实现。经过查看源码，我发现Springboot还真提供这些功能，下面我们就简单来看下。

其中比较重要的代码，均在spring-context的scheduling包下。

查看其中的TaskScheduler接口，我们发现其中有个方法正和我们的需求相符。

这个方法就是在某个时间执行某个任务，和我们需求一致，接下来我们就来看下怎么用这个接口。通过idea可以发现这个接口有三个实现类，经过对比，我选择了ThreadPoolTaskScheduler这个类(当然也可以直接使用此接口)。

接下来，我们就用这个类，来实现我们的定时任务的动态创建。

首先，我们先创建一个测试任务，实现Runnable接口即可

// java14以下，手动将record类转为普通类public record TestRunnable(String name) implements Runnable {
    @Override    public void run() {        System.out.println("定时任务" + name + "执行了");    }}

接着，我们对外创建一个controller

@RestControllerpublic class TestController {
    private final ThreadPoolTaskScheduler taskScheduler;    // 用ConcurrentHashMap来存放我们的定时任务集合，方便增删    private final Map<String, ScheduledFuture<?>> scheduledTasks;
    public TestController(ThreadPoolTaskScheduler taskScheduler) {        this.taskScheduler = taskScheduler;        scheduledTasks = new ConcurrentHashMap<>(16);    }
    @GetMapping("/add")    public String add(@RequestParam("name") String name) {        Calendar calendar = Calendar.getInstance();        calendar.setTime(new Date());        calendar.add(Calendar.SECOND, 10);        addTask("testTask", new TestRunnable(name), calendar.getTime());        return "success";    }
    @GetMapping("/remove")    public String remove(@RequestParam("name") String name) {        removeTask(name);        return "success";    }
    private void addTask(String taskName, Runnable task, Date startTime) {        if (scheduledTasks.containsKey(taskName)){            removeTask(taskName);        }        ScheduledFuture<?> schedule = taskScheduler.schedule(task, startTime);        scheduledTasks.put(taskName, schedule);    }
    private void removeTask(String taskName) {        ScheduledFuture<?> scheduledFuture = scheduledTasks.get(taskName);        scheduledFuture.cancel(true);        scheduledTasks.remove(taskName);    }}

因为是简单测试，就先没有把代码独立出来。

然后我们启动项目，在浏览器访问添加定时任务的接口（设置为10秒后执行）。

过了10秒后，确实执行了测试任务。

当然了，上面这个只是简单的演示。仅仅提供一个思路给大家。作为项目代码使用的话，肯定要独立出来并且要丰富相关功能，这里由于篇幅，就不过多介绍了，下次如果有时间我可以再分享出来。

查看Springboot提供的接口，我们可以发现，Springboot为我们提供了丰富的接口用来调度定时任务。大家也可以下去好好研究以下。

package org.springframework.scheduling;
import java.time.Clock;import java.time.Duration;import java.time.Instant;import java.util.Date;import java.util.concurrent.ScheduledFuture;import org.springframework.lang.Nullable;
// spring调度接口源码public interface TaskScheduler {    default Clock getClock() {        return Clock.systemDefaultZone();    }
    @Nullable    ScheduledFuture<?> schedule(Runnable task, Trigger trigger);
    default ScheduledFuture<?> schedule(Runnable task, Instant startTime) {        return this.schedule(task, Date.from(startTime));    }
    ScheduledFuture<?> schedule(Runnable task, Date startTime);
    default ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Instant startTime, Duration period) {        return this.scheduleAtFixedRate(task, Date.from(startTime), period.toMillis());    }
    ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Date startTime, long period);
    default ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Duration period) {        return this.scheduleAtFixedRate(task, period.toMillis());    }
    ScheduledFuture<?> scheduleAtFixedRate(Runnable task, long period);
    default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Instant startTime, Duration delay) {        return this.scheduleWithFixedDelay(task, Date.from(startTime), delay.toMillis());    }
    ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Date startTime, long delay);
    default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, Duration delay) {        return this.scheduleWithFixedDelay(task, delay.toMillis());    }
    ScheduledFuture<?> scheduleWithFixedDelay(Runnable task, long delay);}

--End--

继续滑动看下一个