spring实现定时任务有两种方式:
1.注解@Scheduled
2接口SchedulingConfigurer形式
区别:
1.首先 @Scheduled注解默认是串行的,单线程,当开启多个任务时,任务的执行时间会受上一个任务执行时间的影响 。而基于接口的形式可以多线程执行。
2.@Scheduled更加固定,想修改只能停掉服务再上线。SchedulingConfigurer可以运行时修改参数,比较动态。
线程执行区别:
@Scheduled
启动类:
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class ScheduleApplication {
public static void main(String[] args) {
SpringApplication.run(ScheduleApplication.class, args);
}
}
配置文件:
#设置定时任务
task:
taskName1: #任务名称
switch: true #是否开启定时任务
cron: "0/5 * * * * ?" #任务表达式
taskName2: #任务名称
switch: true #是否开启定时任务
cron: "0/5 * * * * ?" #任务表达式
定时任务:
import org.springframework.scheduling.annotation.Scheduled;
import java.time.LocalDateTime;
/**
* cron表达式语法:[秒] [分] [小时] [日] [月] [周] [年]
* @Scheduled(fixedDelay = 5000) //上一次执行完毕时间点之后5秒再执行
* @Scheduled(fixedDelayString = "5000") //上一次执行完毕时间点之后5秒再执行
* @Scheduled(fixedRate = 5000) //上一次开始执行时间点之后5秒再执行
* @Scheduled(initialDelay=1000, fixedRate=5000) //第一次延迟1秒后执行,之后按fixedRate的规则每5秒执行一次
*
*/
//1.主要用于标记配置类
@Configuration
// 2.开启定时任务
@EnableScheduling
public class Schedule {
//3.添加定时任务
@Scheduled(cron = "0/5 * * * * ?")
//或直接指定时间间隔,例如:5秒
//@Scheduled(fixedRate=5000)
private void configureTasks() {
System.err.println("基于注解(@Scheduled)的简单定时器demo: " + LocalDateTime.now());
}
}
SchedulingConfigurer
定时任务抽象类:
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.SchedulingConfigurer;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.util.StringUtils;
import java.util.concurrent.*;
/**
* @description:基于接口SchedulingConfigurer的动态定时任务
*/
@Configuration
@EnableScheduling
public abstract class ConfigurerScheduling implements SchedulingConfigurer {
/**
* @brief 定时任务名称
*/
private String schedulerName;
/**
* @brief 定时任务周期表达式
*/
private String cron;
@Override
public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
scheduledTaskRegistrar.setScheduler(taskScheduler());
scheduledTaskRegistrar.addTriggerTask(
//执行定时任务
() -> {
processTask();
},
//设置触发器
triggerContext -> {
// 初始化定时任务周期
if (StringUtils.isEmpty(cron)) {
cron = getCron();
}
CronTrigger trigger = new CronTrigger(cron);
return trigger.nextExecutionTime(triggerContext);
}
);
}
/**
* 设置TaskScheduler用于注册计划任务
*
* @return
*/
@Bean(destroyMethod = "shutdown")
public Executor taskScheduler() {
//设置线程名称
ThreadFactory namedThreadFactory = new ThreadFactoryBuilder().setNameFormat("demo-pool-%d").build();
//创建线程池
return Executors.newScheduledThreadPool(5, namedThreadFactory);
}
/**
* @brief 任务的处理函数
* 本函数需要由派生类根据业务逻辑来实现
*/
protected abstract void processTask();
/**
* @return String
* @brief 获取定时任务周期表达式
* 本函数由派生类实现,从配置文件,数据库等方式获取参数值
*/
protected abstract String getCron();
}
实现类1
import com.example.schedule.ConfigurerSchedule.ConfigurerScheduling;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import java.time.LocalDateTime;
/**
* @fileName:TaskDemo1
* @createTime:2019/5/20 10:07
* @author:
* @version:
* @description:
*/
@Configuration
public class TaskDemo1 extends ConfigurerScheduling {
@Override
protected void processTask() {
if (isSwitch){
System.out.println("基于接口SchedulingConfigurer的动态定时任务:"
+ LocalDateTime.now()+",线程名称:"+Thread.currentThread().getName()
+ " 线程id:"+Thread.currentThread().getId());
}
}
@Override
protected String getCron() {
return cron;
}
}
实现类2:
package com.example.schedule.ConfigurerSchedule.task;
import com.example.schedule.ConfigurerSchedule.ConfigurerScheduling;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import java.time.LocalDateTime;
/**
* @fileName:TaskDemo2
* @createTime:2019/5/20 10:07
* @author:
* @version:
* @description:
*/
@Configuration
public class TaskDemo2 extends ConfigurerScheduling {
@Value(value = "${task.taskName2.switch}")
private Boolean isSwitch;
@Value(value = "${task.taskName2.cron}")
private String cron;
@Override
protected void processTask() {
if (isSwitch) {
System.out.println("基于接口SchedulingConfigurer的动态定时任务:"
+ LocalDateTime.now() + ",线程名称:" + Thread.currentThread().getName()
+ " 线程id:" + Thread.currentThread().getId());
}
}
@Override
protected String getCron() {
return cron;
}
}
动态改变的区别
上述的触发器触发时机是写在配置文件中的,虽然也可较方便的更改,但是更改完仍需要重启。
可以用静态内部类的形式定义自己的DynamicPeriodicTrigger:
改造实现类1/2:
@Configuration
public class TaskDemo2 extends ConfigurerScheduling {
@Value(value = "${task.taskName2.switch}")
private Boolean isSwitch;
@Setter(onMethod_ = {@Autowired})
private Setting settinge;
@Override
public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
scheduledTaskRegistrar.setScheduler(taskScheduler());
scheduledTaskRegistrar.addTriggerTask(
//执行定时任务
() -> {
processTask();
},
//设置触发器
new DynamicPeriodicTrigger(
setting.getDuration(SettingItem.INITIAL_DELAY),
setting,
SettingItem.TIME_INTERVAL)
);
}
@Override
protected void processTask() {
if (isSwitch) {
System.out.println("基于接口SchedulingConfigurer的动态定时任务:"
+ LocalDateTime.now() + ",线程名称:" + Thread.currentThread().getName()
+ " 线程id:" + Thread.currentThread().getId());
}
}
@Override
protected String getCron() {
return null;
}
/** 支持在运行时动态修改周期性调度的参数,而不用重启。 */
@AllArgsConstructor
public static class DynamicPeriodicTrigger implements Trigger {
//不设置程序启动后首次运行延时 默认为0
private Duration initialDelay = Duration.ZERO;
private Setting setting;
private SettingItem intervalSetting;
public DynamicPeriodicTrigger(Setting setting, SettingItem intervalSetting) {
this.setting = setting;
this.intervalSetting = intervalSetting;
}
@Override
public Date nextExecutionTime(@NotNull TriggerContext triggerContext) {
Date lastExecution = triggerContext.lastScheduledExecutionTime();
Date lastCompletion = triggerContext.lastCompletionTime();
if (lastExecution == null || lastCompletion == null) {
return new Date(triggerContext.getClock().millis() + initialDelay.toMillis());
}
// 读取动态间隔设置
Duration interval = settingService.getDuration(intervalSetting);
return new Date(lastCompletion.getTime() + interval.toMillis());
}
}
}
动态时间设置:
@Service
public class Setting {
public Duration getDuration(SettingItem item) {
Setting s = getSetting(item.getKey());
return parseDuration(s.getValue());
}
public Setting getSetting(String key) {
//只要改变数据库中时延 就可动态改变周期性的任务调度
return settingRepository
.findByKey(key);
}
}
@AllArgsConstructor
@Getter
public enum SettingItem {
INITIAL_DELAY("initial.delay", SettingType.DURATION),
TIME_INTERVAL("time.interval", SettingType.DURATION);
private final String key;
private final SettingType type;
public static SettingItem of(String key) {
SettingItem[] settingItems = SettingItem.values();
for (SettingItem settingItem : settingItems) {
if (StringUtils.equals(settingItem.getKey(), key)) {
return settingItem;
}
}
return null;
}
public enum SettingType {
DURATION;
}
}
参考:
https://blog.csdn.net/u013998466/article/details/90373811