Spring Task 是 Spring 框架的一个组件,它为任务调度提供了支持,使得开发者能够创建后台任务或定期执行的任务。通过 Spring Task,您可以方便地在 Java 应用程序中实现定时任务,比如每天凌晨进行数据同步、每小时执行一次清理操作等。
1 配置类启用定时任务支持
启动类添加
@EnableScheduling
注解,,以开启基于注解的任务调度器。
package com.by;
import cn.hutool.core.date.DateField;
import cn.hutool.core.date.DateUtil;
import com.by.timer.MyTimer;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;
import java.util.Date;
import java.util.Timer;
@SpringBootApplication
@Slf4j
@EnableScheduling
@EnableAsync
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
/*log.info("启动成功");
Timer timer = new Timer();
//timer.schedule(new MyTimer(),3000,5000);
//设置时间偏移量,偏移10s
Date newDate = DateUtil.offset(new Date(), DateField.SECOND, 10);
timer.schedule(new MyTimer(),newDate,5000);*/
}
}
2 同步定时任务
创建一个服务类或组件,在其中的方法上使用
@Scheduled
注解来定义定时任务。例如
/*
* Copyright (c) 2020, 2024, All rights reserved.
*
*/
package com.by.task;
import cn.hutool.core.thread.ThreadUtil;
import cn.hutool.core.util.RandomUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.Async;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
/**
* <p>Project: spring-task - ScheduledTask</p>
* <p>Powered by scl On 2024-04-15 14:22:23</p>
* <p>描述:<p>
*
* @author 孙臣龙 [1846080280@qq.com]
* @version 1.0
* @since 17
*/
@Component
@Slf4j
public class ScheduledTask {
/**
*重上一次结束后的3秒后重复执行,加上睡眠了5秒,执行一次一共8秒
* @return void
*/
@Scheduled(fixedDelay = 3000)
public void task() {
ThreadUtil.safeSleep(5000);
log.info("定时任务执行");
}
/**
* 每隔3s执行一次,设置了睡眠时间5s,每隔5秒执行一次
* @return void
*/
@Scheduled(fixedRate=3000)
public void task2() {
ThreadUtil.safeSleep(5000);
log.info("定时任务执行2");
}
// initialDelay首次延迟时间,fixedRate执行间隔时间
@Scheduled(initialDelay = 2000, fixedRate = 3000)
public void task3() {
ThreadUtil.safeSleep(5000);
log.info("定时任务执行3");
}
@Async
@Scheduled(fixedDelay = 3000)
public void task4() {
//ThreadUtil.safeSleep(5000);
log.info("定时任务执行4");
}
@Async
@Scheduled(cron = "0/2 * * * * ?")
public void task7() {
//ThreadUtil.safeSleep(2000);
log.info("定时任务执行7");
}
}
fixedDelay:
fixedRate:
3 异步定时任务(多线程执行任务)
开启异步支持: 要在 Spring Boot 应用中启用异步方法调用,需在启动类上添加
@EnableAsync
注解。
定义异步方法: 在服务类中定义一个方法,并使用
@Async
注解标记它以实现异步执行:
默认情况下,Spring Boot 会配置一个简单的异步任务执行器。但你可能需要调整其配置,如核心线程数、队列容量、最大线程数等. 例如:
# Spring Task 调度线程池大小,默认为 1,建议根据任务量进行调整。
# 如果不开启异步,可以理解为工厂经理们亲自处理任务
spring:
task:
scheduling:
pool:
size: 10
# 调度线程名称前缀,默认为 "scheduling-"
thread-name-prefix: scheduling-
# 任务执行线程池配置
execution:
pool:
# 核心线程池大小,默认为 8
core-size: 8
# 最大线程池大小,可以根据实际情况调整
max-size: 10
# 线程空闲时间(超时时间),超过这个时间没有任务则关闭线程,单位秒
keep-alive: 60s
# 队列容量,用于存放等待执行的任务,如果不指定,int.max
queue-capacity: 5
# 拒绝策略,当线程池和队列都满时如何处理新提交的任务,可选值有 AbortPolicy, CallerRunsPolicy 等
rejection-policy: CallerRunsPolicy
spring.task.scheduling.pool 和 spring.task.execution.pool 区别:
在 Spring Boot 中,
spring.task.scheduling.pool
和spring.task.execution.pool
分别对应着两种不同的线程池配置,分别服务于不同的目的:spring.task.scheduling.pool: 这个配置是针对 Spring Task 的定时任务调度器
ThreadPoolTaskScheduler
。当应用中使用@Scheduled
注解来定义和执行定时任务时,这个线程池负责调度和执行这些定时任务。配置这个线程池的大小(如size
属性),意味着你可以控制并发执行定时任务的线程数量,以此来优化系统资源利用,特别是在有多项定时任务需要并行执行时。spring.task.execution.pool: 这个配置是针对 Spring 异步任务执行器
ThreadPoolTaskExecutor
。当应用中使用@Async
注解来标记某个方法以异步方式执行时,这个线程池会被用来执行那些被异步调用的方法。配置这个线程池的核心线程数(core-size
)、最大线程数(max-size
)以及线程空闲存活时间(keep-alive
)等属性,可以帮助你管理和控制异步任务执行时的并发级别和资源利用率。总结来说,
spring.task.scheduling.pool
主要是用于管理定时任务的并发执行,而spring.task.execution.pool
则是处理程序中通过异步注解触发的非定时异步任务的并发执行。两者都是为了提高系统处理能力和响应速度,但是应用场景有所不同。