SpringBoot实现动态增删启停定时任务的方式

更新时间：2024年03月06日 15:10:54 作者：奔向理想的星辰大海

在spring boot中,可以通过@EnableScheduling注解和@Scheduled注解实现定时任务,也可以通过SchedulingConfigurer接口来实现定时任务,但是这两种方式不能动态添加、删除、启动、停止任务,本文给大家介绍SpringBoot实现动态增删启停定时任务的方式,感兴趣的朋友一起看看吧

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

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

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

定时任务列表页

定时任务执行日志

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

@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("执行无参示例任务");  
    }  
}

定时任务数据库表设计

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

新增定时任务

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项目启动完成后，加载数据库里状态为正常的定时任务。

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

到此这篇关于SpringBoot实现动态增删启停定时任务的文章就介绍到这了,更多相关SpringBoot定时任务内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java多线程之线程安全问题详细解析
这篇文章主要给大家介绍了关于Java多线程之线程安全问题的相关资料,Java多线程中线程安全问题是一个常见的问题,因为多个线程可能同时访问共享的资源,文中通过图文介绍的非常详细,需要的朋友可以参考下
2023-11-11
Java导出oracle表结构实例详解
这篇文章主要介绍了 Java导出oracle表结构实例详解的相关资料,需要的朋友可以参考下
2017-03-03
Java实现将汉字转化为汉语拼音的方法
这篇文章主要介绍了Java实现将汉字转化为汉语拼音的方法,实例演示了Java引用pinyin4j库实现汉子转化成拼音的使用技巧,需要的朋友可以参考下
2015-12-12
MyBatis Generator生成数据库模型实现示例
这篇文章主要为大家介绍了MyBatis Generator生成数据库模型实现示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-12-12
java数据类型转换陷阱包括列表陷阱
这篇文章主要介绍了java数据类型转换的一些陷阱，包括基本数据类型转换列表陷阱，基本上这一篇就把常见的问题就给大家分享一下
2020-10-10
DecimalFormat数字格式化用法详解
这篇文章主要为大家详细介绍了DecimalFormat数字格式化用法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-03-03
Java NIO实战之聊天室功能详解
这篇文章主要介绍了Java NIO实战之聊天室功能,结合实例形式详细分析了java NIO聊天室具体的服务端、客户端相关实现方法与操作注意事项,需要的朋友可以参考下
2019-11-11
java定时任务的实现方法
java定时任务的实现方法，需要的朋友可以参考一下
2013-03-03
Java项目防止SQL注入的几种方法总结
SQL注入是比较常见的网络攻击方式之一,在客户端在向服务器发送请求的时候,sql命令通过表单提交或者url字符串拼接传递到后台持久层,最终达到欺骗服务器执行恶意的SQL命令,下面这篇文章主要给大家总结介绍了关于Java项目防止SQL注入的几种方法,需要的朋友可以参考下
2023-04-04
java对象持久化保存的方法详解
这篇文章主要介绍了java对象持久化保存的方法详解,在java应用开发的过程中，经常遇到需要持久保存java对象的情况,比如：用户信息、博客评论内容等等,本文针对java对象的持久化保存方法进行讨论，简述各个方法的优劣,需要的朋友可以参考下
2023-07-07

SpringBoot实现动态增删启停定时任务的方式

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具