SpringBoot實(shí)現(xiàn)動(dòng)態(tài)增刪啟停定時(shí)任務(wù)

在spring boot項(xiàng)目中,可以通過@EnableScheduling注解和@Scheduled注解實(shí)現(xiàn)定時(shí)任務(wù),也可以通過SchedulingConfigurer接口來實(shí)現(xiàn)定時(shí)任務(wù)。但是這兩種方式不能動(dòng)態(tài)添加吼和、刪除、啟動(dòng)、停止任務(wù)影兽。
要實(shí)現(xiàn)動(dòng)態(tài)增刪啟停定時(shí)任務(wù)功能,比較廣泛的做法是集成Quartz框架莱革。但是本人的開發(fā)原則是:在滿足項(xiàng)目需求的情況下峻堰,盡量少的依賴其它框架,避免項(xiàng)目過于臃腫和復(fù)雜驮吱。
查看spring-context這個(gè)jar包中org.springframework.scheduling.ScheduledTaskRegistrar這個(gè)類的源代碼茧妒,發(fā)現(xiàn)可以通過改造這個(gè)類就能實(shí)現(xiàn)動(dòng)態(tài)增刪啟停定時(shí)任務(wù)功能。
圖片
定時(shí)任務(wù)列表頁
圖片
定時(shí)任務(wù)執(zhí)行日志添加執(zhí)行定時(shí)任務(wù)的線程池配置類
@Configuration  
public class SchedulingConfig {  
    @Bean  
    public TaskScheduler taskScheduler() {  
        ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();  
        // 定時(shí)任務(wù)執(zhí)行線程池核心線程數(shù)  
        taskScheduler.setPoolSize(4);  
        taskScheduler.setRemoveOnCancelPolicy(true);  
        taskScheduler.setThreadNamePrefix("TaskSchedulerThreadPool-");  
        return taskScheduler;  
    }  
}  
添加ScheduledFuture的包裝類左冬。ScheduledFuture是ScheduledExecutorService定時(shí)任務(wù)線程池的執(zhí)行結(jié)果桐筏。
public final class ScheduledTask {  
    volatile ScheduledFuture<?> future;  
     /**  
     * 取消定時(shí)任務(wù)  
     */  
    public void cancel() {  
        ScheduledFuture<?> future = this.future;  
        if (future != null) {  
            future.cancel(true);  
        }  
    }  
}  
添加Runnable接口實(shí)現(xiàn)類,被定時(shí)任務(wù)線程池調(diào)用拇砰,用來執(zhí)行指定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("定時(shí)任務(wù)開始執(zhí)行 - bean:{},方法:{}除破,參數(shù):{}", 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("定時(shí)任務(wù)執(zhí)行異常 - bean:%s牧氮,方法:%s,參數(shù):%s ", beanName, methodName, params), ex);  
        }  

        long times = System.currentTimeMillis() - startTime;  
        logger.info("定時(shí)任務(wù)執(zhí)行結(jié)束 - bean:{}瑰枫,方法:{}踱葛,參數(shù):{}丹莲,耗時(shí):{} 毫秒", 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);  
    }  
}  
添加定時(shí)任務(wù)注冊(cè)類,用來增加尸诽、刪除定時(shí)任務(wù)甥材。
@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();  
    }  
}  

添加定時(shí)任務(wù)示例類
@Component("demoTask")  
public class DemoTask {  
    public void taskWithParams(String params) {  
        System.out.println("執(zhí)行有參示例任務(wù):" + params);  
    }  

    public void taskNoParams() {  
        System.out.println("執(zhí)行無參示例任務(wù)");  
    }  
}  

定時(shí)任務(wù)數(shù)據(jù)庫表設(shè)計(jì)
圖片
定時(shí)任務(wù)數(shù)據(jù)庫表設(shè)計(jì)添加定時(shí)任務(wù)實(shí)體類
public class SysJobPO {  
    /**  
     * 任務(wù)ID  
     */  
    private Integer jobId;  
    /**  
     * bean名稱  
     */  
    private String beanName;  
    /**  
     * 方法名稱  
     */  
    private String methodName;  
    /**  
     * 方法參數(shù)  
     */  
    private String methodParams;  
    /**  
     * cron表達(dá)式  
     */  
    private String cronExpression;  
    /**  
     * 狀態(tài)(1正常 0暫停)  
     */  
    private Integer jobStatus;  
    /**  
     * 備注  
     */  
    private String remark;  
    /**  
     * 創(chuàng)建時(shí)間  
     */  
    private Date createTime;  
    /**  
     * 更新時(shí)間  
     */  
    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;  
    }  

}  

新增定時(shí)任務(wù)
圖片
新增定時(shí)任務(wù)
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();  

修改定時(shí)任務(wù),先移除原來的任務(wù)性含,再啟動(dòng)新任務(wù)
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();  

刪除定時(shí)任務(wù)
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();  

定時(shí)任務(wù)啟動(dòng)/停止?fàn)顟B(tài)切換
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);  
}  

添加實(shí)現(xiàn)了CommandLineRunner接口的SysJobRunner類洲赵,當(dāng)spring boot項(xiàng)目啟動(dòng)完成后,加載數(shù)據(jù)庫里狀態(tài)為正常的定時(shí)任務(wù)商蕴。
@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) {  
        // 初始加載數(shù)據(jù)庫里狀態(tài)為正常的定時(shí)任務(wù)  
        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("定時(shí)任務(wù)已加載完畢...");  
        }  
    }  
}  

工具類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);  
    }  
}

至此完畢!

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末绪商,一起剝皮案震驚了整個(gè)濱河市苛谷,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌部宿,老刑警劉巖抄腔,帶你破解...
    沈念sama閱讀 218,607評(píng)論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異理张,居然都是意外死亡赫蛇,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,239評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門雾叭,熙熙樓的掌柜王于貴愁眉苦臉地迎上來悟耘,“玉大人,你說我怎么就攤上這事织狐≡萦祝” “怎么了?”我有些...
    開封第一講書人閱讀 164,960評(píng)論 0 355
  • 文/不壞的土叔 我叫張陵移迫,是天一觀的道長(zhǎng)旺嬉。 經(jīng)常有香客問我,道長(zhǎng)厨埋,這世上最難降的妖魔是什么邪媳? 我笑而不...
    開封第一講書人閱讀 58,750評(píng)論 1 294
  • 正文 為了忘掉前任,我火速辦了婚禮荡陷,結(jié)果婚禮上雨效,老公的妹妹穿的比我還像新娘。我一直安慰自己废赞,他們只是感情好徽龟,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,764評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著唉地,像睡著了一般据悔。 火紅的嫁衣襯著肌膚如雪传透。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,604評(píng)論 1 305
  • 那天屠尊,我揣著相機(jī)與錄音旷祸,去河邊找鬼耕拷。 笑死讼昆,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的骚烧。 我是一名探鬼主播浸赫,決...
    沈念sama閱讀 40,347評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼赃绊!你這毒婦竟也來了既峡?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,253評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤碧查,失蹤者是張志新(化名)和其女友劉穎运敢,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體忠售,經(jīng)...
    沈念sama閱讀 45,702評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡传惠,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,893評(píng)論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了稻扬。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片卦方。...
    茶點(diǎn)故事閱讀 40,015評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖泰佳,靈堂內(nèi)的尸體忽然破棺而出盼砍,到底是詐尸還是另有隱情,我是刑警寧澤逝她,帶...
    沈念sama閱讀 35,734評(píng)論 5 346
  • 正文 年R本政府宣布浇坐,位于F島的核電站,受9級(jí)特大地震影響黔宛,放射性物質(zhì)發(fā)生泄漏近刘。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,352評(píng)論 3 330
  • 文/蒙蒙 一宁昭、第九天 我趴在偏房一處隱蔽的房頂上張望跌宛。 院中可真熱鬧,春花似錦积仗、人聲如沸疆拘。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,934評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽哎迄。三九已至回右,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間漱挚,已是汗流浹背翔烁。 一陣腳步聲響...
    開封第一講書人閱讀 33,052評(píng)論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留旨涝,地道東北人蹬屹。 一個(gè)月前我還...
    沈念sama閱讀 48,216評(píng)論 3 371
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像白华,于是被迫代替她去往敵國和親慨默。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,969評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容