Spring動(dòng)態(tài)管理定時(shí)任務(wù)之ThreadPoolTaskScheduler解讀

更新時(shí)間：2022年12月28日 14:15:06 作者：DayDayUp丶

這篇文章主要介紹了Spring動(dòng)態(tài)管理定時(shí)任務(wù)之ThreadPoolTaskScheduler解讀，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

Spring動(dòng)態(tài)管理定時(shí)任務(wù)ThreadPoolTaskScheduler

Spring任務(wù)調(diào)度核心類ThreadPoolTaskScheduler，API文檔解釋如下：

Implementation of Spring's TaskScheduler interface, wrapping a native java.util.concurrent.ScheduledThreadPoolExecutor.

Spring的TaskScheduler接口的實(shí)現(xiàn)，包裝了一個(gè)本地java.util.concurrent.ScheduledThreadPoolExecutor。

實(shí)現(xiàn)思路

注入調(diào)度類bean，初始化一個(gè)ConcurrentHashMap容器，用來(lái)保存多個(gè)定時(shí)任務(wù)的狀態(tài)，每一個(gè)任務(wù)的運(yùn)行狀態(tài)被封裝在ScheduledFuture中，借此類可取消對(duì)應(yīng)的定時(shí)任務(wù)。

import java.time.LocalDateTime;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ScheduledFuture;
 
import javax.annotation.Resource;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
import com.cjia.spidercommon.model.SpiderJob;
import com.cjia.spiderjob.mapper.SpiderJobMapper;
 
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
 
/**
 * 用來(lái)管理（啟動(dòng)、停止、新增、刪除、更新編輯、查看運(yùn)行狀態(tài)）定時(shí)任務(wù)（增量任務(wù)）
 */
@Slf4j
@RestController
@RequestMapping("spiderJob/cron")
public class CronJobController extends SpiderJobController {
 
    @Autowired
    private ThreadPoolTaskScheduler threadPoolTaskScheduler;
 
    private Map<Integer, ScheduledFuture<?>> futureMap = new ConcurrentHashMap<>();
 
    @Resource
    private SpiderJobMapper spiderJobMapper;
 
    @Bean
    public ThreadPoolTaskScheduler threadPoolTaskScheduler() {
        return new ThreadPoolTaskScheduler();
    }
 
    /**
     * 啟動(dòng)單個(gè)定時(shí)任務(wù)
     */
    @RequestMapping("/start/{jobId}")
    public String start(@PathVariable Integer jobId) {
        SpiderJob job = spiderJobMapper.selectById(jobId);
        if (job == null) {
            log.warn("任務(wù)[{}]已不存在，無(wú)法啟動(dòng)！", jobId);
            return "任務(wù)[" + jobId + "]已不存在，無(wú)法啟動(dòng)！";
        }
        int enable = job.getEnable();
        if (enable == 0) {
            log.warn("任務(wù)[{}]已被禁用，無(wú)法啟動(dòng)！", jobId);
            return "任務(wù)[" + jobId + "]已被禁用，無(wú)法啟動(dòng)！";
        }
        // 檢測(cè)該任務(wù)是否已在運(yùn)行調(diào)度中
        if (futureMap.get(jobId) != null) {
            log.warn("任務(wù)[{}]已在調(diào)度運(yùn)行，無(wú)法重復(fù)啟動(dòng)！", jobId);
            return "任務(wù)[" + jobId + "]已在調(diào)度運(yùn)行，無(wú)法重復(fù)啟動(dòng)！";
        }
        String cron = job.getCron();
        // TODO check cron
        ScheduledFuture<?> future = threadPoolTaskScheduler.schedule(new MyRunnable(job), new CronTrigger(cron));
        log.info("任務(wù)[{}]已被啟動(dòng)！", jobId);
        futureMap.put(jobId, future);
        return "任務(wù)[" + jobId + "]已被啟動(dòng)！";
    }
 
    /**
     * 批量啟動(dòng)定時(shí)任務(wù)
     */
    @RequestMapping("/startBatch/{jobIds}")
    public String startBatch(@PathVariable String jobIds) {
        // TODO jobIds valid
        String[] jobIdsArr = jobIds.split(",");
        StringBuffer sb = new StringBuffer();
        for (String jobId : jobIdsArr) {
            String result = start(Integer.valueOf(jobId));
            sb.append(result).append("<br>");
        }
        return sb.toString();
    }
 
    /**
     * 停止單個(gè)定時(shí)任務(wù)
     */
    @RequestMapping("/stop/{jobId}")
    public String stop(@PathVariable Integer jobId) {
        // 檢測(cè)該任務(wù)是否已在運(yùn)行調(diào)度中
        ScheduledFuture<?> future = futureMap.get(jobId);
        if (future == null) {
            log.warn("任務(wù)[{}]已不在調(diào)度中，無(wú)法停止！", jobId);
            return "任務(wù)[" + jobId + "]已不在調(diào)度中，無(wú)法停止！";
        } else {
            future.cancel(true);
            futureMap.remove(jobId);
            log.info("任務(wù)[{}]已被停止！", jobId);
            return "任務(wù)[" + jobId + "]已被停止！";
        }
    }
 
    /**
     * 批量停止定時(shí)任務(wù)
     */
    @RequestMapping("/stopBatch/{jobIds}")
    public String stopBatch(@PathVariable String jobIds) {
        // TODO jobIds valid
        String[] jobIdsArr = jobIds.split(",");
        StringBuffer sb = new StringBuffer();
        for (String jobId : jobIdsArr) {
            String result = stop(Integer.valueOf(jobId));
            sb.append(result).append("<br>");
        }
        return sb.toString();
    }
 
    /**
     * 查看當(dāng)前時(shí)刻調(diào)度中的定時(shí)任務(wù)
     */
    @RequestMapping("/status")
    public String getAllStatus() {
        Set<Integer> runningKeys = futureMap.keySet();
        return "當(dāng)前正在調(diào)度的任務(wù)列表：" + runningKeys.toString();
    }
 
    @Data
    private class MyRunnable implements Runnable {
        private SpiderJob job;
 
        public MyRunnable(SpiderJob job) {
            this.job = job;
        }
 
        @Override
        public void run() {
            log.info("運(yùn)行定時(shí)任務(wù)[{}: {}] at {}！", job.getId(), job.getBizName(), LocalDateTime.now());
            executeIncrementJob(job.getBizName());
        }
    }
 
}

ThreadPoolTaskScheduler 定時(shí)任務(wù)實(shí)現(xiàn)

org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler定時(shí)任務(wù)調(diào)度線程池

CREATE TABLE `sys_job` (
  `id` bigint(20) NOT NULL COMMENT '任務(wù)key',
  `job_name` varchar(64) NOT NULL COMMENT '任務(wù)名稱',
  `bean_class` varchar(128) NOT NULL COMMENT '類路徑',
  `cron_expression` varchar(64) NOT NULL COMMENT 'cron表達(dá)式',
  `status` tinyint(1) NOT NULL COMMENT '狀態(tài)值 @JobStatusEnum 詳見(jiàn)具體枚舉類',
  `is_deleted` tinyint(1) DEFAULT '0' COMMENT '刪除標(biāo)識(shí) 1是 0否',
  `create_time` datetime DEFAULT NULL,
  `update_time` datetime DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

@Configuration
@Slf4j
public class SchedulingConfigure {

    @Bean
    public ThreadPoolTaskScheduler threadPoolTaskScheduler() {
        log.info("開(kāi)始創(chuàng)建定時(shí)任務(wù)調(diào)度線程池");
        ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
        threadPoolTaskScheduler.setPoolSize(20);
        threadPoolTaskScheduler.setThreadNamePrefix("schedule-task-");
        threadPoolTaskScheduler.setWaitForTasksToCompleteOnShutdown(true);
        threadPoolTaskScheduler.setAwaitTerminationSeconds(60);
        log.info("創(chuàng)建定時(shí)任務(wù)調(diào)度線程池完成!");
        return threadPoolTaskScheduler;
    }
}

public enum JobStatusEnum {

    /**
     * 未加入調(diào)度器
     */
    NOT_SCHEDULE(0, "未加入調(diào)度器"),

    /**
     * 加入調(diào)度器，但未運(yùn)行
     */
    SCHEDULED_BUT_NOT_RUNNING(1, "加入調(diào)度器，但未運(yùn)行"),

    /**
     * 從調(diào)度器中已刪除
     */
    DELETED(2, "從調(diào)度器中已刪除"),
    ;

    private Integer status;

    private String detail;

    JobStatusEnum(Integer status, String detail) {
        this.status = status;
        this.detail = detail;
    }

    public Integer getStatus() {
        return status;
    }

    public void setStatus(Integer status) {
        this.status = status;
    }

    public String getDetail() {
        return detail;
    }

    public void setDetail(String detail) {
        this.detail = detail;
    }
}

@Component
@Slf4j
public class ScheduledJobService {

    private final ReentrantLock lock = new ReentrantLock();

    @Autowired
    private ThreadPoolTaskScheduler threadPoolTaskScheduler;
    @Autowired
    private SysJobService jobService;
    @Autowired
    private SpringBeanUtils springBeanUtils;

    /**
     * 已經(jīng)加入調(diào)度器的任務(wù)map
     */
    private final ConcurrentHashMap<Long, ScheduledFuture<?>> scheduledFutureMap = new ConcurrentHashMap<>();

    /**
     * 初始化啟動(dòng)任務(wù)
     *
     * @param sysJobs 數(shù)據(jù)庫(kù)任務(wù)集合
     */
    public void initAllJob(List<SysJob> sysJobs) {
        if (CollectionUtils.isEmpty(sysJobs)) {
            return;
        }
        for (SysJob sysJob : sysJobs) {
            if (JobStatusEnum.NOT_SCHEDULE.getStatus().equals(sysJob.getStatus())
                    || JobStatusEnum.DELETED.getStatus().equals(sysJob.getStatus())
                    || this.isScheduled(sysJob.getId())) {
                // 任務(wù)初始化狀態(tài)或已刪除或已加載到調(diào)度器中
                continue;
            }
            // 將任務(wù)加入調(diào)度器
            this.doScheduleJob(sysJob);
        }
    }

    /**
     * 啟動(dòng)任務(wù)
     *
     * @param jobId job主鍵id
     */
    public void start(Long jobId) {
        log.info("啟動(dòng)任務(wù)：-> jobId_{}", jobId);
        // 加入調(diào)度器
        schedule(jobId);
        log.info("啟動(dòng)任務(wù)結(jié)束：-> jobId_{}", jobId);
        // 更新任務(wù)狀態(tài)
        jobService.updateJobStatus(jobId, JobStatusEnum.SCHEDULED_BUT_NOT_RUNNING.getStatus());
    }

    /**
     * 停止任務(wù)
     *
     * @param jobId job主鍵id
     */
    public void stop(Long jobId) {
        log.info("停止任務(wù)：-> jobId_{}", jobId);
        // 取消任務(wù)
        cancel(jobId);
        log.info("停止任務(wù)結(jié)束：-> jobId_{}", jobId);
        // 更新表中任務(wù)狀態(tài)為已停止
        jobService.updateJobStatus(jobId, JobStatusEnum.NOT_SCHEDULE.getStatus());
    }

    /**
     * 移除任務(wù)
     *
     * @param jobId job主鍵id
     */
    public void remove(Long jobId) {
        log.info("移除任務(wù)：-> jobId_{}", jobId);
        // 取消任務(wù)
        cancel(jobId);
        log.info("移除任務(wù)結(jié)束：-> jobId_{}", jobId);
        // 更新表中任務(wù)狀態(tài)為已刪除
        jobService.updateJobStatus(jobId, JobStatusEnum.DELETED.getStatus());
    }

    /**
     * 取消
     *
     * @param jobId 工作id
     */
    private void cancel(Long jobId) {
        // 任務(wù)是否存在
        if (scheduledFutureMap.containsKey(jobId)) {
            ScheduledFuture<?> scheduledFuture = scheduledFutureMap.get(jobId);
            if (!scheduledFuture.isCancelled()) {
                // 取消調(diào)度
                scheduledFuture.cancel(true);
            }
        }
    }

    private void schedule(Long jobId) {
        // 添加鎖，只允許單個(gè)線程訪問(wèn)，防止任務(wù)啟動(dòng)多次
        lock.lock();
        try {
            if (isScheduled(jobId)) {
                log.error("任務(wù)jobId_{}已經(jīng)加入調(diào)度器，無(wú)需重復(fù)操作", jobId);
                return;
            }
            // 通過(guò)jobKey查詢jobBean對(duì)象
            SysJob sysJob = jobService.getById(jobId);
            // 啟動(dòng)定時(shí)任務(wù)
            doScheduleJob(sysJob);
        } finally {
            // 釋放鎖資源
            lock.unlock();
        }
    }

    /**
     * 執(zhí)行啟動(dòng)任務(wù)
     *
     * @param sysJob 任務(wù)實(shí)體類對(duì)象
     */
    private void doScheduleJob(SysJob sysJob) {
        Long jobId = sysJob.getId();
        String beanClass = sysJob.getBeanClass();
        String jobName = sysJob.getJobName();
        String cron = sysJob.getCronExpression();
        // 從Spring中獲取目標(biāo)的job業(yè)務(wù)實(shí)現(xiàn)類
        ScheduledJob scheduledJob = parseFrom(beanClass);
        if (scheduledJob == null) {
            return;
        }
        scheduledJob.setJobId(jobId);
        scheduledJob.setJobName(jobName);

        ScheduledFuture<?> scheduledFuture = threadPoolTaskScheduler.schedule(scheduledJob,
                triggerContext -> {
                    CronTrigger cronTrigger = new CronTrigger(cron);
                    return cronTrigger.nextExecutionTime(triggerContext);
                });

        log.info("任務(wù)加入調(diào)度器 -> jobId：{},jobName：{}", jobId, jobName);

        // 將啟動(dòng)的任務(wù)放入map
        assert scheduledFuture != null;
        scheduledFutureMap.put(jobId, scheduledFuture);
    }

    /**
     * 任務(wù)是否已經(jīng)進(jìn)入調(diào)度器
     *
     * @param jobId 任務(wù)主鍵key
     * @return {@link Boolean}
     */
    private Boolean isScheduled(Long jobId) {
        if (scheduledFutureMap.containsKey(jobId)) {
            return !scheduledFutureMap.get(jobId).isCancelled();
        }
        return false;
    }

    private ScheduledJob parseFrom(String beanClass) {
        try {
            Class<?> clazz = Class.forName(beanClass);
            return (ScheduledJob) springBeanUtils.getBean(clazz);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
        return null;
    }
}

@Component
public class SpringBeanUtils implements ApplicationContextAware {

    private static ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringBeanUtils.applicationContext = applicationContext;
    }

    /**
     * 獲取applicationContext
     */
    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    /**
     * 通過(guò)name獲取 Bean.
     */
    public  Object getBean(String name) {
        return getApplicationContext().getBean(name);
    }

    /**
     * 通過(guò)class獲取Bean.
     */
    public  <T> T getBean(Class<T> clazz) {
        return getApplicationContext().getBean(clazz);
    }

    /**
     * 通過(guò)name,以及Clazz返回指定的Bean
     */
    public  <T> T getBean(String name, Class<T> clazz) {
        return getApplicationContext().getBean(name, clazz);
    }
}

@Data
public abstract class ScheduledJob implements Runnable {
    
    /**
    * 任務(wù)主鍵id
    */
    private Long jobId;
    
    /**
    * 任務(wù)名
    */
    private String jobName;
}

@Component
public class SchedulerTestDemo extends ScheduledJob {

    @Override
    public void run() {
        System.out.println("我是定時(shí)任務(wù)要執(zhí)行的類..");
        System.out.println(SchedulerTestDemo.class.getName() + ":" + LocalDateTime.now());
    }

}

/**
 * 項(xiàng)目啟動(dòng)時(shí)，將數(shù)據(jù)庫(kù)中job定時(shí)任務(wù)加載
 */
@Component
public class GrapeApplicationListener {

    private final ScheduledJobService scheduledJobService;
    private final ISysJobService sysJobService;

    public GrapeApplicationListener(ISysJobService sysJobService, ScheduledJobService scheduledJobService) {
        this.sysJobService = sysJobService;
        this.scheduledJobService = scheduledJobService;
    }

    @PostConstruct
    public void initStartJob() {
    	// 初始化job
        scheduledJobService.initAllJob(sysJobService.list());
    }
}

@SpringBootApplication(scanBasePackages = {"com.example.grape"})
@MapperScan("com.example.grape.dao.mapper")
@EnableScheduling
public class GrapeApplication {

    public static void main(String[] args) {
        SpringApplication.run(GrapeApplication.class, args);
    }

}