当前位置：首页 > article >正文

简单两步，Spring Boot 定时任务也能动态设置

article 2024/10/2 14:20:47

在Spring Boot项目中实现定时任务通常涉及到使用@Scheduled注解，这种方式简单直接，但往往存在一个问题：一旦应用启动，定时任务的执行时间和频率就被固定下来了，难以在不重启应用的情况下进行动态调整。为了实现Spring Boot定时任务的动态设置，我们可以通过结合使用Spring的TaskScheduler接口和数据库（或配置中心）来实现。下面将通过一个简单的例子来展示如何分两步实现动态定时任务。

第一步：配置TaskScheduler

首先，我们需要配置一个TaskScheduler的Bean，这个Bean将用于动态地调度任务。Spring Boot已经为我们提供了ThreadPoolTaskScheduler的实现，我们可以直接使用它。

import org.springframework.context.annotation.Bean;  
import org.springframework.context.annotation.Configuration;  
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;  
  
@Configuration  
public class SchedulerConfig {  
  
    @Bean  
    public ThreadPoolTaskScheduler taskScheduler() {  
        ThreadPoolTaskScheduler scheduler = new ThreadPoolTaskScheduler();  
        // 可以根据需要配置线程池的大小、线程名称前缀等  
        scheduler.setPoolSize(10);  
        scheduler.setThreadNamePrefix("scheduled-task-");  
        scheduler.setDaemon(true);  
        return scheduler;  
    }  
}

第二步：创建动态调度任务

接下来，我们需要创建一个可以动态注册和取消的定时任务。这通常涉及到使用TaskScheduler的schedule方法来安排任务，以及使用返回的ScheduledFuture来取消任务。

首先，定义一个服务类来管理这些任务：

import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.scheduling.TaskScheduler;  
import org.springframework.scheduling.support.CronTrigger;  
import org.springframework.stereotype.Service;  
  
import java.util.concurrent.ScheduledFuture;  
  
@Service  
public class DynamicScheduledTaskService {  
  
    @Autowired  
    private TaskScheduler taskScheduler;  
  
    private ScheduledFuture<?> futureTask;  
  
    // 动态启动任务  
    public void startTask(String cronExpression) {  
        // 假设有一个Runnable任务实现  
        Runnable task = () -> System.out.println("Executing task at " + System.currentTimeMillis());  
  
        // 取消之前的任务（如果有）  
        if (futureTask != null) {  
            futureTask.cancel(false);  
        }  
  
        // 使用新的cron表达式启动任务  
        futureTask = taskScheduler.schedule(task, new CronTrigger(cronExpression));  
    }  
  
    // 取消任务  
    public void cancelTask() {  
        if (futureTask != null) {  
            futureTask.cancel(false);  
            futureTask = null;  
        }  
    }  
}

使用示例

现在，你可以通过调用DynamicScheduledTaskService的startTask和cancelTask方法来动态地启动和取消定时任务了。例如，你可以通过REST API或者管理界面来触发这些操作，从而在不重启应用的情况下修改定时任务的执行频率。

@RestController  
@RequestMapping("/api/tasks")  
public class TaskController {  
  
    @Autowired  
    private DynamicScheduledTaskService taskService;  
  
    @PostMapping("/start")  
    public ResponseEntity<?> startTask(@RequestParam String cronExpression) {  
        taskService.startTask(cronExpression);  
        return ResponseEntity.ok("Task started with cron expression: " + cronExpression);  
    }  
  
    @PostMapping("/cancel")  
    public ResponseEntity<?> cancelTask() {  
        taskService.cancelTask();  
        return ResponseEntity.ok("Task cancelled");  
    }  
}