springboot使用ThreadPoolTaskScheduler和ScheduledFuture完成添加修改刪除定時任務

ThreadPoolTaskScheduler可以註冊定時任務,ScheduledFuture有一個cancel方法可以取消定時任務,所以可以通過二者結合使用去完成定時任務的添加修改或者刪除

package com.holidaylee.util;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.scheduling.Trigger;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ScheduledFuture;


@Component
public class ScheduleTaskUtils {
    private static Logger logger = LoggerFactory.getLogger(ScheduleTaskUtils.class);

    private Map<String, ScheduledFuture<?>> futuresMap;

    @Autowired
    private ThreadPoolTaskScheduler threadPoolTaskScheduler;

    /**
     * 初始化任務列表
     */
    @PostConstruct
    public void init() {
        futuresMap = new ConcurrentHashMap<>();
    }

    /**
     * 創建ThreadPoolTaskScheduler線程池
     */
    @Bean
    public ThreadPoolTaskScheduler threadPoolTaskScheduler() {
        ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
        threadPoolTaskScheduler.setPoolSize(8);
        return threadPoolTaskScheduler;
    }

    /**
     * 添加定時任務，如果任務名重複則拋出異常
     * @param task 任務
     * @param trigger 定時器
     * @param key 任務名
     * @return
     */
    public boolean addTask(Runnable task, Trigger trigger, String key) {
        ScheduledFuture<?> future = threadPoolTaskScheduler.schedule(task, trigger);
        ScheduledFuture oldScheduledFuture = futuresMap.put(key, future);
        if (oldScheduledFuture == null) {
            return true;
        } else {
            throw new RuntimeException("添加任務key名： " + key + "重複" );
        }
    }

    /**
     * 移除定時任務
     * @param key 任務名
     * @return
     */
    public boolean removeTask(String key) {
        ScheduledFuture toBeRemovedFuture = futuresMap.remove(key);
        if (toBeRemovedFuture != null) {
            toBeRemovedFuture.cancel(true);
            return true;
        } else {
            return false;
        }
    }

    /**
     * 更新定時任務
     * 有可能會出現：1、舊的任務不存在，此時直接添加新任務；
     * 2、舊的任務存在，先刪除舊的任務，再添加新的任務
     * @param task 任務
     * @param trigger 定時器
     * @param key 任務名稱
     * @return
     */
    public boolean updateTask(Runnable task, Trigger trigger, String key) {
        ScheduledFuture toBeRemovedFuture = futuresMap.remove(key);
        // 存在則刪除舊的任務
        if (toBeRemovedFuture != null) {
            toBeRemovedFuture.cancel(true);
        }
        return addTask(task,trigger, key);
    }

}

註明：

本文爲學習記錄筆記，不喜勿噴。