告别硬编码，SpringBoot实现动态增删启停定时任务

向右看齐 2022-08-29 12:59 134阅读 0赞

**点击关注公众号，利用****碎片时间学习****![4ef8b6f672d6547d44887f9f0049241b.png][]**

在spring boot项目中，可以通过`@EnableScheduling`注解和@Scheduled注解实现定时任务，也可以通过SchedulingConfigurer接口来实现定时任务。但是这两种方式不能动态添加、删除、启动、停止任务。

要实现动态增删启停定时任务功能，比较广泛的做法是集成Quartz框架。但是本人的开发原则是：在满足项目需求的情况下，尽量少的依赖其它框架，避免项目过于臃肿和复杂。

查看spring-context这个jar包中`org.springframework.scheduling.ScheduledTaskRegistrar`这个类的源代码，发现可以通过改造这个类就能实现动态增删启停定时任务功能。

![a5e3c696acc737ef884bd492a0e1e737.png][] 定时任务列表页 ![bea095c85a0c4dab86fdd381e6992435.png][] 定时任务执行日志

添加执行定时任务的线程池配置类

@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定时任务线程池的执行结果。

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

添加Runnable接口实现类，被定时任务线程池调用，用来执行指定bean里面的方法。

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);  
        }  
    }

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

@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();  
        }  
    }

添加定时任务示例类

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

定时任务数据库表设计

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

添加定时任务实体类

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;  
        }  
      
    }

新增定时任务

![4d800d5e96ec6cc802cd3309e1a63ae2.png][] 新增定时任务

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();

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

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();

删除定时任务

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();

定时任务启动/停止状态切换

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项目启动完成后，加载数据库里状态为正常的定时任务。另外，欢迎关注公众号Java笔记虾，后台回复“后端面试”，送你一份面试题宝典！

@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

@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);  
        }  
    }

本文完，参考本文代码可成功运行，亲测！

*（感谢阅读，希望对你所有帮助)*

*来源：www.jianshu.com/p/0f68936393fd*

推荐好文

[强大，10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程！][10k_ SpringBoot]

[分享一套基于SpringBoot和Vue的企业级中后台开源项目，代码很规范！][SpringBoot_Vue]

[能挣钱的，开源 SpringBoot 商城系统，功能超全，超漂亮][SpringBoot]![9cd807467e893952470e55928901937b.png][]

[4ef8b6f672d6547d44887f9f0049241b.png]: /images/20220829/8483003577e7475abbc218c8b88e14ea.png
[a5e3c696acc737ef884bd492a0e1e737.png]: https://img-blog.csdnimg.cn/img_convert/a5e3c696acc737ef884bd492a0e1e737.png
[bea095c85a0c4dab86fdd381e6992435.png]: /images/20220829/f93f76ab225c438ab22f1c695d341c8b.png
[9240d15c216b9fc6f0aa4b4e3ba7a454.png]: /images/20220829/3bdc573b419d42fe968133d70ffd08ff.png
[4d800d5e96ec6cc802cd3309e1a63ae2.png]: /images/20220829/0bda98e7c521451d9c21179ee64be020.png
[10k_ SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzI4Njc5NjM1NQ%3D%3D&chksm=ebd5c411dca24d07446a4f22772cd12d2cc1143b62eb922a14500ae981cd57fb850ef74ca257&idx=2&mid=2247498557&scene=21&sn=84902d7030e174e152615d8fae3755cc#wechat_redirect
[SpringBoot_Vue]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799be6cb0e12f0b58479f8b031bc5ae79efdca1880ff9b19f0a107c3a88c37b9596dc73203&idx=2&mid=2247497288&scene=21&sn=65d7111a19e920df1e9416959594b2f4#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799a9ccb0e138a64a2671f31b8d4be1b3c061a288f7b0d1d4af02a60c45a72231446b91e00&idx=2&mid=2247497522&scene=21&sn=c5b4e596be4ac7d7f293e7e2f0ea0769#wechat_redirect
[9cd807467e893952470e55928901937b.png]: /images/20220829/2f339ec2d95d413f9929d033e63f7b5e.png