SpringBoot动态定时任务(完整版)

72 0 0

一、执行定时任务的线程池配置类

@Configuration
@EnableAsync
public class TaskPoolConfig {

    /**
     * 异步执行线程池————任务延时执行
     * @return  ThreadPoolTaskScheduler
     */
    @Bean(name = "delayAsyncPoolTaskScheduler")
    public ThreadPoolTaskScheduler delayAsyncPoolTaskScheduler() {
        ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
        //线程池维护线程的数量
        threadPoolTaskScheduler.setPoolSize(1);
        // 线程名称
        threadPoolTaskScheduler.setThreadNamePrefix("delayAsyncPoolTaskScheduler--");
        // 等待时长
        threadPoolTaskScheduler.setAwaitTerminationSeconds(60);
        // 调度器shutdown被调用时等待当前被调度的任务完成
        threadPoolTaskScheduler.setWaitForTasksToCompleteOnShutdown(true);
        threadPoolTaskScheduler.initialize();
        return threadPoolTaskScheduler;
    }
}

二、ScheduledFuture的包装类

ScheduledFuture是ScheduledExecutorService定时任务线程池的执行结果。

public final class ScheduledTask {

    volatile ScheduledFuture<?> future;
    /**
     * 取消定时任务
     */
    public void cancel() {
        ScheduledFuture<?> future = this.future;
        if (future != null) {
            future.cancel(true);
        }
    }
}

三、定时任务注册类

用来增加、删除定时任务

@Component
public class CronTaskRegistrar implements DisposableBean {

    private final Map<String, ScheduledTask> scheduledTasks = new ConcurrentHashMap<>(16);

    @Autowired
    private ThreadPoolTaskScheduler delayAsyncPoolTaskScheduler;

    public ThreadPoolTaskScheduler getScheduler() {
        return this.delayAsyncPoolTaskScheduler;
    }

    public void addCronTask(String jobId, Runnable task, String cronExpression) {
        addCronTask(jobId, new CronTask(task, cronExpression));
    }

    public void addCronTask(String jobId, CronTask cronTask) {
        if (cronTask != null) {
            Runnable task = cronTask.getRunnable();
            if (this.scheduledTasks.containsKey(jobId)) {
                removeCronTask(jobId);
            }

            this.scheduledTasks.put(jobId, scheduleCronTask(cronTask));
        }
    }

    public void removeCronTask(String jobId) {
        ScheduledTask scheduledTask = this.scheduledTasks.remove(jobId);
        if (scheduledTask != null)
            scheduledTask.cancel();
    }

    public ScheduledTask scheduleCronTask(CronTask cronTask) {
        ScheduledTask scheduledTask = new ScheduledTask();
        scheduledTask.future = delayAsyncPoolTaskScheduler.schedule(cronTask.getRunnable(), cronTask.getTrigger());

        return scheduledTask;
    }


    @Override
    public void destroy() {
        for (ScheduledTask task : this.scheduledTasks.values()) {
            task.cancel();
        }
        this.scheduledTasks.clear();
    }
}

四、定时任务预热

spring boot项目启动完成后，加载数据库里状态为正常的定时任务

@Component
@Slf4j
public class SysJobRunner implements CommandLineRunner {

    @Autowired
    private CronTaskRegistrar cronTaskRegistrar;

    DateTimeFormatter formatter= DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");

    @Override
    public void run(String... args) {
        // 初始加载数据库里状态为正常的定时任务
        List<String> list = Stream.of("1", "2").collect(Collectors.toList());
        list.forEach(jobId -> {
            Runnable task = () -> {
                System.out.println(formatter.format(LocalDateTime.now()) + "--任务组编排任务执行---" + jobId);
            };
            cronTaskRegistrar.addCronTask(jobId, task, "10 * * * * ?");
        });
        /*ScheduleSetting existedSysJob = new ScheduleSetting();
        List<ScheduleSetting> jobList = existedSysJob.selectList(new QueryWrapper<ScheduleSetting>().eq("job_status", 1));
        if (CollectionUtils.isNotEmpty(jobList)) {
            for (ScheduleSetting job : jobList) {
                SchedulingRunnable task = new SchedulingRunnable(job.getBeanName(), job.getMethodName(), job.getMethodParams());
                cronTaskRegistrar.addCronTask(task, job.getCronExpression());
            }
            logger.info("定时任务已加载完毕...");
        }*/
    }
}

五、定时任务的：增/删/改/启动/暂停

@RestController
@RequestMapping("/api/test")
public class TestController {

    @Resource
    private CronTaskRegistrar cronTaskRegistrar;
    
    DateTimeFormatter formatter= DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");


    /**
     * 添加定时任务
     *
     * @param
     * @return
     */
    @GetMapping("/add")
    public boolean add(String jobId) {
        Runnable task = () -> {
            System.out.println(formatter.format(LocalDateTime.now()) + "--任务组编排任务执行---" + jobId);
        };
        cronTaskRegistrar.addCronTask(jobId, task, "10 * * * * ?");
        return Boolean.TRUE;
    }

    /**
     * 修改定时任务
     *
     * @return
     */
    @GetMapping("/update")
    public boolean update(String jobId) {
        // 修改成功,则先删除任务器中的任务,并重新添加

        cronTaskRegistrar.removeCronTask(jobId);
        Runnable task = () -> {
            System.out.println(formatter.format(LocalDateTime.now()) + "--任务组编排任务执行---" + jobId);
        };
        cronTaskRegistrar.addCronTask("4", task, "5 * * * * ?");
        return Boolean.TRUE;
    }

    @GetMapping("/del")
    public boolean del(String jobId) {
        cronTaskRegistrar.removeCronTask(jobId);
        return Boolean.TRUE;
    }

    // 停止/启动任务
    @GetMapping("/changesStatus")
    public boolean changesStatus(String jobId) {
        // 查询修改前任务

        // 修改任务

        // 修改成功,则先删除任务器中的任务,并重新添加
        cronTaskRegistrar.removeCronTask(jobId);
        Runnable task = () -> {
            System.out.println(formatter.format(LocalDateTime.now()) + "--任务组编排任务执行---" + jobId);
        };
        cronTaskRegistrar.addCronTask(jobId, task, "10 * * * * ?");
        return true;
    }
}

cron

cron表达式语法：

[秒] [分] [小时] [日] [月] [周] [年]

注：[年]不是必须的域，可以省略[年]，则一共6个域

通配符说明：

*：表示所有值。例如:在分的字段上设置 *,表示每一分钟都会触发。
?：表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为”?” 具体设置为 0 0 0 10 * ?
–：表示区间。例如在小时上设置 “10-12”,表示 10,11,12点都会触发。
,：表示指定多个值，例如在周字段上设置 “MON,WED,FRI” 表示周一，周三和周五触发
/：用于递增触发。如在秒上面设置”5/15” 表示从5秒开始，每增15秒触发(5,20,35,50)。在日字段上设置’1/3’所示每月1号开始，每隔三天触发一次。
L：表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会依据是否是润年[leap]), 在周字段上表示星期六，相当于”7”或”SAT”。如果在”L”前加上数字，则表示该数据的最后一个。例如在周字段上设置”6L”这样的格式,则表示“本月最后一个星期五”
W：表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上置”15W”，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 “1W”,它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，”W”前只能设置具体的数字,不允许区间”-“)。
#：序号(表示每月的第几个周几)，例如在周字段上设置”6#3”表示在每月的第三个周六.注意如果指定”#5”,正好第五周没有周六，则不会触发该配置(用在母亲节和父亲节再合适不过了) ；小提示：’L’和 ‘W’可以一组合使用。如果在日字段上设置”LW”,则表示在本月的最后一个工作日触发；周字段的设置，若使用英文字母是不区分大小写的，即MON与mon相同。

示例：

每隔5秒执行一次：*/5 * * * * ?
每隔1分钟执行一次：0 */1 * * * ?
每天23点执行一次：0 0 23 * * ?
每天凌晨1点执行一次：0 0 1 * * ?
每月1号凌晨1点执行一次：0 0 1 1 * ?
每月最后一天23点执行一次：0 0 23 L * ?
每周星期六凌晨1点实行一次：0 0 1 ? * L
在26分、29分、33分执行一次：0 26,29,33 * * * ?
每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 * * ?

cron在线表达式生成器：https://cron.12qqe2.com/

参考：
https://blog.csdn.net/weixin_46522803/article/details/127313780

# 随笔