以下是我学习的一些记录
准备1
配置ThreadPoolTaskScheduler
@Configuration
public class SchedulingConfig {
@Bean
public TaskScheduler taskScheduler() {
ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
// 定时任务执行线程池核心线程数
taskScheduler.setPoolSize(6);
taskScheduler.setRemoveOnCancelPolicy(true);
taskScheduler.setThreadNamePrefix("TaskSchedulerThreadPool-");
return taskScheduler;
}
}
准备2
以下是具体的一些执行逻辑代码
这一段具体是做任务的注册的
package com.itentbase.job.user.task;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.config.CronTask;
import org.springframework.stereotype.Component;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* cron任务注册器
* @date 2023/11/06--03:41:16
*/
@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();
}
}
package com.itentbase.job.user.task;
import java.util.concurrent.ScheduledFuture;
/**
* 预定任务
*
* @date 2023/11/01--10:59:44
*/
public final class ScheduledTask {
volatile ScheduledFuture<?> future;
/**
* 取消定时任务
*/
public void cancel() {
ScheduledFuture<?> future = this.future;
if (future != null) {
future.cancel(true);
}
}
}
下面是具体要执行的定时任务时候,他是怎么去执行的(通过反射)
在这个之前需要一个工具类来从spring环境下根据bean的名称来获取对象
package com.itentbase.job.user.utils;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;
/**
* spring上下文实用工具
*
* @date 2023/11/01--11:02:06
*/
@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);
}
public static <T> T getBean(Class<T> requiredType) {
return applicationContext.getBean(requiredType);
}
public static <T> T getBean(String name, Class<T> requiredType) {
return applicationContext.getBean(name, requiredType);
}
public static boolean containsBean(String name) {
return applicationContext.containsBean(name);
}
public static boolean isSingleton(String name) {
return applicationContext.isSingleton(name);
}
public static Class<? extends Object> getType(String name) {
return applicationContext.getType(name);
}
}
package com.itentbase.job.user.task;
import com.itentbase.job.user.utils.SpringContextUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.ReflectionUtils;
import org.springframework.util.StringUtils;
import java.lang.reflect.Method;
import java.util.Objects;
/**
* 调度可运行
*
* @date 2023/11/01--11:02:43
*/
public class SchedulingRunnable implements Runnable {
private static final Logger logger = LoggerFactory.getLogger(SchedulingRunnable.class);
private String beanName;
private String methodName;
private String params;
public SchedulingRunnable(String beanName, String methodName) {
this(beanName, methodName, null);
}
public SchedulingRunnable(String beanName, String methodName, String params) {
this.beanName = beanName;
this.methodName = methodName;
this.params = params;
}
@Override
public void run() {
logger.info("定时任务开始执行 - bean:{},方法:{},参数:{}", beanName, methodName, params);
long startTime = System.currentTimeMillis();
try {
//根据bean的名称根据反射拿到具体的要执行的任务的类
Object target = SpringContextUtils.getBean(beanName);
Method method = null;
if (!StringUtils.isEmpty(params)) {
//如果有参数的的话就要执行有参数的这个方法
method = target.getClass().getDeclaredMethod(methodName, String.class);
} else {
method = target.getClass().getDeclaredMethod(methodName);
}
ReflectionUtils.makeAccessible(method);
if (!StringUtils.isEmpty(params)) {
method.invoke(target, params);
} else {
method.invoke(target);
}
} catch (Exception ex) {
logger.error(String.format("定时任务执行异常 - bean:%s,方法:%s,参数:%s ", beanName, methodName, params), ex);
}
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);
}
}
里面是具体要执行的定时任务,里面具体的逻辑可以自己修改
package com.itentbase.job.user.task;
import com.itentbase.job.user.service.company.JobService;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
@Slf4j
@Component("taskDemo")
@RequiredArgsConstructor
public class Task1 {
private final JobService jobService;
/**
* 任务(按参数)
*
* @param params params
* @author 陈光铭
* @time 2023/11/03--11:41:27
**/
public void taskByParams(String params) {
log.info("taskByParams执行时间:{}", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
log.info("taskByParams执行有参示例任务:{}",params);
}
/**
* 不需要额外参数的任务
*
* @author 陈光铭
* @time 2023/11/03--11:41:04
**/
public void taskNoParams() {
log.info("taskByParams执行时间:{}", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
}
public void test(String params) {
log.info("test执行时间:{}", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
log.info("test执行有参示例任务:{}",params);
ArrayList<String> strings = new ArrayList<>();
strings.add("s");
}
}
以下是需要的数据库表
CREATE TABLE `schedule_setting` (
`job_id` int(11) NOT NULL AUTO_INCREMENT COMMENT '任务ID',
`bean_name` varchar(255) DEFAULT NULL COMMENT 'bean名称',
`method_name` varchar(255) DEFAULT NULL COMMENT '方法名称',
`method_params` varchar(255) DEFAULT NULL COMMENT '方法参数',
`cron_expression` varchar(255) DEFAULT NULL COMMENT 'cron表达式',
`remark` varchar(255) DEFAULT NULL COMMENT '备注',
`job_status` int(11) DEFAULT NULL COMMENT '状态(1正常 0暂停)',
`create_time` datetime DEFAULT NULL COMMENT '创建时间',
`update_time` datetime DEFAULT NULL COMMENT '修改时间',
PRIMARY KEY (`job_id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4;
下面是这个表对应的实体类
package com.itentbase.job.user.pojo.po;
import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import lombok.Data;
import org.springframework.data.annotation.Id;
import java.util.Date;
/**
* 时间表设置
*
* @date 2023/11/01--11:36:50
*/
@Data
@TableName("schedule_setting")
public class ScheduleSetting extends Model<ScheduleSetting> {
/**
* 任务ID
*/
@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;
}
下面就是这个表可以先添加一些数据待会测试使用
在项目启动的时候完成加载以有的定时任务(里面初始化的任务就获取刚才在数据库里面添加的两条数据,这里我直接用mybayis-plus做的,你只要能把这个任务列表查出来就可以用了)
package com.itentbase.job.user.task;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.CollectionUtils;
import com.itentbase.job.user.mapper.ScheduleSettingMapper;
import com.itentbase.job.user.pojo.po.ScheduleSetting;
import lombok.RequiredArgsConstructor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Service;
import java.util.List;
/**
* 初始化线程调度池
*
* @author 陈光铭
* @date 2023/11/01--11:10:06
*/
@Service
@RequiredArgsConstructor
public class SysJobRunner implements CommandLineRunner {
private static final Logger logger = LoggerFactory.getLogger(SysJobRunner.class);
private final ScheduleSettingMapper scheduleSettingMapper;
@Autowired
private CronTaskRegistrar cronTaskRegistrar;
/**
* 从数据库里面拿到基本的定时任务配置
*
* @param args args
* @time 2023/11/03--10:04:57
**/
@Override
public void run(String... args) {
// 初始加载数据库里状态为正常的定时任务
ScheduleSetting existedSysJob = new ScheduleSetting();
LambdaQueryWrapper<ScheduleSetting> scheduleSettingLambdaQueryWrapper=new LambdaQueryWrapper<>();
scheduleSettingLambdaQueryWrapper.eq(ScheduleSetting::getJobStatus,1);
List<ScheduleSetting> jobList = scheduleSettingMapper.selectList(scheduleSettingLambdaQueryWrapper);
if (CollectionUtils.isNotEmpty(jobList)) {
for (ScheduleSetting job : jobList) {
SchedulingRunnable task = new SchedulingRunnable(job.getBeanName(), job.getMethodName(), job.getMethodParams());
cronTaskRegistrar.addCronTask(task, job.getCronExpression());
}
logger.info("定时任务已加载完毕...");
}
}
}
最后这是对外暴露的controller接口,直接可以通过接口来修改定时任务
package com.itentbase.job.user.controller;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import com.itentbase.job.user.pojo.po.ScheduleSetting;
import com.itentbase.job.user.task.CronTaskRegistrar;
import com.itentbase.job.user.task.SchedulingRunnable;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.Date;
@RestController
@RequestMapping("/user/scheduleSetting")
public class TestController {
@Autowired
private CronTaskRegistrar cronTaskRegistrar;
/**
* 添加定时任务
*
* @param sysJob
* @return
*/
@PostMapping("add")
public boolean add(@RequestBody ScheduleSetting sysJob) {
sysJob.setCreateTime(new Date());
sysJob.setUpdateTime(new Date());
boolean insert = sysJob.insert();
if (!insert) {
return false;
} else {
// 添加成功,并且状态是1,直接放入任务器
if (sysJob.getJobStatus().equals(1)) {
//得到执行的实体类和具体的方法和执行改方法可能要用到的参数,返回一个runnable对象
SchedulingRunnable task = new SchedulingRunnable(sysJob.getBeanName(), sysJob.getMethodName(), sysJob.getMethodParams());
cronTaskRegistrar.addCronTask(task, sysJob.getCronExpression());
}
}
return insert;
}
/**
* 修改定时任务
*
* @param sysJob
* @return
*/
@PostMapping("update")
public boolean update(@RequestBody ScheduleSetting sysJob) {
sysJob.setCreateTime(new Date());
sysJob.setUpdateTime(new Date());
// 查询修改前任务
ScheduleSetting existedSysJob = new ScheduleSetting();
existedSysJob = existedSysJob.selectOne(new QueryWrapper<ScheduleSetting>().eq("job_id", sysJob.getJobId()));
// 修改任务
boolean update = sysJob.update(new UpdateWrapper<ScheduleSetting>().eq("job_id", sysJob.getJobId()));
if (!update) {
return false;
} else {
// 修改成功,则先删除任务器中的任务,并重新添加
SchedulingRunnable task1 = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
cronTaskRegistrar.removeCronTask(task1);
if (sysJob.getJobStatus().equals(1)) {// 如果修改后的任务状态是1就加入任务器
SchedulingRunnable task = new SchedulingRunnable(sysJob.getBeanName(), sysJob.getMethodName(), sysJob.getMethodParams());
cronTaskRegistrar.addCronTask(task, sysJob.getCronExpression());
}
}
return update;
}
/**
* 删除任务
*
* @param jobId
* @return
*/
@PostMapping("del/{jobId}")
public boolean del(@PathVariable("jobId") Integer jobId) {
// 先查询要删除的任务信息
ScheduleSetting existedSysJob = new ScheduleSetting();
existedSysJob = existedSysJob.selectOne(new QueryWrapper<ScheduleSetting>().eq("job_id", jobId));
// 删除
boolean del = existedSysJob.delete(new QueryWrapper<ScheduleSetting>().eq("job_id", jobId));
if (!del) {
return false;
} else {// 删除成功时要清除定时任务器中的对应任务
SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
cronTaskRegistrar.removeCronTask(task);
}
return del;
}
// 停止/启动任务
@PostMapping("changesStatus/{jobId}/{stop}")
public boolean changesStatus(@PathVariable("jobId") Integer jobId, @PathVariable("stop") Integer stop) {
// 修改任务状态
ScheduleSetting scheduleSetting = new ScheduleSetting();
scheduleSetting.setJobStatus(stop);
boolean job_id = scheduleSetting.update(new UpdateWrapper<ScheduleSetting>().eq("job_id", jobId));
if (!job_id) {
return false;
}
// 查询修改后的任务信息
ScheduleSetting existedSysJob = new ScheduleSetting();
existedSysJob = existedSysJob.selectOne(new QueryWrapper<ScheduleSetting>().eq("job_id", jobId));
// 如果状态是1则添加任务
if (existedSysJob.getJobStatus().equals(1)) {
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);
}
return true;
}
}
准备完这些就可以直接用了,有问腿的地方可以下面留言评论。