SpringBoot 동적 예약 작업을 구현하는 방법
- 王林앞으로
- 2023-05-21 14:05:301200검색
예약된 작업을 실행하기 위한 스레드 풀 구성 클래스
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
@Configuration
public class SchedulingConfig {
@Bean
public TaskScheduler taskScheduler() {
ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
// 定时任务执行线程池核心线程数
taskScheduler.setPoolSize(6);
taskScheduler.setRemoveOnCancelPolicy(true);
taskScheduler.setThreadNamePrefix("TaskSchedulerThreadPool-");
return taskScheduler;
}
}ScheduledFuture의 Paper 클래스
ScheduledFuture는 ScheduledExecutorService 예약된 작업 스레드 풀의 실행 결과입니다.
import java.util.concurrent.ScheduledFuture;
public final class ScheduledTask {
volatile ScheduledFuture<?> future;
/**
* 取消定时任务
*/
public void cancel() {
ScheduledFuture<?> future = this.future;
if (future != null) {
future.cancel(true);
}
}
}실행 가능 인터페이스 구현 클래스
는 지정된 Bean의 메소드를 실행하기 위해 예약된 작업 스레드 풀에 의해 호출됩니다.
import com.ying.demo.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;
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 {
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);
}
}Timed 작업 등록 클래스
Timed 작업 추가 및 삭제에 사용
@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();
}
}Timed 작업 예제 클래스
@Slf4j
@Component("taskDemo")
public class Task1 {
public void taskByParams(String params) {
log.info("taskByParams执行时间:{}", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
log.info("taskByParams执行有参示例任务：{}",params);
}
public void taskNoParams() {
log.info("taskByParams执行时间:{}", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
log.info("taskNoParams执行无参示例任务");
}
public void test(String params) {
log.info("test执行时间:{}", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
log.info("test执行有参示例任务：{}",params);
}
}데이터베이스 테이블 디자인
CREATE TABLE `schedule_setting` ( `job_id` int NOT NULL AUTO_INCREMENT COMMENT '任务ID', `bean_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT 'bean名称', `method_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '方法名称', `method_params` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '方法参数', `cron_expression` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT 'cron表达式', `remark` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '备注', `job_status` int 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=7 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
Entity 클래스
@Data
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;
}Timed 작업 준비
Spring Boot 프로젝트가 끝난 후 시작됨, 정상 상태로 데이터베이스에 예약된 작업 로드
@Service
public class SysJobRunner implements CommandLineRunner {
private static final Logger logger = LoggerFactory.getLogger(SysJobRunner.class);
@Autowired
private CronTaskRegistrar cronTaskRegistrar;
@Override
public void run(String... args) {
// 初始加载数据库里状态为正常的定时任务
ScheduleSetting existedSysJob = new ScheduleSetting();
List<ScheduleSetting> jobList = existedSysJob.selectList(new QueryWrapper<ScheduleSetting>().eq("job_status", 1));
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("定时任务已加载完毕...");
}
}
}Tool 클래스
스프링 컨테이너에서 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);
}
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);
}
}예약된 작업: 추가/삭제/수정/시작/일시 중지
@RestController
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 {
if (sysJob.getJobStatus().equals(1)) {// 添加成功,并且状态是1，直接放入任务器
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;
}
cron
cron 표현식 구문:
[초] [분] [시] [일] [월] [주] [년]
참고: [년]은 필수 필드가 아니며, [년]은 생략 가능합니다. 따라서 총 6개가 있습니다. 필드
와일드카드 설명:
*은 모든 값을 나타냅니다. 예를 들어 분 필드에 *를 설정하면 1분마다 트리거된다는 의미입니다.
?은 값이 지정되지 않았음을 의미합니다. 사용 시나리오에서는 이 필드의 현재 값에 신경 쓸 필요가 없습니다. 예를 들어, 매월 10일에 작업을 트리거하고 싶지만 요일이 무슨 요일인지는 상관하지 않으므로 주의 위치 필드를 "?"로 설정해야 합니다. 0 0 0 10 * ?
- 간격을 나타냅니다. 예를 들어, 시간에 "10-12"를 설정하면 10시, 11시, 12시에 트리거된다는 의미입니다.
는 여러 값을 지정하는 것을 의미합니다. 예를 들어 주 필드에 "MON,WED,FRI"를 설정하면 월요일, 수요일, 금요일에 트리거되는 것을 의미합니다.
/는 증분 트리거에 사용됩니다. 초 수를 "5/15"로 설정합니다. 즉, 5초부터 시작하여 15초마다(예: 5초, 20초, 35초, 50초) 트리거됩니다. 매월 1일에 시작하고 3일마다 트리거되도록 날짜 필드에 "1/3"을 설정합니다.
L은 마지막 단어를 의미합니다. 일 필드 설정에서는 해당 달의 마지막 날을 나타내며(당월 기준으로 2월이면 윤년 여부에 따라 다름), 주 필드에서는 토요일을 나타냅니다. "7" 또는 "SAT"에 해당합니다. "L" 앞에 숫자를 추가하면 마지막 데이터를 의미합니다. 예를 들어 주 필드에 "6L"과 같은 형식을 설정하면 "이번 달의 마지막 금요일"을 의미하고
W는 지정된 날짜에 가장 가까운 근무일(월요일~금요일)을 의미합니다. 예를 들어 ""를 설정하면 날짜 필드는 15W"로, 매월 15일에 가장 가까운 근무일에 트리거됨을 나타냅니다. 15일이 토요일인 경우 가장 가까운 금요일(14일)에 트리거가 발견되며, 15일이 주말인 경우에는 가장 가까운 월요일(16일)에 트리거가 발견됩니다. 근무일(월요일~일요일) 5) 해당 날짜에 트리거됩니다. 지정된 형식이 "1W"인 경우 매월 1일 이후 가장 늦은 영업일에 트리거되는 것을 의미합니다. 1일이 토요일이면 3일 월요일에 발동됩니다. (참고로 "W" 앞에는 특정 숫자만 설정할 수 있으며 "-" 간격은 허용되지 않습니다.)
# 일련번호(매월 요일 표시), 예를 들어 주 필드에 "6#3"을 설정하면 매월 세 번째 토요일을 의미합니다. "#5를 지정하면 주의하세요. ", 이는 해당 월의 정확한 날짜가 됩니다. 5주 동안 토요일이 없으면 이 구성은 트리거되지 않습니다(어머니날과 아버지날에 적합). 팁: "L" 및 "W"는 다음에서 사용할 수 있습니다. 콤비네이션. 요일 필드에 "LW"가 설정되어 있으면 이번 달의 마지막 근무일에 트리거된다는 의미입니다. 영어 문자를 사용하면 주 필드 설정이 대소문자를 구분하지 않습니다. 즉, MON이 동일합니다. 월요일로.
예:
5초마다 실행: */5 * * * * ?
1분마다 실행: 0 */1 * * * ?
매일 23:00에 한 번 실행: 0 0 23 * * ?
매일 오전 1시에 한 번 실행: 0 0 1 * * ?
매월 1일 오전 1시에 한 번 실행: 0 0 1 1 * ?
23:00에 한 번 실행 매월 말일 ：0 0 23 L * ?
매주 토요일 오전 1시에 한 번 실행: 0 0 1 ? * L
26분, 29분, 33분에 한 번 실행: 0 26,29, 33 * * * ?
매일 0:00, 13:00, 18:00, 21:00에 한 번 실행: 0 0 0,13,18,21 * * ?
cron 온라인 표현식 생성기: http://tools.jb51.net /code/Quartz_Cron_create
위 내용은 SpringBoot 동적 예약 작업을 구현하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!
성명：
이 기사는 yisu.com에서 복제됩니다. 침해가 있는 경우 admin@php.cn으로 문의하시기 바랍니다. 삭제