摘要：本文主要介紹基于SpringBoot定時任務ScheduledTaskRegistrar的動態(tài)擴展，實現(xiàn)定時任務的動態(tài)新增和刪除。
ScheduledTaskRegistrar類簡要描述
平常使用方式配置
-
Application啟動類上添加注解@EnableScheduling
@EnableScheduling
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
復制代碼- 在需要定時的方法上添加定時注解
@Scheduled(cron = "0/10 * * * * ?")
@Slf4j
@Component
public class OtherScheduler {
@Scheduled(cron = "0/10 * * * * ?")
public void print(){
log.info("每10S打印一次");
}
@Scheduled(cron = "0/5 * * * * ?")
public void print5(){
log.info("每5S打印一次");
}
}
復制代碼原理分析
默認的方式啟動把
ScheduledAnnotationBeanPostProcessor該類實例化到SpringBoot的Bean管理中，并且該類持有一個ScheduledTaskRegistrar屬性，然后掃描出來擁有@Scheduled注解的方法，添加到定時任務中。
- 添加定時任務到列表中
掃描到
@Scheduled注解的時候調(diào)用了該方法添加任務
public void addCronTask(Runnable task, String expression) {
if (!CRON_DISABLED.equals(expression)) {
addCronTask(new CronTask(task, expression));
}
}
復制代碼- 啟動定時任務
在對象實例化完成后，調(diào)用了
afterPropertiesSet方法，該方法實際使用中執(zhí)行了
public void afterPropertiesSet() {
scheduleTasks();
}
protected void scheduleTasks() {
if (this.taskScheduler == null) {
this.localExecutor = Executors.newSingleThreadScheduledExecutor();
this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor);
}
if (this.triggerTasks != null) {
for (TriggerTask task : this.triggerTasks) {
addScheduledTask(scheduleTriggerTask(task));
}
}
if (this.cronTasks != null) {
for (CronTask task : this.cronTasks) {
addScheduledTask(scheduleCronTask(task));
}
}
if (this.fixedRateTasks != null) {
for (IntervalTask task : this.fixedRateTasks) {
addScheduledTask(scheduleFixedRateTask(task));
}
}
if (this.fixedDelayTasks != null) {
for (IntervalTask task : this.fixedDelayTasks) {
addScheduledTask(scheduleFixedDelayTask(task));
}
}
}
private void addScheduledTask(@Nullable ScheduledTask task) {
if (task != null) {
this.scheduledTasks.add(task);
}
}
// 啟動任務核心方法
public ScheduledTask scheduleCronTask(CronTask task) {
ScheduledTask scheduledTask = this.unresolvedTasks.remove(task);
boolean newTask = false;
if (scheduledTask == null) {
scheduledTask = new ScheduledTask(task);
newTask = true;
}
if (this.taskScheduler != null) {
scheduledTask.future = this.taskScheduler.schedule(task.getRunnable(), task.getTrigger());
}
else {
addCronTask(task);
this.unresolvedTasks.put(task, scheduledTask);
}
return (newTask ? scheduledTask : null);
}
復制代碼DynamicScheduledTaskRegistrar動態(tài)任務注冊類
下面改動主要涉及到線程池數(shù)量、新增任務、刪除任務、銷毀任務四個方面；
public class DynamicScheduledTaskRegistrar extends ScheduledTaskRegistrar {
private static final Logger log = LoggerFactory.getLogger(DynamicScheduledTaskRegistrar.class);
private final Map<String,ScheduledTask> scheduledTaskMap = new LinkedHashMap<>(16);
public DynamicScheduledTaskRegistrar(){
super();
// 兩種實現(xiàn)方案
//ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(10);
//TaskScheduler taskScheduler = new ConcurrentTaskScheduler(scheduledExecutorService);
// 第二種實現(xiàn)方案
ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
taskScheduler.setPoolSize(8);
taskScheduler.setRemoveOnCancelPolicy(true);
taskScheduler.setThreadNamePrefix("dynamic-scheduled-task-");
taskScheduler.initialize();
this.setScheduler(taskScheduler);
}
/**
* 新增任務
* @param taskName
* @param cron
* @param runnable
*/
public Boolean addCronTask(String taskName,String cron,Runnable runnable){
if(scheduledTaskMap.containsKey(taskName)){
log.error("定時任務["+ taskName+"]已存在，添加失敗");
return Boolean.FALSE;
}
CronTask cronTask = new CronTask(runnable,cron);
ScheduledTask scheduledTask = this.scheduleCronTask(cronTask);
scheduledTaskMap.put(taskName,scheduledTask);
log.info("定時任務["+taskName+"]新增成功");
return Boolean.TRUE;
}
/**
* 刪除任務
* @param taskName
*/
public void cancelCronTask(String taskName){
ScheduledTask scheduledTask = scheduledTaskMap.get(taskName);
if(null != scheduledTask){
scheduledTask.cancel();
scheduledTaskMap.remove(taskName);
}
log.info("定時任務["+taskName+"]刪除成功");
}
@Override
public void destroy() {
super.destroy();
scheduledTaskMap.values().forEach(ScheduledTask::cancel);
}
}
復制代碼線程池數(shù)量問題
由于默認是單線程的，如果任務阻塞時間過長則會導致后續(xù)的任務阻塞，所以盡量是異步任務或者是線程池數(shù)量大一點，則可以避免這個問題
DynamicScheduledTaskService
@Service
public class DynamicScheduledTaskService {
private static final Logger log = LoggerFactory.getLogger(DynamicScheduledTaskService.class);
private final DynamicScheduledTaskRegistrar dynamicScheduledTaskRegistrar = new DynamicScheduledTaskRegistrar();
/**
* 新增任務
* @param taskName
* @param cron
*/
public void add(String taskName,String cron){
Boolean result = dynamicScheduledTaskRegistrar.addCronTask(taskName,cron,() -> print(taskName));
log.info("定時任務添加結(jié)果：" + result);
}
/**
* 取消任務
* @param taskName
*/
public void cancel(String taskName){
dynamicScheduledTaskRegistrar.cancelCronTask(taskName);
}
private void print(String taskName){
log.info(taskName+"開始");
try{
Thread.sleep(9000L);
log.info(taskName+"結(jié)束111");
}catch (Exception ex){
}
log.info(taskName+"結(jié)束");
}
}
復制代碼SchedulerController
@RestController
@RequestMapping(value = "scheduler")
public class SchedulerController {
@Autowired
private DynamicScheduledTaskService dynamicScheduledTaskService;
@GetMapping(value = "add")
public Object add(String taskName,String cron){
dynamicScheduledTaskService.add(taskName,cron);
return "SUCCESS";
}
@GetMapping(value = "cancel")
public Object cancel(String jobName){
dynamicScheduledTaskService.cancel(jobName);
return "SUCCESS";
}
}
復制代碼測試結(jié)果
新增的任務都睡眠了9S
新增調(diào)度任務
刪除調(diào)度任務
文章來源：http://www.zghlxwxcb.cn/news/detail-427339.html
文章來源地址http://www.zghlxwxcb.cn/news/detail-427339.html
到了這里，關(guān)于SpringBoot定時任務動態(tài)擴展ScheduledTaskRegistrar的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
