SpringBoot：使用自定义cron表达式注册定时任务

骑猪看日落 2024-03-23 16:24 34阅读 0赞

#### 一、原理 ####

*  1、使用Spring自带的TaskScheduler注册任务
 *  2、注册后返回：ScheduledFuture，用于取消定时任务
 *  3、注册任务后不会马上取消任务，所以将任务缓存。在需要取消任务的时候调用取消接口取消
 *  4、cron表达式可以由前端或者后端生成。实现中会校验cron表达式

public class TestScheduled {
    
        /**
         * 1、使用Spring自带的TaskScheduler注册任务
         * 2、注册后返回：ScheduledFuture，用于取消定时任务
         */
        @Resource
        private TaskScheduler taskScheduler;
    
        public void registrarTask() {
            //具体的任务Runnable（一般使用类实现Runnable接口）
            Runnable taskRunnable = new Runnable() {
                @Override
                public void run() {
    
                }
            };
            //cron表达式触发器
            CronTrigger trigger = new CronTrigger("0/5 * * * * ?");
            //开启定时任务的真正方法
            ScheduledFuture<?> future = this.taskScheduler.schedule(taskRunnable, trigger);
            //取消定时任务
            future.cancel(true);
        }
    }

#### 二、具体实现 ####

1、配置任务调度器

*  作用：设置：核心线程数：可同时执行任务数；设置线程名称前缀
 *  可以不配置。不配置就默认使用spring自带的

package com.cc.ssd.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.scheduling.TaskScheduler;
    import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
    
    /** TaskScheduler任务调度器配置类
     * @since 2023/4/21 0021
     * @author CC
     **/
    @Configuration
    public class CronTaskConfig {
    
        /**
         * 任务调度器自定义配置
         */
        @Bean(name = "taskScheduler")
        public TaskScheduler taskScheduler() {
            // 任务调度线程池
            ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
            // 定时任务执行线程池核心线程数：可同时执行4个任务
            taskScheduler.setPoolSize(4);
            taskScheduler.setRemoveOnCancelPolicy(true);
            // 线程名称前缀
            taskScheduler.setThreadNamePrefix("Cs-ThreadPool-");
            return taskScheduler;
        }
    
    }

2、定时任务注册类

*  作用：缓存、注册定时任务；还可以查询、删除定时任务

package com.cc.ssd.registrar;
    
    import com.cc.ssd.task.CronTaskFuture;
    import com.cc.ssd.task.CronTaskRunnable;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.BeanUtils;
    import org.springframework.beans.factory.DisposableBean;
    import org.springframework.scheduling.TaskScheduler;
    import org.springframework.scheduling.config.CronTask;
    import org.springframework.scheduling.support.CronExpression;
    import org.springframework.stereotype.Component;
    import org.springframework.util.Assert;
    
    import javax.annotation.Resource;
    import java.time.LocalDateTime;
    import java.time.format.DateTimeFormatter;
    import java.util.*;
    import java.util.concurrent.ConcurrentHashMap;
    import java.util.stream.Collectors;
    
    /** 注册定时任务：缓存定时任务、注册定时任务到调度中心
     * @author CC
     **/
    @Component
    public class CronTaskRegistrar implements DisposableBean {
    
        private static final Logger log = LoggerFactory.getLogger(CronTaskRegistrar.class);
    
        /**
         * 缓存任务
         * key：具体的任务
         * value