Spring Boot 定时任务，怎么实现任务动态增删启停？

待我称王封你为后i 2022-08-28 05:58 182阅读 0赞

**点击关注公众号，Java干货****及时送达**![f3a47b876699963ddcc39a9027ecccc5.png][]

作者：jessehua  
链接：https://www.jianshu.com/p/0f68936393fd

在spring boot项目中，可以通过@EnableScheduling注解和@Scheduled注解实现定时任务，也可以通过SchedulingConfigurer接口来实现定时任务。但是这两种方式不能动态添加、删除、启动、停止任务。要实现动态增删启停定时任务功能，比较广泛的做法是集成Quartz框架。

但是本人的开发原则是：在满足项目需求的情况下，尽量少的依赖其它框架，避免项目过于臃肿和复杂。查看spring-context这个jar包中org.springframework.scheduling.ScheduledTaskRegistrar这个类的源代码，发现可以通过改造这个类就能实现动态增删启停定时任务功能。

![11003bc874be97a9b7a88634a48cf76c.png][] 定时任务列表页 ![9bfdcdb2469e3cbdd68f898900e4739e.png][] 定时任务执行日志

[添加执行定时任务的线程池配置类][Link 1]

@Configuration
    public class SchedulingConfig {
        @Bean
        public TaskScheduler taskScheduler() {
            ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
            // 定时任务执行线程池核心线程数
            taskScheduler.setPoolSize(4);
            taskScheduler.setRemoveOnCancelPolicy(true);
            taskScheduler.setThreadNamePrefix("TaskSchedulerThreadPool-");
            return taskScheduler;
        }
    }

[添加ScheduledFuture的包装类。ScheduledFuture是ScheduledExecutorService定时任务线程池的执行结果。][Link 1]

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

[添加Runnable接口实现类，被定时任务线程池调用，用来执行指定bean里面的方法。Spring Boot 学习笔记这个分享给你。][Link 1]

public class SchedulingRunnable implements Runnable {
    
        private static final Logger logger = LoggerFactory.getLogger(SchedulingRunnable.class);
    
        private String beanName;
    
        private String methodName;
    
        private String params;
    
        public SchedulingRunnable(String beanName, String methodName) {
            this(beanName, methodName, null);
        }
    
        public SchedulingRunnable(String beanName, String methodName, String params) {
            this.beanName = beanName;
            this.methodName = methodName;
            this.params = params;
        }
    
        @Override
        public void run() {
            logger.info("定时任务开始执行 - bean：{}，方法：{}，参数：{}", beanName, methodName, params);
            long startTime = System.currentTimeMillis();
    
            try {
                Object target = SpringContextUtils.getBean(beanName);
    
                Method method = null;
                if (StringUtils.isNotEmpty(params)) {
                    method = target.getClass().getDeclaredMethod(methodName, String.class);
                } else {
                    method = target.getClass().getDeclaredMethod(methodName);
                }
    
                ReflectionUtils.makeAccessible(method);
                if (StringUtils.isNotEmpty(params)) {
                    method.invoke(target, params);
                } else {
                    method.invoke(target);
                }
            } catch (Exception ex) {
                logger.error(String.format("定时任务执行异常 - bean：%s，方法：%s，参数：%s ", beanName, methodName, params), ex);
            }
    
            long times = System.currentTimeMillis() - startTime;
            logger.info("定时任务执行结束 - bean：{}，方法：{}，参数：{}，耗时：{} 毫秒", beanName, methodName, params, times);
        }
    
        @Override
        public boolean equals(Object o) {
            if (this == o) return true;
            if (o == null || getClass() != o.getClass()) return false;
            SchedulingRunnable that = (SchedulingRunnable) o;
            if (params == null) {
                return beanName.equals(that.beanName) &&
                        methodName.equals(that.methodName) &&
                        that.params == null;
            }
    
            return beanName.equals(that.beanName) &&
                    methodName.equals(that.methodName) &&
                    params.equals(that.params);
        }
    
        @Override
        public int hashCode() {
            if (params == null) {
                return Objects.hash(beanName, methodName);
            }
    
            return Objects.hash(beanName, methodName, params);
        }
    }

[添加定时任务注册类，用来增加、删除定时任务。][Link 1]

@Component
    public class CronTaskRegistrar implements DisposableBean {
    
        private final Map<Runnable, ScheduledTask> scheduledTasks = new ConcurrentHashMap<>(16);
    
        @Autowired
        private TaskScheduler taskScheduler;
    
        public TaskScheduler getScheduler() {
            return this.taskScheduler;
        }
    
        public void addCronTask(Runnable task, String cronExpression) {
            addCronTask(new CronTask(task, cronExpression));
        }
    
        public void addCronTask(CronTask cronTask) {
            if (cronTask != null) {
                Runnable task = cronTask.getRunnable();
                if (this.scheduledTasks.containsKey(task)) {
                    removeCronTask(task);
                }
    
                this.scheduledTasks.put(task, scheduleCronTask(cronTask));
            }
        }
    
        public void removeCronTask(Runnable task) {
            ScheduledTask scheduledTask = this.scheduledTasks.remove(task);
            if (scheduledTask != null)
                scheduledTask.cancel();
        }
    
        public ScheduledTask scheduleCronTask(CronTask cronTask) {
            ScheduledTask scheduledTask = new ScheduledTask();
            scheduledTask.future = this.taskScheduler.schedule(cronTask.getRunnable(), cronTask.getTrigger());
    
            return scheduledTask;
        }
    
    
        @Override
        public void destroy() {
            for (ScheduledTask task : this.scheduledTasks.values()) {
                task.cancel();
            }
    
            this.scheduledTasks.clear();
        }
    }

[添加定时任务示例类][Link 1]

@Component("demoTask")
    public class DemoTask {
        public void taskWithParams(String params) {
            System.out.println("执行有参示例任务：" + params);
        }
    
        public void taskNoParams() {
            System.out.println("执行无参示例任务");
        }
    }

[定时任务数据库表设计][Link 1]

![ba2c859bd1a8d153d91a1e77bcd0a19f.png][] 定时任务数据库表设计

添加定时任务实体类

Spring Boot 基础就不介绍了，推荐下这个实战教程：

https://github.com/javastacks/spring-boot-best-practice

public class SysJobPO {
        /**
         * 任务ID
         */
        private Integer jobId;
        /**
         * bean名称
         */
        private String beanName;
        /**
         * 方法名称
         */
        private String methodName;
        /**
         * 方法参数
         */
        private String methodParams;
        /**
         * cron表达式
         */
        private String cronExpression;
        /**
         * 状态（1正常 0暂停）
         */
        private Integer jobStatus;
        /**
         * 备注
         */
        private String remark;
        /**
         * 创建时间
         */
        private Date createTime;
        /**
         * 更新时间
         */
        private Date updateTime;
    
        public Integer getJobId() {
            return jobId;
        }
    
        public void setJobId(Integer jobId) {
            this.jobId = jobId;
        }
    
        public String getBeanName() {
            return beanName;
        }
    
        public void setBeanName(String beanName) {
            this.beanName = beanName;
        }
    
        public String getMethodName() {
            return methodName;
        }
    
        public void setMethodName(String methodName) {
            this.methodName = methodName;
        }
    
        public String getMethodParams() {
            return methodParams;
        }
    
        public void setMethodParams(String methodParams) {
            this.methodParams = methodParams;
        }
    
        public String getCronExpression() {
            return cronExpression;
        }
    
        public void setCronExpression(String cronExpression) {
            this.cronExpression = cronExpression;
        }
    
        public Integer getJobStatus() {
            return jobStatus;
        }
    
        public void setJobStatus(Integer jobStatus) {
            this.jobStatus = jobStatus;
        }
    
        public String getRemark() {
            return remark;
        }
    
        public void setRemark(String remark) {
            this.remark = remark;
        }
    
        public Date getCreateTime() {
            return createTime;
        }
    
        public void setCreateTime(Date createTime) {
            this.createTime = createTime;
        }
    
        public Date getUpdateTime() {
            return updateTime;
        }
    
        public void setUpdateTime(Date updateTime) {
            this.updateTime = updateTime;
        }
    
    }

**点击关注公众号，Java干货****及时送达**![c638471acc27a1fdca836b39029f626c.png][]

新增定时任务

![f5bf341cf5525c90e029545bedfd8460.png][] 新增定时任务

[新增定时任务][Link 1]

boolean success = sysJobRepository.addSysJob(sysJob);
    if (!success)
        return OperationResUtils.fail("新增失败");
    else {
        if (sysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {
            SchedulingRunnable task = new SchedulingRunnable(sysJob.getBeanName(), sysJob.getMethodName(), sysJob.getMethodParams());
            cronTaskRegistrar.addCronTask(task, sysJob.getCronExpression());
        }
    }
    
    return OperationResUtils.success();

[修改定时任务，先移除原来的任务，再启动新任务][Link 1]

boolean success = sysJobRepository.editSysJob(sysJob);
    if (!success)
        return OperationResUtils.fail("编辑失败");
    else {
        //先移除再添加
        if (existedSysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {
            SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
            cronTaskRegistrar.removeCronTask(task);
        }
    
        if (sysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {
            SchedulingRunnable task = new SchedulingRunnable(sysJob.getBeanName(), sysJob.getMethodName(), sysJob.getMethodParams());
            cronTaskRegistrar.addCronTask(task, sysJob.getCronExpression());
        }
    }
    
    return OperationResUtils.success();

[删除定时任务][Link 1]

boolean success = sysJobRepository.deleteSysJobById(req.getJobId());
    if (!success)
        return OperationResUtils.fail("删除失败");
    else{
        if (existedSysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {
            SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
            cronTaskRegistrar.removeCronTask(task);
        }
    }
    
    return OperationResUtils.success();

[定时任务启动/停止状态切换][Link 1]

if (existedSysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {
        SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
        cronTaskRegistrar.addCronTask(task, existedSysJob.getCronExpression());
    } else {
        SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
        cronTaskRegistrar.removeCronTask(task);
    }

[添加实现了CommandLineRunner接口的SysJobRunner类，当spring boot项目启动完成后，加载数据库里状态为正常的定时任务。另外，Spring Boot 系列面试题和答案全部整理好了，微信搜索Java技术栈，在后台发送：面试，可以在线阅读。][Link 1]

@Service
    public class SysJobRunner implements CommandLineRunner {
    
        private static final Logger logger = LoggerFactory.getLogger(SysJobRunner.class);
    
        @Autowired
        private ISysJobRepository sysJobRepository;
    
        @Autowired
        private CronTaskRegistrar cronTaskRegistrar;
    
        @Override
        public void run(String... args) {
            // 初始加载数据库里状态为正常的定时任务
            List<SysJobPO> jobList = sysJobRepository.getSysJobListByStatus(SysJobStatus.NORMAL.ordinal());
            if (CollectionUtils.isNotEmpty(jobList)) {
                for (SysJobPO job : jobList) {
                    SchedulingRunnable task = new SchedulingRunnable(job.getBeanName(), job.getMethodName(), job.getMethodParams());
                    cronTaskRegistrar.addCronTask(task, job.getCronExpression());
                }
    
                logger.info("定时任务已加载完毕...");
            }
        }
    }

[工具类SpringContextUtils，用来从spring容器里获取bean][Link 1]

@Component
    public class SpringContextUtils implements ApplicationContextAware {
    
        private static ApplicationContext applicationContext;
    
        @Override
        public void setApplicationContext(ApplicationContext applicationContext)
                throws BeansException {
            SpringContextUtils.applicationContext = applicationContext;
        }
    
        public static Object getBean(String name) {
            return applicationContext.getBean(name);
        }
    
        public static <T> T getBean(Class<T> requiredType) {
            return applicationContext.getBean(requiredType);
        }
    
        public static <T> T getBean(String name, Class<T> requiredType) {
            return applicationContext.getBean(name, requiredType);
        }
    
        public static boolean containsBean(String name) {
            return applicationContext.containsBean(name);
        }
    
        public static boolean isSingleton(String name) {
            return applicationContext.isSingleton(name);
        }
    
        public static Class<? extends Object> getType(String name) {
            return applicationContext.getType(name);
        }
    }

![803843fb50ad4d71ec3a27d30f88e0df.gif][]

[![6541251cd2da8625b9667eee77610f06.png][]][6541251cd2da8625b9667eee77610f06.png 1]

[![29aec4ccf23ad3b66b39add0faf36d60.png][]][29aec4ccf23ad3b66b39add0faf36d60.png 1]

[![5a3604906b56b6f76361ed6fa0b93759.png][]][5a3604906b56b6f76361ed6fa0b93759.png 1]

[![d1b29afd77df0c05cfd7c6e6cbb08673.png][]][d1b29afd77df0c05cfd7c6e6cbb08673.png 1]

[![4c0357acc6d7c82986b78b131f3d5753.png][]][4c0357acc6d7c82986b78b131f3d5753.png 1]

[![dbcf63457dce7462465fcb2e099e36c0.png][]][dbcf63457dce7462465fcb2e099e36c0.png 1]

[![d9b37c8474ad100bb9b5a8e83f8061ea.png][]][d9b37c8474ad100bb9b5a8e83f8061ea.png 1]

**关注Java技术栈看更多干货**

![3836b80a517770b847581d4826c44d6b.png][]

![c80346cd6212a46f15fe6fdcbe84652e.gif][]

获取 Spring Boot 实战笔记！

[f3a47b876699963ddcc39a9027ecccc5.png]: /images/20220828/1c85beb647ba41f4b924cfbe3ca6685b.png
[11003bc874be97a9b7a88634a48cf76c.png]: https://img-blog.csdnimg.cn/img_convert/11003bc874be97a9b7a88634a48cf76c.png
[9bfdcdb2469e3cbdd68f898900e4739e.png]: /images/20220828/3956033f8f95490da5bc604b8b209985.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247540947&idx=2&sn=7faf14de2e31d03167128d6d3cc8c795&chksm=eb50a5e5dc272cf320c15c50f14bc97d3b98aa1e60fec5460824be0f057cb15ed82ba5ed2787&scene=21#wechat_redirect
[ba2c859bd1a8d153d91a1e77bcd0a19f.png]: /images/20220828/1357fdef27ff4310a8091241a95e4c87.png
[c638471acc27a1fdca836b39029f626c.png]: /images/20220828/8968b1a682ac4ec8b6a0903cea5bcf9e.png
[f5bf341cf5525c90e029545bedfd8460.png]: /images/20220828/85cb8cdb06884d5c910a631e336080bc.png
[803843fb50ad4d71ec3a27d30f88e0df.gif]: /images/20220828/b104de91a521460cae882e8b71179c4f.png
[6541251cd2da8625b9667eee77610f06.png]: /images/20220828/fbc700885216449db13e0d9cd3030d01.png
[6541251cd2da8625b9667eee77610f06.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247545151&idx=1&sn=3011ea02ff69b7d841dc86caaa5666b7&scene=21#wechat_redirect
[29aec4ccf23ad3b66b39add0faf36d60.png]: /images/20220828/a5e2ae4db74843ee919f67445f89ae1f.png
[29aec4ccf23ad3b66b39add0faf36d60.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247545678&idx=1&sn=a430fb2e260c200dc79fe37f5382868e&scene=21#wechat_redirect
[5a3604906b56b6f76361ed6fa0b93759.png]: /images/20220828/07ce8c28a3a04d0fb4eb61bda82fc579.png
[5a3604906b56b6f76361ed6fa0b93759.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247545350&idx=1&sn=c1bbc0bd21799c3d936d59ecdaf97f8e&scene=21#wechat_redirect
[d1b29afd77df0c05cfd7c6e6cbb08673.png]: /images/20220828/752b1681a93e40d9a5b7654f140669fe.png
[d1b29afd77df0c05cfd7c6e6cbb08673.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247539795&idx=1&sn=1efca511169265e8146e90db220159d5&scene=21#wechat_redirect
[4c0357acc6d7c82986b78b131f3d5753.png]: /images/20220828/fd930d9001d74c0a8dc21f764d1d1ad2.png
[4c0357acc6d7c82986b78b131f3d5753.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247542231&idx=1&sn=75ab147414255cc18c26b03746833be8&scene=21#wechat_redirect
[dbcf63457dce7462465fcb2e099e36c0.png]: /images/20220828/5e827587581f4088a6d7918eaeb7d50f.png
[dbcf63457dce7462465fcb2e099e36c0.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247537730&idx=1&sn=3869e164e482b838671fa8896cb33cdb&scene=21#wechat_redirect
[d9b37c8474ad100bb9b5a8e83f8061ea.png]: /images/20220828/74174f0112a84e11ba9f215e3b009a1e.png
[d9b37c8474ad100bb9b5a8e83f8061ea.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw==&mid=2247546343&idx=1&sn=b85c30a38d535a1c219b2c72f52a9cb1&scene=21#wechat_redirect
[3836b80a517770b847581d4826c44d6b.png]: /images/20220828/0bc5a91f5ed9442cba5119357c505f9b.png
[c80346cd6212a46f15fe6fdcbe84652e.gif]: /images/20220828/3cb5574955f0490ea07e99f460d2193f.png