淺談在springboot中使用定時任務的方式

Posted on by

springboot定時任務

在springboot環境下有多種方法，這裡記錄下使用過的其中兩種；1、使用註解，2、通過實現接口的方式。

使用註解的方式雖然比較簡單，但是如果項目需要用戶對定時周期進行修改操作，隻使用註解就比較難實現。所以可以使用實現接口的方式。通過對接口的實現，可以在項目運行時根據需要修改任務執行周期，隻需要關閉原任務再開啟新任務即可。

1、使用註解方式

​ 首先需要在啟動類下添加 @EnableScheduling 註解（@EnableAsync是開啟異步的註解）

package com.fongtech.cli;
 
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
 
@SpringBootApplication
@MapperScan("com.fongtech.cli.mbg.*.**")
@EnableAsync
@EnableScheduling 
public class SpringbootAdminApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(SpringbootAdminApplication.class, args);
    }
 
}

接著在需要用到定時任務的類和方法下加 @Component 和 @Scheduled(cron = “0 0/1 * * * ? “)註解，其中@Scheduled()中的 ‘cron’ 有固定的格式。（@Async註解表示開啟異步）

@Slf4j
@Component
public class AsyncTaskConfiguration {
 
    /**
     * 每分鐘檢查任務列表，判斷任務類型執行相應的任務
     * 根據實際任務執行情況，限定執行任務數量
     */
    @Scheduled(cron = "0 0/1 * * * ? ")
    @Async
    public void startCommonTask() throws Exception {
        log.info("startCommonTask  start........." + Thread.currentThread().getName());
        commonTaskService.startCommonTask();
        log.info("startCommonTask  end........." + Thread.currentThread().getName());
 
    }}

2、使用實現接口的方式

​ 通過實現 SchedulingConfigurer 接口，可對定時任務進行操作。實現接口的方式相比使用註解更加靈活，但需要編寫代碼，相對繁瑣。

​ 實現工具類如下：

package com.fongtech.cli.admin.tasktime;
 
import com.fongtech.cli.common.util.BeanUtils;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.SchedulingException;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.config.TriggerTask;
import org.springframework.scheduling.support.CronTrigger;
 
import javax.annotation.PostConstruct;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ScheduledFuture;
 
/**
 * @author linb
 * @date 2020/6/15 11:16
 */
@Configuration
//@EnableScheduling
public class DefaultSchedulingConfigurer implements SchedulingConfigurer {
    private ScheduledTaskRegistrar taskRegistrar;
    private Set<ScheduledFuture<?>> scheduledFutures = null;
    private Map<String, ScheduledFuture<?>> taskFutures = new ConcurrentHashMap<>();
 
    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
        this.taskRegistrar = taskRegistrar;
    }
 
    @SuppressWarnings("unchecked")
    private Set<ScheduledFuture<?>> getScheduledFutures() {
        if (scheduledFutures == null) {
            try {
                // spring版本不同選用不同字段scheduledFutures
                scheduledFutures = (Set<ScheduledFuture<?>>) BeanUtils.getProperty(taskRegistrar, "scheduledTasks");
            } catch (NoSuchFieldException e) {
                throw new SchedulingException("not found scheduledFutures field.");
            }
        }
        return scheduledFutures;
    }
 
    /**
     * 添加任務
     */
    public void addTriggerTask(String taskId, TriggerTask triggerTask) {
        if (taskFutures.containsKey(taskId)) {
            throw new SchedulingException("the taskId[" + taskId + "] was added.");
        }
        TaskScheduler scheduler = taskRegistrar.getScheduler();
        ScheduledFuture<?> future = scheduler.schedule(triggerTask.getRunnable(), triggerTask.getTrigger());
        getScheduledFutures().add(future);
        taskFutures.put(taskId, future);
    }
 
    /**
     * 取消任務
     */
    public void cancelTriggerTask(String taskId) {
        ScheduledFuture<?> future = taskFutures.get(taskId);
        if (future != null) {
            future.cancel(true);
        }
        taskFutures.remove(taskId);
        getScheduledFutures().remove(future);
    }
 
    /**
     * 重置任務
     */
    public void resetTriggerTask(String taskId, TriggerTask triggerTask) {
        cancelTriggerTask(taskId);
        addTriggerTask(taskId, triggerTask);
    }
 
    /**
     * 任務編號
     */
    public Set<String> taskIds() {
        return taskFutures.keySet();
    }
 
    /**
     * 是否存在任務
     */
    public boolean hasTask(String taskId) {
        return this.taskFutures.containsKey(taskId);
    }
 
    /**
     * 任務調度是否已經初始化完成
     */
    public boolean inited() {
        return this.taskRegistrar != null && this.taskRegistrar.getScheduler() != null;
    }
}

​ 在項目啟動後就自動開啟任務的操作類如下：

package com.fongtech.cli.admin.tasktime;
 
import com.fongtech.cli.admin.service.IAuthLoginService;
import com.fongtech.cli.admin.service.IBackupsService;
import com.fongtech.cli.admin.service.IDictionnaryEntryService;
import com.fongtech.cli.mbg.model.entity.AuthLogin;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.scheduling.config.TriggerTask;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
 
/**
 * 項目啟動後執行，
 */
@Slf4j
@Component
@Order(value = 1)
public class CmdRunner implements CommandLineRunner {
 
    @Autowired
    private DefaultSchedulingConfigurer defaultSchedulingConfigurer;
    @Autowired
    private IDictionnaryEntryService dictionnaryEntryService;
    @Autowired
    private IBackupsService backupsService;
    @Autowired
    private IAuthLoginService authLoginService;
 
    @Override
    public void run(String... args) throws Exception {
        log.info("------按照預設備份周期啟動數據庫備份定時任務");
        while (!defaultSchedulingConfigurer.inited())
        {
            try {
                Thread.sleep(100);
            } catch (InterruptedException e) {
                e.printStackTrace();
            } finally {
 
            }
        }
        String cron = dictionnaryEntryService.getEntryValueByName("CRON_VALUE");
        //默認按照管理員用戶權限執行備份任務
        AuthLogin authLogin = authLoginService.query().eq(AuthLogin::getLogin_user, "admin").getOne();
        //啟動線程，按照原表內的時間執行備份任務
        defaultSchedulingConfigurer.addTriggerTask("task",
                new TriggerTask(
                        () -> System.out.println("=====----------啟動定時任務=-----------");,
                        new CronTrigger(cron)));
    }
}

​ 暫停定時任務：

defaultSchedulingConfigurer.cancelTriggerTask("task");

到此這篇關於淺談在springboot中使用定時任務的方式的文章就介紹到這瞭,更多相關springboot定時任務內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：