ARTS Review8 Spring官方文档和API 定时任务

Love The Way You Lie 2022-02-02 13:47 159阅读 0赞

`Spring Framework`使用`TaskExecutor`和`TaskScheduler`接口为异步执行和任务调度提供抽象，同时 `Spring`还具有支持线程池或在应用程序服务器环境中委托给`CommonJ`的接口的实现。最终，在公共接口背后使用这些实现抽象出了`Java SE 5`，`Java SE 6`和`Java EE`环境之间的差异。

`Spring`还具有集成类，支持使用`Timer`（JDK自1.3以来的一部分）和`Quartz Scheduler`（https://www.quartz-scheduler.org/）进行调度。 您可以使用`FactoryBean`同时分别对`Timer`或`Trigger`实例进行可选引用来设置这两个调度程序。 此外，还提供了`Quartz Scheduler`和`Timer`的便捷类，它允许您调用现有目标对象的方法（类似于正常的`MethodInvokingFactoryBean`操作）。

1.  `TaskExecutor`接口

（1）该接口位于`org.springframework.core.task`包下；  
（2）该接口继承自`Executor`接口，`Executor`接口位于`java.util.concurrent`包下；  
（3）它的子接口有：`AsyncListenableTaskExecutor, AsyncTaskExecutor, SchedulingTaskExecutor`  
（4）实现该接口的类有：`ConcurrentTaskExecutor, ConcurrentTaskScheduler, DefaultManagedTaskExecutor, DefaultManagedTaskScheduler, SimpleAsyncTaskExecutor, SimpleThreadPoolTaskExecutor, SyncTaskExecutor, TaskExecutorAdapter, ThreadPoolTaskExecutor, ThreadPoolTaskScheduler, WorkManagerTaskExecutor, WorkManagerTaskExecutor`  
（5）该接口是一个函数式接口，因此可以用作`lambda`表达式或者方法引用的赋值目标。  
（6）该接口中只存在一个抽象方法，且无返回值，方法名叫`execute`，具体见下面的代码：

package org.springframework.core.task;
    
    import java.util.concurrent.Executor;
    
    //标识该接口是一个抽象接口，且是一个函数式接口
    @FunctionalInterface
    public abstract interface TaskExecutor
      extends Executor
    {
      //该方法只有一个参数，是一个Runnable类型
      //该方法用来执行指定的任务
      //如果实现用了一种异步的执行策略或者在同步执行的情况下阻塞，此时就会立即返回。
      //如果指定的任务不被接受，那么就会抛出TaskRejectedException异常。
      public abstract void execute(Runnable paramRunnable);
    }

（7）简单的任务执行器接口，用于抽象`Runnable`的执行  
（8）实现可以使用各种不同的执行策略，例如：同步，异步，使用线程池等  
（9）相当于`JDK 1.5`的`Executor`接口; 现在在`Spring 3.0`中扩展它，以便客户端可以声明对`Executor`的依赖并接收任何`TaskExecutor`实现。 此接口与标准`Executor`接口保持独立，主要是为了向后兼容`Spring 2.x`中的`JDK 1.4`。

注明：这部分中的代码参考`Spring-core 5.1.7.jar`。

2.`TaskSchedule`接口

（1）该接口位于`spring-context.jar`中的`org.springframework.scheduling`包下  
（2）所有实现了该接口的类有：`ConcurrentTaskScheduler, DefaultManagedTaskScheduler, ThreadPoolTaskScheduler, TimerManagerTaskScheduler`  
（3）任务调度程序接口，它根据不同类型的触发器抽象Runnables的调度。  
（4）该接口与`SchedulingTaskExecutor`有所不同，因为它通常代表一种不同类型的后端，比如，一个具有不同属性和性能的线程池。如果它可以处理两种属性性能，那么实现是可以实现这两种接口的。  
（5）默认的实现是`ThreadPoolTaskScheduler`,包装了一个本地的`ScheduledExecutorService`，并且添加扩展触发功能。  
（6）此接口大致相当于`Java EE 7`环境中支持的`JSR-236` `ManagedScheduledExecutorService`，但与`Spring`的`TaskExecutor`模型一致

该接口中的方法定义如下所示

@Nullable
    public abstract ScheduledFuture<?> schedule(Runnable paramRunnable, Trigger paramTrigger);

<1>调度给定的Runnable，每当触发器指示下一个执行时间时调用它。  
<2>当定时关闭或者返回的`ScheduledFuture`被取消的时候，定时执行就会结束。  
<3>`Runnable`参数标识当触发开启的时候就会去执行这个任务；`Trigger`表示一个实现`Trigger`接口的实现，比如，一个`CronTrigger`对象包裹一个`cron`表达式。  
<4>返回值:表示任务挂起完成的`ScheduledFuture`，如果给定的`Trigger`对象永远不会触发，则返回`null`（即从`Trigger.nextExecutionTime`（`org.springframework.scheduling.TriggerContext`）返回`null`）  
<5>如果指定的任务不被接受，则会抛出`TaskRejectedException`异常。

public ScheduledFuture<?> schedule(Runnable task, Instant startTime)
    {
    	return schedule(task, Date.from(startTime));
    }

<1>调度给定的Runnable，每当触发器指示下一个执行时间时调用它。  
<2>当定时关闭或者返回的`ScheduledFuture`被取消的时候，定时执行就会结束。  
<3>参数`Runnable`参数标识当触发开启的时候就会去执行这个任务；`startTime`含义是：任务所需的执行时间（如果是在过去，则任务将立即执行，即尽快执行），其中该参数类型是一个`Instant`类型  
<4>返回值是一个`ScheduledFuture`类型，表示任务有待完成。  
<5>如果指定的任务不被接受，则会抛出`TaskRejectedException`异常。

public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Instant startTime, Duration period)
    {
    	return scheduleAtFixedRate(task, Date.from(startTime), period.toMillis());
    }

<1>调度给定的Runnable，每当触发器指示下一个执行时间时调用它。  
<2>当定时关闭或者返回的`ScheduledFuture`被取消的时候，定时执行就会结束。  
<3>参数`task`参数标识当触发开启的时候就会去执行这个任务；`period`表示连续执行任务之间的间隔。  
<4>返回值是一个`ScheduledFuture`类型，表示任务有待完成。  
<5>如果指定的任务不被接受，则会抛出`TaskRejectedException`异常。

public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Duration period)
    {
    	return scheduleAtFixedRate(task, period.toMillis());
    }

ScheduledFuture<?> scheduleAtFixedRate(Runnable task,long period)

<1>调度给定的Runnable，每当触发器指示下一个执行时间时调用它。  
<2>当定时关闭或者返回的`ScheduledFuture`被取消的时候，定时执行就会结束。  
<3>参数`task`参数标识当触发开启的时候就会去执行这个任务；`period`表示连续执行任务之间的间隔（毫秒级别）。  
<4>返回值是一个`ScheduledFuture`类型，表示任务有待完成。  
<5>如果指定的任务不被接受，则会抛出`TaskRejectedException`异常。

default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task,Instant startTime,Duration delay)

<1>调度给定的Runnable，在指定的执行时间调用它，然后在一次执行完成和下一次执行开始之间给定延迟。  
<2>当定时关闭或者返回的`ScheduledFuture`被取消的时候，定时执行就会结束。  
<3>参数`task`参数标识当触发开启的时候就会去执行这个任务；`startTime`含义是：任务所需的执行时间（如果是在过去，则任务将立即执行，即尽快执行);`delay`表示完成的任务和下次即将开始的任务之间的延时。  
<4>返回值是一个`ScheduledFuture`类型，表示任务有待完成。  
<5>如果指定的任务不被接受，则会抛出`TaskRejectedException`异常。

default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task,Instant startTime,long delay)

<1>调度给定的Runnable，在指定的执行时间调用它，然后在一次执行完成和下一次执行开始之间给定延迟。  
<2>当定时关闭或者返回的`ScheduledFuture`被取消的时候，定时执行就会结束。  
<3>参数`task`参数标识当触发开启的时候就会去执行这个任务；`startTime`含义是：任务所需的执行时间（如果是在过去，则任务将立即执行，即尽快执行);`delay`表示完成的任务和下次即将开始的任务之间的延时(毫秒级别)。  
<4>返回值是一个`ScheduledFuture`类型，表示任务有待完成。  
<5>如果指定的任务不被接受，则会抛出`TaskRejectedException`异常。

default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task,Duration delay)

<1>调度给定的Runnable，在指定的执行时间调用它，然后在一次执行完成和下一次执行开始之间给定延迟。  
<2>当定时关闭或者返回的`ScheduledFuture`被取消的时候，定时执行就会结束。  
<3>参数`task`参数标识当触发开启的时候就会去执行这个任务；`delay`表示完成的任务和下次即将开始的任务之间的延时。  
<4>返回值是一个`ScheduledFuture`类型，表示任务有待完成。  
<5>如果指定的任务不被接受，则会抛出`TaskRejectedException`异常。

default ScheduledFuture<?> scheduleWithFixedDelay(Runnable task,long delay)

<1>调度给定的Runnable，在指定的执行时间调用它，然后在一次执行完成和下一次执行开始之间给定延迟。  
<2>当定时关闭或者返回的`ScheduledFuture`被取消的时候，定时执行就会结束。  
<3>参数`task`参数标识当触发开启的时候就会去执行这个任务；`delay`表示完成的任务和下次即将开始的任务之间的延时(毫秒级别)。  
<4>返回值是一个`ScheduledFuture`类型，表示任务有待完成。  
<5>如果指定的任务不被接受，则会抛出`TaskRejectedException`异常。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5MzQzMjU_size_16_color_FFFFFF_t_70]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5MzQzMjU_size_16_color_FFFFFF_t_70]: /images/20220202/db6f8ec723c24dd993d171f9be78ac65.png