springboot不重启应用动态添加修改删除定时任务(以cron定时方式为例)

一、实现目标:

    动态的添加修改删除cron定时任务,不需要重启应用,包括动态修改某个定时任务的cron定时时间以及任务内容的变化

二、实现思路:

 1.设计存储任务信息的文件,此处采用json文件存储,认定task-xxx.json名称的文件为存储任务信息的文件,此处只做简单的日志打印

{
  "cron" : "0 17 15 * * ?",
  "taskInfo" : {
    "taskName" : "myTask1",
    "operation" : "创建定时任务"
  }
}

2. 监控任务信息文件的变化,此处采用FileAlterationMonitor方式监控(这种方式比线程通知的方式要简单)

    此种方式的缺点在于检测文件删除的时候会直接删除文件,这样就无法读取到文件内容

    https://blog.csdn.net/qq_37549757/article/details/93882858

3.添加修改删除定时任务,采用ThreadPoolTaskScheduler方式去添加修改删除定时任务

    https://blog.csdn.net/qq_37549757/article/details/93876875

   下面的例子是在创建定时任务trigger的时候使用的cronTrigger定时器注册,实际当中可以按照需求来选择定时器

    因为采用FileAlterationMonitor监控的时候,当发生的变化为删除文件时无法读取到文件的内容(组件会直接删除文件),所以说在存储定时任务的时候,key可以带上文件名(因为删除操作的时候只能拿到文件的一部分信息,拿不到内容),并在定时任务处理工具类中要添加以文件名删除任务的方法,并使用该方法去删除定时任务去解决此问题,如果任务名不存储在文件内容里则不需要在存储任务列表的时候key加上文件名,此处例子key=fileName_taskName

三、项目结构

1.model包:json文件bean模型

2.util包:

     json文件转bean工具;

     文件变化观察者工具;

     定时任务处理工具(添加修改删除定时任务);

3.listener包:文件监听器去处理文件变化

4.config包:

     启动项目时启动文件观察者及相关的配置

     启动项目时为文件夹下面已经存在的任务信息文件添加定时任务

 

四、代码实现,采用springboot方式实现

1.项目需要额外依赖于commons-io(文件监听需要)和fastjson包(json转bean需要),当然springboot的start包是最基本的也需要

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.54</version>
</dependency>

<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.5</version>
</dependency>

2.json文件对应的模型文件

package com.holidaylee.model;

/**
 * @author : HolidayLee
 * @description : 任务例子模型
 */
public class TaskExampleModel {
	/**
	 * 定时时间表达式
	 */
	private String cron;
	/**
	 * 任务信息
	 */
	private TaskInfoModel taskInfo;

	public String getCron() {
		return cron;
	}

	public void setCron(String cron) {
		this.cron = cron;
	}

	public TaskInfoModel getTaskInfo() {
		return taskInfo;
	}

	public void setTaskInfo(TaskInfoModel taskInfo) {
		this.taskInfo = taskInfo;
	}
}

package com.holidaylee.model;

/**
 * @author : HolidayLee
 * @description : 任务信息模型
 */
public class TaskInfoModel {
	/**
	 * 任务名
	 */
	private String taskName;
	/**
	 * 操作内容
	 */
	private String operation;

	public String getTaskName() {
		return taskName;
	}

	public void setTaskName(String taskName) {
		this.taskName = taskName;
	}

	public String getOperation() {
		return operation;
	}

	public void setOperation(String operation) {
		this.operation = operation;
	}
}

3.json文件转bean处理工具

package com.holidaylee.util;

import com.alibaba.fastjson.JSONObject;
import com.holidaylee.model.TaskExampleModel;
import org.apache.commons.io.FileUtils;
import org.springframework.stereotype.Component;

import java.io.File;
import java.io.IOException;

/**
 * @author : HolidayLee
 * @description : 将任务信息json文件转换为模型
 */
@Component
public class ReadJsonTaskInfoToBeanUtils {

	public TaskExampleModel convertFileToBean(File taskFile) {
		TaskExampleModel task = null;
		if (taskFile.isFile()) {
			try {
				String json = FileUtils.readFileToString(taskFile, "utf-8");
				task = JSONObject.parseObject(json, TaskExampleModel.class);
			} catch (IOException e) {
				e.printSt