【074期】摒弃“机械化”编码，Spring Boot 实现动态增删启停定时任务

long times = System.currentTimeMillis() - startTime;

logger.info(“定时任务执行结束 - bean：{}，方法：{}，参数：{}，耗时：{} 毫秒”, beanName, methodName, params, times);

}

@Override

public boolean equals(Object o) {

if (this == o) return true;

if (o == null || getClass() != o.getClass()) return false;

SchedulingRunnable that = (SchedulingRunnable) o;

if (params == null) {

return beanName.equals(that.beanName) &&

methodName.equals(that.methodName) &&

that.params == null;

}

return beanName.equals(that.beanName) &&

methodName.equals(that.methodName) &&

params.equals(that.params);

}

@Override

public int hashCode() {

if (params == null) {

return Objects.hash(beanName, methodName);

}

return Objects.hash(beanName, methodName, params);

}

}

添加定时任务注册类，用来增加、删除定时任务。

@Component

public class CronTaskRegistrar implements DisposableBean {

private final Map<Runnable, ScheduledTask> scheduledTasks = new ConcurrentHashMap<>(16);

@Autowired

private TaskScheduler taskScheduler;

public TaskScheduler getScheduler() {

return this.taskScheduler;

}

public void addCronTask(Runnable task, String cronExpression) {

addCronTask(new CronTask(task, cronExpression));

}

public void addCronTask(CronTask cronTask) {

if (cronTask != null) {

Runnable task = cronTask.getRunnable();

if (this.scheduledTasks.containsKey(task)) {

removeCronTask(task);

}

this.scheduledTasks.put(task, scheduleCronTask(cronTask));

}

}

public void removeCronTask(Runnable task) {

ScheduledTask scheduledTask = this.scheduledTasks.remove(task);

if (scheduledTask != null)

scheduledTask.cancel();

}

public ScheduledTask scheduleCronTask(CronTask cronTask) {

ScheduledTask scheduledTask = new ScheduledTask();

scheduledTask.future = this.taskScheduler.schedule(cronTask.getRunnable(), cronTask.getTrigger());

return scheduledTask;

}

@Override

public void destroy() {

for (ScheduledTask task : this.scheduledTasks.values()) {

task.cancel();

}

this.scheduledTasks.clear();

}

}

添加定时任务示例类

@Component(“demoTask”)

public class DemoTask {

public void taskWithParams(String params) {

System.out.println(“执行有参示例任务：” + params);

}

public void taskNoParams() {

System.out.println(“执行无参示例任务”);

}

}

定时任务数据库表设计

定时任务数据库表设计

添加定时任务实体类

public class SysJobPO {

/**

* 任务ID

*/

private Integer jobId;

/**

* bean名称

*/

private String beanName;

/**

* 方法名称

*/

private String methodName;

/**

* 方法参数

*/

private String methodParams;

/**

* cron表达式

*/

private String cronExpression;

/**

* 状态（1正常 0暂停）

*/

private Integer jobStatus;

/**

* 备注

*/

private String remark;

/**

* 创建时间

*/

private Date createTime;

/**

* 更新时间

*/

private Date updateTime;

public Integer getJobId() {

return jobId;

}

public void setJobId(Integer jobId) {

this.jobId = jobId;

}

public String getBeanName() {

return beanName;

}

public void setBeanName(String beanName) {

this.beanName = beanName;

}

public String getMethodName() {

return methodName;

}

public void setMethodName(String methodName) {

this.methodName = methodName;

}

public String getMethodParams() {

return methodParams;

}

public void setMethodParams(String methodParams) {

this.methodParams = methodParams;

}

public String getCronExpression() {

return cronExpression;

}

public void setCronExpression(String cronExpression) {

this.cronExpression = cronExpression;

}

public Integer getJobStatus() {

return jobStatus;

}

public void setJobStatus(Integer jobStatus) {

this.jobStatus = jobStatus;

}

public String getRemark() {

return remark;

}

public void setRemark(String remark) {

this.remark = remark;

}

public Date getCreateTime() {

return createTime;

}

public void setCreateTime(Date createTime) {

this.createTime = createTime;

}

public Date getUpdateTime() {

return updateTime;

}

public void setUpdateTime(Date updateTime) {

this.updateTime = updateTime;

}

}

新增定时任务

新增定时任务

boolean success = sysJobRepository.addSysJob(sysJob);

if (!success)

return OperationResUtils.fail(“新增失败”);

else {

if (sysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {

SchedulingRunnable task = new SchedulingRunnable(sysJob.getBeanName(), sysJob.getMethodName(), sysJob.getMethodParams());

cronTaskRegistrar.addCronTask(task, sysJob.getCronExpression());

}

}

return OperationResUtils.success();

修改定时任务，先移除原来的任务，再启动新任务

boolean success = sysJobRepository.editSysJob(sysJob);

if (!success)

return OperationResUtils.fail(“编辑失败”);

else {

//先移除再添加

if (existedSysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {

SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());

cronTaskRegistrar.removeCronTask(task);

}

if (sysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {

SchedulingRunnable task = new SchedulingRunnable(sysJob.getBeanName(), sysJob.getMethodName(), sysJob.getMethodParams());

cronTaskRegistrar.addCronTask(task, sysJob.getCronExpression());

}

}

return OperationResUtils.success();

删除定时任务

boolean success = sysJobRepository.deleteSysJobById(req.getJobId());

if (!success)

return OperationResUtils.fail(“删除失败”);

else{

if (existedSysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {

SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());

cronTaskRegistrar.removeCronTask(task);

}

}

return OperationResUtils.success();

定时任务启动/停止状态切换

if (existedSysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {

SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());

cronTaskRegistrar.addCronTask(task, existedSysJob.getCronExpression());

} else {

SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());

cronTaskRegistrar.removeCronTask(task);

}

添加实现了CommandLineRunner接口的SysJobRunner类，当spring boot项目启动完成后，加载数据库里状态为正常的定时任务。

@Service

public class SysJobRunner implements CommandLineRunner {

private static final Logger logger = LoggerFactory.getLogger(SysJobRunner.class);

@Autowired

private ISysJobRepository sysJobRepository;

@Autowired

private CronTaskRegistrar cronTaskRegistrar;

@Override

public void run(String… args) {

// 初始加载数据库里状态为正常的定时任务

List jobList = sysJobRepository.getSysJobListByStatus(SysJobStatus.NORMAL.ordinal());

if (CollectionUtils.isNotEmpty(jobList)) {

for (SysJobPO job : jobList) {

SchedulingRunnable task = new SchedulingRunnable(job.getBeanName(), job.getMethodName(), job.getMethodParams());

cronTaskRegistrar.addCronTask(task, job.getCronExpression());

}

logger.info(“定时任务已加载完毕…”);

}

}

}

工具类SpringContextUtils，用来从spring容器里获取bean

@Component

public class SpringContextUtils implements ApplicationContextAware {

private static ApplicationContext applicationContext;

@Override

public void setApplicationContext(ApplicationContext applicationContext)

throws BeansException {

SpringContextUtils.applicationContext = applicationContext;

}

public static Object getBean(String name) {

return applicationContext.getBean(name);