任务执行与调度
Spring Framework 分别通过 TaskExecutor
和 TaskScheduler
接口提供了任务异步执行和调度的抽象。Spring 还提供了这些接口的实现,支持线程池或在应用服务器环境中委托给 CommonJ。最终,在通用接口后使用这些实现抽象了 Java SE 和 Jakarta EE 环境之间的差异。
Spring 还提供了集成类,支持使用 Quartz Scheduler 进行调度。
Spring TaskExecutor
抽象
Executors 是 JDK 对线程池概念的命名。“executor” 的命名是因为无法保证底层实现确实是线程池。Executor 可以是单线程的,甚至是同步的。Spring 的抽象隐藏了 Java SE 和 Jakarta EE 环境之间的实现细节。
Spring 的 TaskExecutor
接口与 java.util.concurrent.Executor
接口相同。实际上,最初它存在的主要原因是为了在使用线程池时抽象掉对 Java 5 的依赖。该接口有一个方法 (execute(Runnable task)
),根据线程池的语义和配置接受一个任务来执行。
TaskExecutor
最初创建的目的是为了给其他 Spring 组件提供线程池抽象。诸如 ApplicationEventMulticaster
、JMS 的 AbstractMessageListenerContainer
和 Quartz 集成等组件都使用 TaskExecutor
抽象来管理线程池。但是,如果您的 Bean 需要线程池行为,您也可以使用此抽象来满足您的需求。
TaskExecutor
类型
Spring 包含了一些预构建的 TaskExecutor
实现。在大多数情况下,您应该不需要自己实现。Spring 提供的变体如下
-
SyncTaskExecutor
: 此实现不会异步运行调用。相反,每次调用都在调用线程中发生。它主要用于不需要多线程的情况,例如简单的测试用例。 -
SimpleAsyncTaskExecutor
: 此实现不重用任何线程。相反,它为每次调用启动一个新线程。但是,它确实支持一个并发限制,超出限制的调用会被阻塞,直到有空闲槽位。如果您需要真正的线程池,请参阅列表后面的ThreadPoolTaskExecutor
。当启用 "virtualThreads" 选项时,它将使用 JDK 21 的虚拟线程。此实现还通过 Spring 的生命周期管理支持优雅停机。 -
ConcurrentTaskExecutor
: 此实现是java.util.concurrent.Executor
实例的适配器。有一个替代方案 (ThreadPoolTaskExecutor
),它将Executor
配置参数暴露为 bean 属性。通常很少需要直接使用ConcurrentTaskExecutor
。但是,如果ThreadPoolTaskExecutor
对于您的需求不够灵活,ConcurrentTaskExecutor
是一个替代方案。 -
ThreadPoolTaskExecutor
: 此实现是最常用的。它暴露了配置java.util.concurrent.ThreadPoolExecutor
的 bean 属性,并将其封装在TaskExecutor
中。如果您需要适配不同类型的java.util.concurrent.Executor
,我们建议您改用ConcurrentTaskExecutor
。它还通过 Spring 的生命周期管理提供了暂停/恢复功能和优雅停机。 -
DefaultManagedTaskExecutor
: 此实现在 JSR-236 兼容的运行时环境(例如 Jakarta EE 应用服务器)中使用通过 JNDI 获取的ManagedExecutorService
,取代 CommonJ WorkManager 来实现此目的。
使用 TaskExecutor
Spring 的 TaskExecutor
实现通常与依赖注入一起使用。在以下示例中,我们定义了一个使用 ThreadPoolTaskExecutor
异步打印一组消息的 bean
-
Java
-
Kotlin
public class TaskExecutorExample {
private class MessagePrinterTask implements Runnable {
private String message;
public MessagePrinterTask(String message) {
this.message = message;
}
public void run() {
System.out.println(message);
}
}
private TaskExecutor taskExecutor;
public TaskExecutorExample(TaskExecutor taskExecutor) {
this.taskExecutor = taskExecutor;
}
public void printMessages() {
for(int i = 0; i < 25; i++) {
taskExecutor.execute(new MessagePrinterTask("Message" + i));
}
}
}
class TaskExecutorExample(private val taskExecutor: TaskExecutor) {
private inner class MessagePrinterTask(private val message: String) : Runnable {
override fun run() {
println(message)
}
}
fun printMessages() {
for (i in 0..24) {
taskExecutor.execute(
MessagePrinterTask(
"Message$i"
)
)
}
}
}
如您所见,您不是从线程池中获取线程并自己执行,而是将 Runnable
添加到队列中。然后 TaskExecutor
使用其内部规则来决定何时运行任务。
要配置 TaskExecutor
使用的规则,我们暴露了简单的 bean 属性
-
Java
-
Kotlin
-
Xml
@Bean
ThreadPoolTaskExecutor taskExecutor() {
ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
taskExecutor.setCorePoolSize(5);
taskExecutor.setMaxPoolSize(10);
taskExecutor.setQueueCapacity(25);
return taskExecutor;
}
@Bean
TaskExecutorExample taskExecutorExample(ThreadPoolTaskExecutor taskExecutor) {
return new TaskExecutorExample(taskExecutor);
}
@Bean
fun taskExecutor() = ThreadPoolTaskExecutor().apply {
corePoolSize = 5
maxPoolSize = 10
queueCapacity = 25
}
@Bean
fun taskExecutorExample(taskExecutor: ThreadPoolTaskExecutor) = TaskExecutorExample(taskExecutor)
<bean id="taskExecutor" class="org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor">
<property name="corePoolSize" value="5"/>
<property name="maxPoolSize" value="10"/>
<property name="queueCapacity" value="25"/>
</bean>
<bean id="taskExecutorExample" class="TaskExecutorExample">
<constructor-arg ref="taskExecutor"/>
</bean>
大多数 TaskExecutor
实现提供了一种使用 TaskDecorator
自动包装提交的任务的方法。装饰器应该委托给它包装的任务,可能在任务执行之前/之后实现自定义行为。
让我们考虑一个简单的实现,它将在任务执行之前和之后记录消息
-
Java
-
Kotlin
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.core.task.TaskDecorator;
public class LoggingTaskDecorator implements TaskDecorator {
private static final Log logger = LogFactory.getLog(LoggingTaskDecorator.class);
@Override
public Runnable decorate(Runnable runnable) {
return () -> {
logger.debug("Before execution of " + runnable);
runnable.run();
logger.debug("After execution of " + runnable);
};
}
}
import org.apache.commons.logging.Log
import org.apache.commons.logging.LogFactory
import org.springframework.core.task.TaskDecorator
class LoggingTaskDecorator : TaskDecorator {
override fun decorate(runnable: Runnable): Runnable {
return Runnable {
logger.debug("Before execution of $runnable")
runnable.run()
logger.debug("After execution of $runnable")
}
}
companion object {
private val logger: Log = LogFactory.getLog(
LoggingTaskDecorator::class.java
)
}
}
然后我们可以在 TaskExecutor
实例上配置我们的装饰器
-
Java
-
Kotlin
-
Xml
@Bean
ThreadPoolTaskExecutor decoratedTaskExecutor() {
ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
taskExecutor.setTaskDecorator(new LoggingTaskDecorator());
return taskExecutor;
}
@Bean
fun decoratedTaskExecutor() = ThreadPoolTaskExecutor().apply {
setTaskDecorator(LoggingTaskDecorator())
}
<bean id="decoratedTaskExecutor" class="org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor">
<property name="taskDecorator" ref="loggingTaskDecorator"/>
</bean>
如果需要多个装饰器,可以使用 org.springframework.core.task.support.CompositeTaskDecorator
按顺序执行多个装饰器。
Spring TaskScheduler
抽象
除了 TaskExecutor
抽象外,Spring 还有一个 TaskScheduler
SPI,提供了多种方法用于调度任务在将来某个时间点运行。以下列表显示了 TaskScheduler
接口定义
public interface TaskScheduler {
Clock getClock();
ScheduledFuture schedule(Runnable task, Trigger trigger);
ScheduledFuture schedule(Runnable task, Instant startTime);
ScheduledFuture scheduleAtFixedRate(Runnable task, Instant startTime, Duration period);
ScheduledFuture scheduleAtFixedRate(Runnable task, Duration period);
ScheduledFuture scheduleWithFixedDelay(Runnable task, Instant startTime, Duration delay);
ScheduledFuture scheduleWithFixedDelay(Runnable task, Duration delay);
最简单的方法是名为 schedule
的方法,它只接受一个 Runnable
和一个 Instant
。这将导致任务在指定时间后运行一次。所有其他方法都能够调度任务重复运行。固定速率(fixed-rate)和固定延迟(fixed-delay)方法用于简单的周期性执行,但接受 Trigger
的方法更加灵活。
Trigger
接口
Trigger
接口本质上受到 JSR-236 的启发。Trigger
的基本思想是执行时间可以基于过去的执行结果或甚至任意条件来确定。如果这些确定考虑了先前执行的结果,则该信息可在 TriggerContext
中获取。Trigger
接口本身非常简单,如下所示
public interface Trigger {
Instant nextExecution(TriggerContext triggerContext);
}
TriggerContext
是最重要的部分。它封装了所有相关数据,并在将来需要时可进行扩展。TriggerContext
是一个接口(默认使用 SimpleTriggerContext
实现)。以下列表显示了 Trigger
实现可用的方法。
public interface TriggerContext {
Clock getClock();
Instant lastScheduledExecution();
Instant lastActualExecution();
Instant lastCompletion();
}
Trigger
实现
Spring 提供了 Trigger
接口的两种实现。最有趣的是 CronTrigger
。它基于 cron 表达式 启用任务调度。例如,以下任务被调度在每个小时的 15 分钟后运行,但仅在工作日的 9 点到 17 点的“工作时间”内运行
scheduler.schedule(task, new CronTrigger("0 15 9-17 * * MON-FRI"));
另一个实现是 PeriodicTrigger
,它接受一个固定周期、一个可选的初始延迟值,以及一个布尔值指示周期应解释为固定速率还是固定延迟。由于 TaskScheduler
接口已经定义了以固定速率或固定延迟调度任务的方法,所以应尽可能直接使用这些方法。PeriodicTrigger
实现的价值在于您可以在依赖 Trigger
抽象的组件中使用它。例如,允许周期性触发器、基于 cron 的触发器甚至自定义触发器实现可互换使用可能会很方便。此类组件可以利用依赖注入,以便您可以从外部配置此类 Triggers
,从而轻松修改或扩展它们。
TaskScheduler
实现
与 Spring 的 TaskExecutor
抽象一样,TaskScheduler
设计的主要优点是应用程序的调度需求与部署环境解耦。当部署到应用服务器环境时,这种抽象级别尤为重要,因为在该环境中不应由应用程序本身直接创建线程。对于此类场景,Spring 提供了 DefaultManagedTaskScheduler
,它在 Jakarta EE 环境中委托给 JSR-236 ManagedScheduledExecutorService
。
当不需要外部线程管理时,一个更简单的替代方案是在应用程序内部设置一个本地 ScheduledExecutorService
,这可以通过 Spring 的 ConcurrentTaskScheduler
进行适配。为了方便起见,Spring 还提供了一个 ThreadPoolTaskScheduler
,它内部委托给一个 ScheduledExecutorService
,以提供类似于 ThreadPoolTaskExecutor
的通用 bean 风格配置。这些变体在宽松的应用服务器环境(尤其是在 Tomcat 和 Jetty 上)中也适用于本地嵌入式线程池设置。
从 6.1 版本开始,ThreadPoolTaskScheduler
通过 Spring 的生命周期管理提供了暂停/恢复功能和优雅停机。还有一个新选项 SimpleAsyncTaskScheduler
,它与 JDK 21 的虚拟线程对齐,使用单个调度器线程,但为每个调度任务执行启动一个新线程(固定延迟任务除外,它们都在单个调度器线程上运行,因此对于此与虚拟线程对齐的选项,建议使用固定速率和 cron 触发器)。
调度和异步执行的注解支持
Spring 为任务调度和异步方法执行提供了注解支持。
启用调度注解
要启用对 @Scheduled
和 @Async
注解的支持,您可以将 @EnableScheduling
和 @EnableAsync
添加到您的 @Configuration
类之一,或者添加 <task:annotation-driven>
元素,如下例所示
-
Java
-
Kotlin
-
Xml
@Configuration
@EnableAsync
@EnableScheduling
public class SchedulingConfiguration {
}
@Configuration
@EnableAsync
@EnableScheduling
class SchedulingConfiguration
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:task="http://www.springframework.org/schema/task"
xsi:schemaLocation="http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/task
https://www.springframework.org/schema/task/spring-task.xsd">
<task:annotation-driven executor="myExecutor" scheduler="myScheduler"/>
<task:executor id="myExecutor" pool-size="5"/>
<task:scheduler id="myScheduler" pool-size="10"/>
</beans>
您可以为您的应用程序选择相关的注解。例如,如果您只需要 @Scheduled
支持,您可以省略 @EnableAsync
。为了进行更精细的控制,您还可以实现 SchedulingConfigurer
接口、AsyncConfigurer
接口,或两者都实现。有关详细信息,请参阅 SchedulingConfigurer
和 AsyncConfigurer
的 javadoc。
请注意,对于前面的 XML,为处理带有 @Async
注解的方法对应的任务提供了 executor 引用,并为管理带有 @Scheduled
注解的方法提供了 scheduler 引用。
处理 @Async 注解的默认通知模式是 proxy ,它只允许通过代理拦截调用。同一类中的本地调用无法通过这种方式拦截。对于更高级的拦截模式,请考虑结合编译时或加载时织入切换到 aspectj 模式。 |
@Scheduled
注解
您可以将 @Scheduled
注解添加到方法中,并附带触发器元数据。例如,以下方法以固定延迟每五秒钟(5000 毫秒)调用一次,这意味着周期是从前一次调用的完成时间开始计算的。
@Scheduled(fixedDelay = 5000)
public void doSomething() {
// something that should run periodically
}
默认情况下,毫秒将用作固定延迟(fixed delay)、固定速率(fixed rate)和初始延迟(initial delay)值的时间单位。如果您想使用不同的时间单位,例如秒或分钟,可以通过 例如,前面的例子也可以写成如下形式。
|
如果您需要固定速率的执行,可以使用注解中的 fixedRate
属性。以下方法每五秒钟调用一次(测量的是每次调用开始时间之间的间隔)。
@Scheduled(fixedRate = 5, timeUnit = TimeUnit.SECONDS)
public void doSomething() {
// something that should run periodically
}
对于固定延迟和固定速率任务,您可以通过指定在第一次执行方法之前需要等待的时间量来设置初始延迟,如下面的 fixedRate
示例所示。
@Scheduled(initialDelay = 1000, fixedRate = 5000)
public void doSomething() {
// something that should run periodically
}
对于一次性任务,您只需通过指定在方法预期执行之前需要等待的时间量来设置初始延迟。
@Scheduled(initialDelay = 1000)
public void doSomething() {
// something that should run only once
}
如果简单的周期性调度表达能力不够,您可以提供一个 cron 表达式。以下示例仅在工作日运行。
@Scheduled(cron="*/5 * * * * MON-FRI")
public void doSomething() {
// something that should run on weekdays only
}
您还可以使用 zone 属性指定解析 cron 表达式的时区。 |
请注意,要调度的方法必须返回 void 并且不能接受任何参数。如果方法需要与应用程序上下文中的其他对象交互,通常应通过依赖注入提供这些对象。
@Scheduled
可以用作可重复注解。如果在同一方法上找到多个调度声明,它们将独立处理,每个声明都会触发一个单独的触发器。因此,这些共存的调度可能会重叠并并行或立即连续执行多次。请确保您指定的 cron 表达式等不会意外重叠。
从 Spring Framework 4.3 开始,任何作用域的 bean 都支持 请确保在运行时不会初始化同一 |
Reactive 方法或 Kotlin suspending 函数上的 @Scheduled
注解
从 Spring Framework 6.1 开始,@Scheduled
方法也支持几种类型的 reactive 方法:
-
返回类型为
Publisher
(或Publisher
的任何具体实现)的方法,例如以下示例所示:
@Scheduled(fixedDelay = 500)
public Publisher<Void> reactiveSomething() {
// return an instance of Publisher
}
-
可以通过共享的
ReactiveAdapterRegistry
实例适配到Publisher
的返回类型方法,前提是该类型支持延迟订阅,例如以下示例所示:
@Scheduled(fixedDelay = 500)
public Single<String> rxjavaNonPublisher() {
return Single.just("example");
}
|
-
Kotlin suspending 函数,例如以下示例所示:
@Scheduled(fixedDelay = 500)
suspend fun something() {
// do something asynchronous
}
-
返回 Kotlin
Flow
或Deferred
实例的方法,例如以下示例所示:
@Scheduled(fixedDelay = 500)
fun something(): Flow<Void> {
flow {
// do something asynchronous
}
}
所有这些类型的方法都必须声明时没有参数。对于 Kotlin suspending 函数,还必须存在 kotlinx.coroutines.reactor
桥接器,以允许框架将 suspending 函数作为 Publisher
调用。
Spring Framework 将为带有注解的方法获取一个 Publisher
,然后调度一个 Runnable
,在该 Runnable
中它订阅该 Publisher
。这些内部的常规订阅根据相应的 cron
/fixedDelay
/fixedRate
配置发生。
如果 Publisher
发出 onNext
信号,这些信号将被忽略和丢弃(就像同步 @Scheduled
方法的返回值被忽略一样)。
在下面的示例中,Flux
每 5 秒发出 onNext("Hello")
, onNext("World")
,但这些值未使用。
@Scheduled(initialDelay = 5000, fixedRate = 5000)
public Flux<String> reactiveSomething() {
return Flux.just("Hello", "World");
}
如果 Publisher
发出 onError
信号,它将被记录在 WARN
级别并恢复。由于 Publisher
实例的异步和延迟特性,异常不会从 Runnable
任务中抛出:这意味着 ErrorHandler
契约不适用于 reactive 方法。
因此,尽管发生错误,后续的调度订阅仍然会发生。
在下面的示例中,Mono
订阅在前五秒内失败了两次。然后订阅开始成功,每五秒向标准输出打印一条消息。
@Scheduled(initialDelay = 0, fixedRate = 5000)
public Mono<Void> reactiveSomething() {
AtomicInteger countdown = new AtomicInteger(2);
return Mono.defer(() -> {
if (countDown.get() == 0 || countDown.decrementAndGet() == 0) {
return Mono.fromRunnable(() -> System.out.println("Message"));
}
return Mono.error(new IllegalStateException("Cannot deliver message"));
})
}
销毁带注解的 bean 或关闭应用程序上下文时,Spring Framework 会取消计划的任务,这包括下次对 |
@Async
注解
您可以在方法上提供 @Async
注解,以便该方法的调用异步发生。换句话说,调用者在调用后立即返回,而方法的实际执行发生在已提交给 Spring TaskExecutor
的任务中。在最简单的情况下,您可以将该注解应用于返回 void
的方法,如下面的示例所示。
@Async
void doSomething() {
// this will be run asynchronously
}
与使用 @Scheduled
注解标记的方法不同,这些方法可以接受参数,因为它们是由调用者在运行时以“正常”方式调用的,而不是由容器管理的计划任务调用的。例如,下面的代码是 @Async
注解的合法应用:
@Async
void doSomething(String s) {
// this will be run asynchronously
}
即使返回值的方法也可以异步调用。但是,此类方法需要具有 Future
类型的返回值。这仍然提供了异步执行的好处,以便调用者可以在调用该 Future
的 get()
之前执行其他任务。以下示例显示了如何在返回值的方法上使用 @Async
:
@Async
Future<String> returnSomething(int i) {
// this will be run asynchronously
}
@Async 方法不仅可以声明常规的 java.util.concurrent.Future 返回类型,还可以声明 Spring 的 org.springframework.util.concurrent.ListenableFuture ,或者从 Spring 4.2 开始,JDK 8 的 java.util.concurrent.CompletableFuture ,以便与异步任务进行更丰富的交互,并与后续的处理步骤立即组合。 |
您不能将 @Async
与生命周期回调一起使用,例如 @PostConstruct
。目前,要异步初始化 Spring bean,您必须使用一个单独的初始化 Spring bean,该 bean 然后在目标对象上调用带有 @Async
注解的方法,如下面的示例所示:
public class SampleBeanImpl implements SampleBean {
@Async
void doSomething() {
// ...
}
}
public class SampleBeanInitializer {
private final SampleBean bean;
public SampleBeanInitializer(SampleBean bean) {
this.bean = bean;
}
@PostConstruct
public void initialize() {
bean.doSomething();
}
}
@Async 没有直接的 XML 等效项,因为此类方法首先应该设计为异步执行,而不是外部重新声明为异步。但是,您可以手动通过 Spring AOP 结合自定义切入点设置 Spring 的 AsyncExecutionInterceptor 。 |
使用 @Async
进行执行器限定
默认情况下,在方法上指定 @Async
时,使用的执行器是 启用异步支持时配置的执行器,即如果使用 XML 则是“annotation-driven”元素,或者如果存在,则是您的 AsyncConfigurer
实现。但是,当您需要指定执行给定方法时应使用默认执行器以外的其他执行器时,您可以使用 @Async
注解的 value
属性。以下示例显示了如何执行此操作:
@Async("otherExecutor")
void doSomething(String s) {
// this will be run asynchronously by "otherExecutor"
}
在这种情况下,"otherExecutor"
可以是 Spring 容器中任何 Executor
bean 的名称,也可以是与任何 Executor
关联的限定符的名称(例如,使用 <qualifier>
元素或 Spring 的 @Qualifier
注解指定)。
使用 @Async
进行异常管理
当 @Async
方法具有 Future
类型的返回值时,管理方法执行期间抛出的异常很容易,因为在调用 Future
结果的 get
方法时会抛出此异常。但是,对于 void
返回类型,异常未被捕获且无法传递。您可以提供一个 AsyncUncaughtExceptionHandler
来处理此类异常。以下示例显示了如何执行此操作:
public class MyAsyncUncaughtExceptionHandler implements AsyncUncaughtExceptionHandler {
@Override
public void handleUncaughtException(Throwable ex, Method method, Object... params) {
// handle exception
}
}
默认情况下,异常仅被记录。您可以通过使用 AsyncConfigurer
或 <task:annotation-driven/>
XML 元素定义自定义的 AsyncUncaughtExceptionHandler
。
task
命名空间
从版本 3.0 开始,Spring 包含一个 XML 命名空间,用于配置 TaskExecutor
和 TaskScheduler
实例。它还提供了一种便捷的方式来配置需要使用触发器进行调度的任务。
scheduler
元素
以下元素创建了一个具有指定线程池大小的 ThreadPoolTaskScheduler
实例:
<task:scheduler id="scheduler" pool-size="10"/>
id
属性提供的值用作池中线程名称的前缀。scheduler
元素相对简单。如果您不提供 pool-size
属性,则默认线程池只有一个线程。调度器没有其他配置选项。
executor
元素
以下创建了一个 ThreadPoolTaskExecutor
实例:
<task:executor id="executor" pool-size="10"/>
与 上一节 中所示的调度器一样,为 id
属性提供的值用作池中线程名称的前缀。关于池大小,executor
元素比 scheduler
元素支持更多的配置选项。首先,ThreadPoolTaskExecutor
的线程池本身更具可配置性。执行器的线程池可以为核心大小和最大大小设置不同的值,而不仅仅是单一大小。如果您提供一个单一值,则执行器具有固定大小的线程池(核心大小和最大大小相同)。但是,executor
元素的 pool-size
属性也接受 min-max
形式的范围。以下示例将最小值为 5
,最大值为 25
:
<task:executor
id="executorWithPoolSizeRange"
pool-size="5-25"
queue-capacity="100"/>
在前面的配置中,还提供了 queue-capacity
值。在考虑执行器的队列容量时,也应考虑线程池的配置。有关池大小和队列容量之间关系的完整说明,请参阅 ThreadPoolExecutor
的文档。主要思想是,当提交任务时,如果当前活动线程数小于核心大小,执行器首先尝试使用空闲线程。如果已达到核心大小,只要队列容量未满,任务就会被添加到队列中。只有当队列容量已满时,执行器才会创建超出核心大小的新线程。如果也已达到最大大小,则执行器将拒绝任务。
默认情况下,队列是无界的,但这很少是期望的配置,因为它可能导致 OutOfMemoryError
,如果所有池线程都忙时向队列中添加足够多的任务。此外,如果队列是无界的,最大大小完全没有效果。由于执行器在创建超出核心大小的新线程之前总是先尝试队列,因此队列必须具有有限容量,线程池才能增长到超出核心大小(这就是为什么使用无界队列时,固定大小池是唯一合理的情况)。
考虑上面提到的任务被拒绝的情况。默认情况下,当任务被拒绝时,线程池执行器会抛出 TaskRejectedException
。但是,拒绝策略实际上是可配置的。当使用默认拒绝策略(即 AbortPolicy
实现)时会抛出异常。对于在高负载下可以跳过某些任务的应用程序,您可以配置 DiscardPolicy
或 DiscardOldestPolicy
。另一个在高负载下需要限制提交任务数量的应用程序的良好选项是 CallerRunsPolicy
。该策略不是抛出异常或丢弃任务,而是强制调用提交方法的线程自己运行任务。其思想是,此类调用者在运行该任务时很忙,无法立即提交其他任务。因此,它提供了一种简单的方式来限制传入负载,同时保持线程池和队列的限制。通常,这使得执行器能够“赶上”正在处理的任务,从而释放队列、池或两者的部分容量。您可以从 executor
元素的 rejection-policy
属性可用的枚举值中选择任何一个选项。
以下示例显示了一个 executor
元素,其中包含许多属性来指定各种行为:
<task:executor
id="executorWithCallerRunsPolicy"
pool-size="5-25"
queue-capacity="100"
rejection-policy="CALLER_RUNS"/>
最后,keep-alive
设置确定线程在停止之前可以保持空闲的时间限制(以秒为单位)。如果池中当前线程数大于核心数,在等待此时间量而没有处理任务后,多余的线程将被停止。时间值为零会导致多余的线程在执行任务后立即停止,而队列中没有后续工作。以下示例将 keep-alive
值设置为两分钟:
<task:executor
id="executorWithKeepAlive"
pool-size="5-25"
keep-alive="120"/>
scheduled-tasks
元素
Spring 任务命名空间最强大的特性是支持在 Spring Application Context 中配置计划任务。这遵循了 Spring 中其他“方法调用者”类似的方法,例如 JMS 命名空间为配置消息驱动 POJO 提供的方法。基本上,ref
属性可以指向任何 Spring 管理的对象,而 method
属性提供在该对象上调用的方法的名称。以下列表显示了一个简单示例:
<task:scheduled-tasks scheduler="myScheduler">
<task:scheduled ref="beanA" method="methodA" fixed-delay="5000"/>
</task:scheduled-tasks>
<task:scheduler id="myScheduler" pool-size="10"/>
调度器由外部元素引用,每个单独的任务包含其触发器元数据的配置。在前面的示例中,该元数据定义了一个周期性触发器,其固定延迟指示每次任务执行完成后的等待毫秒数。另一个选项是 fixed-rate
,指示无论任何先前执行需要多长时间,该方法应多久运行一次。此外,对于 fixed-delay
和 fixed-rate
任务,您可以指定 'initial-delay' 参数,指示在方法首次执行之前需要等待的毫秒数。为了获得更多控制,您可以提供一个 cron
属性来提供一个 cron 表达式。以下示例显示了这些其他选项:
<task:scheduled-tasks scheduler="myScheduler">
<task:scheduled ref="beanA" method="methodA" fixed-delay="5000" initial-delay="1000"/>
<task:scheduled ref="beanB" method="methodB" fixed-rate="5000"/>
<task:scheduled ref="beanC" method="methodC" cron="*/5 * * * * MON-FRI"/>
</task:scheduled-tasks>
<task:scheduler id="myScheduler" pool-size="10"/>
Cron 表达式
所有 Spring cron 表达式都必须符合相同的格式,无论您是在 @Scheduled
注解、task:scheduled-tasks
元素 还是其他地方使用它们。一个格式良好的 cron 表达式,例如 * * * * * *
,由六个空格分隔的时间和日期字段组成,每个字段都有自己的有效值范围:
┌───────────── second (0-59) │ ┌───────────── minute (0 - 59) │ │ ┌───────────── hour (0 - 23) │ │ │ ┌───────────── day of the month (1 - 31) │ │ │ │ ┌───────────── month (1 - 12) (or JAN-DEC) │ │ │ │ │ ┌───────────── day of the week (0 - 7) │ │ │ │ │ │ (0 or 7 is Sunday, or MON-SUN) │ │ │ │ │ │ * * * * * *
有一些规则适用:
-
字段可以是星号(
*
),它始终代表“从头到尾”。对于月中某天或周中某天字段,可以使用问号(?
)代替星号。 -
逗号(
,
)用于分隔列表项。 -
由连字符(
-
)分隔的两个数字表示一个数字范围。指定的范围包含边界值。 -
范围(或
*
)后面跟着/
指定该数字值在范围内的间隔。 -
也可以使用英文名称表示月份和周中某天字段。使用特定天或月份的前三个字母(不区分大小写)。
-
月中某天和周中某天字段可以包含
L
字符,它具有不同的含义。-
在月中某天字段中,
L
表示该月的最后一天。如果后跟负偏移量(即L-n
),则表示该月倒数第n
天。 -
在周中某天字段中,
L
表示该月的最后一天。如果前缀为数字或三个字母的名称(dL
或DDDL
),则表示该月第d
天(或DDD
)的最后一天。
-
-
月中某天字段可以是
nW
,表示离该月第n
天最近的工作日。如果n
是星期六,则表示前一个星期五。如果n
是星期日,则表示后一个星期一;如果n
是1
且是星期六(即1W
表示该月的第一个工作日),也同样如此。 -
如果月中某天字段是
LW
,则表示该月的最后一个工作日。 -
周中某天字段可以是
d#n
(或DDD#n
),表示该月第d
天(或DDD
)的第n
次出现。
以下是一些示例:
Cron 表达式 | 含义 |
---|---|
|
每天每小时的顶部 |
|
每十秒钟 |
|
每天的 8、9 和 10 点 |
|
每天的上午 6:00 和下午 7:00 |
|
每天的 8:00、8:30、9:00、9:30、10:00 和 10:30 |
|
工作日九点到五点每小时的顶部 |
|
每年圣诞节午夜 |
|
每月最后一天午夜 |
|
每月倒数第三天午夜 |
|
每月最后一个星期五午夜 |
|
每月最后一个星期四午夜 |
|
每月第一个工作日午夜 |
|
每月最后一个工作日午夜 |
|
每月第二个星期五午夜 |
|
每月第一个星期一午夜 |
宏(Macros)
像 0 0 * * * *
这样的表达式对人类来说很难解析,因此也难以修复 bug。为了提高可读性,Spring 支持以下宏,它们代表常用序列。您可以使用这些宏代替六位数字值,例如:@Scheduled(cron = "@hourly")
。
宏 | 含义 |
---|---|
|
每年一次 ( |
|
每月一次 ( |
|
每周一次 ( |
|
每天一次 ( |
|
每小时一次, ( |
使用 Quartz 调度器
Quartz 使用 Trigger
、Job
和 JobDetail
对象来实现各种作业的调度。有关 Quartz 的基本概念,请参阅 Quartz 网站。为了方便起见,Spring 提供了一些类,简化了在基于 Spring 的应用程序中使用 Quartz 的过程。
使用 JobDetailFactoryBean
Quartz JobDetail
对象包含运行作业所需的所有信息。Spring 提供了一个 JobDetailFactoryBean
,它提供 bean 样式属性用于 XML 配置。考虑以下示例:
<bean name="exampleJob" class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
<property name="jobClass" value="example.ExampleJob"/>
<property name="jobDataAsMap">
<map>
<entry key="timeout" value="5"/>
</map>
</property>
</bean>
作业详情配置包含了运行作业(ExampleJob
)所需的所有信息。超时时间在作业数据映射中指定。作业数据映射可以通过 JobExecutionContext
(在执行时传递给您)获得,但 JobDetail
也从映射到作业实例属性的作业数据中获取其属性。因此,在以下示例中,ExampleJob
包含一个名为 timeout
的 bean 属性,并且 JobDetail
会自动应用它。
package example;
public class ExampleJob extends QuartzJobBean {
private int timeout;
/**
* Setter called after the ExampleJob is instantiated
* with the value from the JobDetailFactoryBean.
*/
public void setTimeout(int timeout) {
this.timeout = timeout;
}
protected void executeInternal(JobExecutionContext ctx) throws JobExecutionException {
// do the actual work
}
}
作业数据映射中的所有附加属性也都可以供您使用。
通过使用 name 和 group 属性,您可以分别修改作业的名称和组。默认情况下,作业的名称与 JobDetailFactoryBean 的 bean 名称(在上面的示例中为 exampleJob )匹配。 |
使用 MethodInvokingJobDetailFactoryBean
通常您只需要调用特定对象上的一个方法。通过使用 MethodInvokingJobDetailFactoryBean
,您可以完全做到这一点,如下面的示例所示。
<bean id="jobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
<property name="targetObject" ref="exampleBusinessObject"/>
<property name="targetMethod" value="doIt"/>
</bean>
前面的示例导致在 exampleBusinessObject
方法上调用 doIt
方法,如下面的示例所示。
public class ExampleBusinessObject {
// properties and collaborators
public void doIt() {
// do the actual work
}
}
<bean id="exampleBusinessObject" class="examples.ExampleBusinessObject"/>
通过使用 MethodInvokingJobDetailFactoryBean
,您无需创建仅调用方法的单行作业。您只需创建实际的业务对象并连接详情对象即可。
默认情况下,Quartz 作业是无状态的,这可能导致作业之间相互干扰。如果您为同一个 JobDetail
指定两个触发器,第二个触发器可能在第一个作业完成之前启动。如果 JobDetail
类实现 Stateful
接口,这种情况就不会发生:第二个作业在第一个作业完成之前不会启动。
要使 MethodInvokingJobDetailFactoryBean
产生的作业成为非并发的,请将 concurrent
标志设置为 false
,如下面的示例所示。
<bean id="jobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
<property name="targetObject" ref="exampleBusinessObject"/>
<property name="targetMethod" value="doIt"/>
<property name="concurrent" value="false"/>
</bean>
默认情况下,作业将以并发方式运行。 |
使用触发器和 SchedulerFactoryBean
连接作业
我们已经创建了作业详情和作业。我们也回顾了允许您在特定对象上调用方法的便捷 bean。当然,我们仍然需要调度作业本身。这是通过使用触发器和 SchedulerFactoryBean
来完成的。Quartz 中有几种触发器可用,Spring 提供了两个具有便捷默认设置的 Quartz FactoryBean
实现:CronTriggerFactoryBean
和 SimpleTriggerFactoryBean
。
触发器需要被调度。Spring 提供了一个 SchedulerFactoryBean
,它将触发器暴露为属性进行设置。SchedulerFactoryBean
使用这些触发器调度实际的作业。
以下列表同时使用了 SimpleTriggerFactoryBean
和 CronTriggerFactoryBean
。
<bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">
<!-- see the example of method invoking job above -->
<property name="jobDetail" ref="jobDetail"/>
<!-- 10 seconds -->
<property name="startDelay" value="10000"/>
<!-- repeat every 50 seconds -->
<property name="repeatInterval" value="50000"/>
</bean>
<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
<property name="jobDetail" ref="exampleJob"/>
<!-- run every morning at 6 AM -->
<property name="cronExpression" value="0 0 6 * * ?"/>
</bean>
前面的示例设置了两个触发器,一个每隔 50 秒运行一次,启动延迟为 10 秒,另一个每天早上 6 点运行。最后,我们需要设置 SchedulerFactoryBean
,如下面的示例所示。
<bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
<property name="triggers">
<list>
<ref bean="cronTrigger"/>
<ref bean="simpleTrigger"/>
</list>
</property>
</bean>
SchedulerFactoryBean
还有更多属性可用,例如作业详情使用的日历、用于自定义 Quartz 的属性以及 Spring 提供的 JDBC DataSource。有关更多信息,请参阅 SchedulerFactoryBean
的 javadoc 文档。
SchedulerFactoryBean 也识别类路径中的 quartz.properties 文件,基于 Quartz 属性键,与常规 Quartz 配置一样。请注意,许多 SchedulerFactoryBean 设置与 properties 文件中的常见 Quartz 设置交互;因此,不建议在两个级别都指定值。例如,如果您打算依赖 Spring 提供的 DataSource,请不要设置 "org.quartz.jobStore.class" 属性,或者指定一个 org.springframework.scheduling.quartz.LocalDataSourceJobStore 变体,它是标准 org.quartz.impl.jdbcjobstore.JobStoreTX 的完全替代品。 |