基于SpringBoot實(shí)現(xiàn)輕量級的動(dòng)態(tài)定時(shí)任務(wù)調(diào)度的方法

更新時(shí)間：2024年11月23日 09:19:43 作者：糖拌西紅柿多放醋

本文介紹了如何在SpringBoot框架中實(shí)現(xiàn)輕量級的動(dòng)態(tài)定時(shí)任務(wù)調(diào)度,通過將任務(wù)以類為基礎(chǔ)單位,并通過配置數(shù)據(jù)進(jìn)行任務(wù)讀取和反射生成任務(wù)對象,感興趣的朋友跟隨小編一起看看吧

但是這種方式存在一個(gè)問題，那就是任務(wù)的周期控制是死的，必須編寫在代碼中，如果遇到需要在系統(tǒng)運(yùn)行過程中想中止、立即執(zhí)行、修改執(zhí)行周期等動(dòng)態(tài)操作的需求時(shí)，使用注解的方式便不能滿足了，當(dāng)然為了滿足此種需求可以額外再引入其他任務(wù)調(diào)度插件（例如XXL-Job等），但是引入其他組件是需要衡量成本的，額外的依賴成本、組件的維護(hù)成本、開發(fā)的復(fù)雜度等等，所以如果系統(tǒng)體量不是那么大，完全沒必要通過增加組件來完成，可以基于SpringBoot框架實(shí)現(xiàn)一套內(nèi)置輕量級的任務(wù)調(diào)度。

設(shè)計(jì)思路

整體設(shè)計(jì)

這里我們把定時(shí)任務(wù)以類作為基礎(chǔ)單位，即一個(gè)類為一個(gè)任務(wù)，然后通過配置數(shù)據(jù)的方式，進(jìn)行任務(wù)的讀取，通過反射生成任務(wù)對象，使用SpringBoot本身的線程池任務(wù)調(diào)度，完成動(dòng)態(tài)的定時(shí)任務(wù)驅(qū)動(dòng)，同時(shí)通過接口支撐實(shí)現(xiàn)相應(yīng)的REST API對外暴露接口

任務(wù)模型

首先基于模板模式，設(shè)計(jì)基礎(chǔ)的任務(wù)執(zhí)行流程抽象類，定義出一個(gè)定時(shí)任務(wù)需要執(zhí)行的內(nèi)容和步驟和一些通用的方法函數(shù)，后續(xù)具體的定時(shí)任務(wù)直接繼承該父類，實(shí)現(xiàn)該父類的before、start、after三個(gè)抽象函數(shù)即可，所有公共操作均在抽象父類完成

特殊說明：

基于此方法創(chuàng)建的類是不歸Spring的容器管理的，所以自定義的任務(wù)子類中是無法使用SpringBoot中的任何注解，尤其在自定義任務(wù)類中如果需要依賴其他Bean時(shí)，需要借助抽象父類AbstractBaseCronTask中已經(jīng)實(shí)現(xiàn)的<T> T getServer(Class<T> className)來完成，getServer的實(shí)現(xiàn)如下：

public <T> T getServer(Class<T> className){
       return applicationContext.getBean(className);
    }

是通過SpringBoot中的ApplicationContext接口來獲取Spring的上下文，以此來滿足可以獲取Spring中其他Bean的訴求。

例如，有個(gè)定時(shí)任務(wù)TaskOne類，它需要使用UserService類中的 caculateMoney()的方法，勢必這個(gè)定時(shí)任務(wù)需要依賴UserService類，而TaskOne并非是Spring創(chuàng)建的對象，而是我們?nèi)藶楦深A(yù)生成的對象，所以它是不在Spring的Bean管理范圍的，自然也就無法使用@Autowird等方式注入U(xiǎn)serService類，此時(shí)就需要使用getServer方法來獲取UserService對象

//自定義定時(shí)任務(wù)類
public class TaskOne extends AbstractBaseCronTask {
    private UserService userService;
    public TestTask(TaskEntity taskEntity) {
        super(taskEntity);
    }
    @Override
    public void beforeJob() {
        //任務(wù)運(yùn)行第一步，先將userService進(jìn)行變量注入
        userService = getServer(UserService.class);
        ……
    }
    @Override
    public void startJob() {
       if(XXXX){
          //直接調(diào)用getServer獲取需要的bean
          User user = getServer(UserMapper.class).findUser("111223")
          userService.caluateMoney(user);
          //……其他代碼
       }
    }
    @Override
    public void afterJob() {
    }
}

任務(wù)對象加載過程

核心邏輯在于利用反射，在SpringBoot啟動(dòng)后動(dòng)態(tài)創(chuàng)建相應(yīng)的定時(shí)任務(wù)類，并將其放置到SpringBoot的定時(shí)線程池中進(jìn)行維護(hù)，同時(shí)將該對象同步存放至內(nèi)存中一份，便于可以實(shí)時(shí)調(diào)用，當(dāng)進(jìn)行修改任務(wù)相關(guān)配置時(shí)，需要重新加載一次內(nèi)容。

public class TaskScheduleServerImpl implements TaskScheduleServer {
    //正在運(yùn)行的任務(wù)
    private static ConcurrentHashMap<String, ScheduledFuture> runningTasks = new ConcurrentHashMap<>();
    //線程池任務(wù)調(diào)度
    private ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
    public boolean addTaskToScheduling(TaskEntity task) {
        if(!runningTasks.containsKey(task.getTaskId())){
            try{
                Class<?> clazz = Class.forName(task.getTaskClass());
                Constructor c = clazz.getConstructor(TaskEntity.class);
                AbstractBaseCronTask runnable = (AbstractBaseCronTask) c.newInstance(task);
                //反射方式生成對象不屬于Spring容器管控，對于Spring的bean使用需要手動(dòng)注入
                runnable.setApplicationContext(context);
                CronTrigger cron = new CronTrigger(task.getTaskCron());
                //put到runTasks
                runningTasks.put(task.getTaskId(), Objects.requireNonNull(this.threadPoolTaskScheduler.schedule(runnable, cron)));
                //存入內(nèi)存中，便于外部調(diào)用
                ramTasks.put(task.getTaskId(),runnable);
                task.setTaskRamStatus(1);
                taskInfoOpMapper.updateTaskInfo(task);
                return true;
            }catch (Exception e){
                log.error("定時(shí)任務(wù)加載失敗..."+e);
            }
        }
        return false;
    }
}

部分源碼

這里將配置內(nèi)容放入數(shù)據(jù)庫中，直接以數(shù)據(jù)庫中的表作為任務(wù)配置的基礎(chǔ)

/**
* 任務(wù)對象
**/
@Data
public class TaskEntity implements Serializable {
    //任務(wù)唯一ID
    private String taskId;
    //任務(wù)名稱
    private String taskName;
    //任務(wù)描述
    private String taskDesc;
    //執(zhí)行周期配置
    private String taskCron;
    //任務(wù)類的全路徑
    private String taskClass;
    //任務(wù)的額外配置
    private String taskOutConfig;
    //任務(wù)創(chuàng)建時(shí)間
    private String taskCreateTime;
    //任務(wù)是否啟動(dòng)，1啟用，0不啟用
    private Integer taskIsUse;
    //是否隨系統(tǒng)啟動(dòng)立即執(zhí)行
    private Integer taskBootUp;
    //任務(wù)上次執(zhí)行狀態(tài)
    private Integer taskLastRun;
    //任務(wù)是否加載至內(nèi)存中 
    private Integer taskRamStatus;
}

核心邏輯，加載定時(shí)任務(wù)接口及其實(shí)現(xiàn)類

public interface TaskScheduleServer {
    ConcurrentHashMap<String, AbstractBaseCronTask> getTaskSchedulingRam();
    /**
     * 初始化任務(wù)調(diào)度
     */
    void initScheduling();
    /**
     * 添加任務(wù)至內(nèi)存及容器
     * @param taskEntity 任務(wù)實(shí)體
     * @return boolean
     */
    boolean addTaskToScheduling(TaskEntity taskEntity);
    /**
     * 從任務(wù)調(diào)度器中移除任務(wù)
     * @param id 任務(wù)id
     * @return Boolean
     */
    boolean removeTaskFromScheduling(String id);
    /**
     * 執(zhí)行指定任務(wù)
     * @param id 任務(wù)id
     * @return double 耗時(shí)
     */
    double runTaskById(String id);
    /**
     * 清空任務(wù)
     */
    void claearAllTask();
    /**
     * 加載所有任務(wù)
     */
    void loadAllTask();
    /**
     * 運(yùn)行開機(jī)自啟任務(wù)
     */
    void runBootUpTask();
}
@Slf4j
@Component
public class TaskScheduleServerImpl implements TaskScheduleServer {
    …………
    @Override
    public double runTaskById(String id) {
        TaskEntity task = taskInfoOpMapper.queryTaskInfoById(id);
        if(null!=task) {
            if (runningTasks.containsKey(task.getTaskId())){
                ramTasks.get(task.getTaskId()).run();
                return ramTasks.get(task.getTaskId()).getRunTime();
            }
        }
        return 0d;
    }
    @Override
    public void claearAllTask() {
        ramTasks.clear();
        log.info("【定時(shí)任務(wù)控制器】清除內(nèi)存任務(wù) 完成");
        runningTasks.clear();
        log.info("【定時(shí)任務(wù)控制器】清除線程任務(wù) 完成");
        threadPoolTaskScheduler.shutdown();
    }
    @Override
    public void loadAllTask() {
        List<TaskEntity> allTask = taskInfoOpMapper.queryTaskInfo(null);
        for (TaskEntity task : allTask) {
            if(addTaskToScheduling(task)){
                log.info("【定時(shí)任務(wù)初始化】裝填任務(wù):{} [ 任務(wù)執(zhí)行周期：{} ] [ bootup：{}]",task.getTaskName(),task.getTaskCron(),task.getTaskBootUp());
            }
        }
    }
    @Override
    public void runBootUpTask() {
        TaskEntity entity = new TaskEntity().taskBootUp(1);
        List<TaskEntity> list = taskInfoOpMapper.queryTaskInfo(entity);
        for(TaskEntity task:list){
            runTaskById(task.getTaskId());
        }
    }
}

在SpringBoot中的加載類

@Order(3)
@Component
@Slf4j
public class AfterAppStarted implements ApplicationRunner {
    TaskScheduleServer taskScheduleServer;
    @Autowired
    public void setTaskScheduleServer(TaskScheduleServer taskScheduleServer) {
        this.taskScheduleServer = taskScheduleServer;
    }
    @Override
    public void run(ApplicationArguments args) throws Exception {
        //運(yùn)行隨系統(tǒng)啟動(dòng)的定時(shí)任務(wù)
        taskScheduleServer.runBootUpTask();
    }
}

對外暴露控制接口及其Service

@RestController
@RequestMapping("/taskScheduling/manage")
@Api(tags = "數(shù)據(jù)源管理服務(wù)")
public class TaskSchedulingController {
    TaskScheduleManagerService taskScheduleManagerService;
    @Autowired
    public void setTaskScheduleManagerService(TaskScheduleManagerService taskScheduleManagerService) {
        this.taskScheduleManagerService = taskScheduleManagerService;
    }
    @PostMapping("/search")
    @Operation(summary = "分頁查詢?nèi)蝿?wù)")
    public Response searchData(@RequestBody SearchTaskDto param){
        return Response.success(taskScheduleManagerService.searchTaskForPage(param));
    }
    @GetMapping("/detail")
    @Operation(summary = "具體任務(wù)對象")
    public Response searchDetail(String taskId){
        return Response.success(taskScheduleManagerService.searchTaskDetail(taskId));
    }
    @GetMapping("/shutdown")
    @Operation(summary = "關(guān)閉指定任務(wù)")
    public Response shutdownTask(String taskId){
        return Response.success(taskScheduleManagerService.shutdownTask(taskId));
    }
    @GetMapping("/open")
    @Operation(summary = "開啟指定任務(wù)")
    public Response openTask(String taskId){
        return Response.success(taskScheduleManagerService.openTask(taskId));
    }
    @GetMapping("/run")
    @Operation(summary = "運(yùn)行指定任務(wù)")
    public  Response runTask(String taskId){
        return Response.success(taskScheduleManagerService.runTask(taskId));
    }
    @PostMapping("/update")
    @Operation(summary = "更新指定任務(wù)")
    public Response updateTask(@RequestBody TaskEntity taskEntity){
        return Response.success(taskScheduleManagerService.updateTaskBusinessInfo(taskEntity));
    }
}

相關(guān)接口實(shí)現(xiàn)類

@Service
public class TaskScheduleManagerServiceImpl implements TaskScheduleManagerService {
    private TaskInfoOpMapper taskInfoOpMapper;
    private TaskScheduleServer taskScheduleServer;
    @Autowired
    public void setTaskInfoOpMapper(TaskInfoOpMapper taskInfoOpMapper) {
        this.taskInfoOpMapper = taskInfoOpMapper;
    }
    @Autowired
    public void setTaskScheduleServer(TaskScheduleServer taskScheduleServer) {
        this.taskScheduleServer = taskScheduleServer;
    }
    @Override
    public IPage<TaskEntity> searchTaskForPage(SearchTaskDto dto) {
        Page<TaskEntity> pageParam = new Page<>(1,10);
        pageParam.setAsc("task_id");
        return taskInfoOpMapper.queryTaskInfoPage(pageParam,dto.getFilterKey(),dto.getBootUp(),dto.getLastRunStatus());
    }
    @Override
    public TaskEntity searchTaskDetail(String taskId) {
        if(!StringUtils.isEmpty(taskId)){
            return taskInfoOpMapper.queryTaskInfoById(taskId);
        }
        return null;
    }
    @Override
    public TaskRunRetDto runTask(String taskId) {
        AbstractBaseCronTask task = taskScheduleServer.getTaskSchedulingRam().get(taskId);
        TaskRunRetDto result = new TaskRunRetDto(TaskRunRetDto.TaskOperation.run, 0);
        if(null != task) {
                double time = taskScheduleServer.runTaskById(taskId);
                result.setResult(1);
                return result.extend(time).taskInfo(task.getThisTaskInfo());
        } else {
            return result.extend("任務(wù)未啟用");
        }
    }
    @Override
    public TaskRunRetDto shutdownTask(String taskId) {
        AbstractBaseCronTask task = taskScheduleServer.getTaskSchedulingRam().get(taskId);
        TaskRunRetDto result = new TaskRunRetDto(TaskRunRetDto.TaskOperation.shutdown, 0);
        if(null != task) {
            boolean flag = taskScheduleServer.removeTaskFromScheduling(taskId);
            if(flag) {
                result.setResult(1);
            }
            return result.extend("任務(wù)成功關(guān)閉").taskInfo(task.getThisTaskInfo());
        } else {
            return result.extend("任務(wù)未啟用");
        }
    }
    @Override
    public TaskRunRetDto openTask(String taskId) {
        TaskEntity task = taskInfoOpMapper.queryTaskInfoById(taskId);
        TaskRunRetDto result = new TaskRunRetDto(TaskRunRetDto.TaskOperation.open, 0);
        if(null != task) {
            if (!taskScheduleServer.getTaskSchedulingRam().containsKey(taskId)) {
              boolean flag = taskScheduleServer.addTaskToScheduling(task);
                if(flag) {
                    result.setResult(1);
                }
                return result.extend("任務(wù)開啟成功").taskInfo(task);
            } else {
                return result.extend("任務(wù)處于啟動(dòng)狀態(tài)").taskInfo(task);
            }
        }else {
            return result.extend("任務(wù)不存在！");
        }
    }
    @Override
    public TaskRunRetDto updateTaskBusinessInfo(TaskEntity entity) {
        TaskEntity task = searchTaskDetail(entity.getTaskId());
        TaskRunRetDto result = new TaskRunRetDto(TaskRunRetDto.TaskOperation.update, 0).taskInfo(entity);
        String config = entity.getTaskOutConfig();
        if(null != config && !JSONUtil.isJson(config) && !JSONUtil.isJsonArray(config)){
            result.setResult(0);
            result.extend("更新任務(wù)失敗,任務(wù)配置必須為JSON或空");
            result.taskInfo(entity);
            return result;
        }
        task.setTaskCron(entity.getTaskCron());
        task.setTaskOutConfig(entity.getTaskOutConfig());
        task.setTaskName(entity.getTaskName());
        task.setTaskDesc(entity.getTaskDesc());
        int num = taskInfoOpMapper.updateTaskInfo(task);
        if (num == 1) {
            result.setResult(1);
            result.extend("成功更新任務(wù)");
            result.taskInfo(entity);
            //重新刷新任務(wù)
            taskScheduleServer.removeTaskFromScheduling(entity.getTaskId());
            taskScheduleServer.addTaskToScheduling(task);
        }
        return result;
    }

效果

數(shù)據(jù)庫中配置任務(wù)

任務(wù)代碼

public class TestTask extends AbstractBaseCronTask {
    public TestTask(TaskEntity taskEntity) {
        super(taskEntity);
    }
    @Override
    public void beforeJob() {
        log.info("測試任務(wù)開始");
    }
    @Override
    public void startJob() {
    }
    @Override
    public void afterJob() {
    }
}

任務(wù)查看

執(zhí)行效果

到此這篇關(guān)于基于SpringBoot實(shí)現(xiàn)輕量級的動(dòng)態(tài)定時(shí)任務(wù)調(diào)度的文章就介紹到這了,更多相關(guān)SpringBoot動(dòng)態(tài)定時(shí)任務(wù)調(diào)度內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: