--- title: 深入剖析Java计划任务ScheduledThreadPoolExecutor category: - Java核心 - 并发编程 tag: - Java --- 自JDK 1.5 开始，JDK提供了`ScheduledThreadPoolExecutor`类用于计划任务（又称定时任务），这个类有两个用途： * 在给定的延迟之后运行任务 * 周期性重复执行任务在这之前，是使用`Timer`类来完成定时任务的，但是`Timer`有缺陷： * Timer是**单线程**模式； * 如果在执行任务期间某个TimerTask耗时较久，那么就会影响其它任务的调度； * Timer的任务调度是基于绝对时间的，对**系统时间**敏感； * Timer不会捕获执行TimerTask时所抛出的**异常**，由于Timer是单线程，所以一旦出现异常，则线程就会终止，其他任务也得不到执行。所以JDK 1.5之后，大家就摒弃`Timer`,使用`ScheduledThreadPoolExecutor`吧。 ## 使用案例假设我有一个需求，指定时间给大家发送消息。那么我们会将消息（包含发送时间）存储在数据库中，然后想用一个定时任务，每隔1秒检查数据库在当前时间有没有需要发送的消息，那这个计划任务怎么写？下面是一个Demo: ```java public class ThreadPool { private static final ScheduledExecutorService executor = new ScheduledThreadPoolExecutor(1, Executors.defaultThreadFactory()); private static SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); public static void main(String[] args){ // 新建一个固定延迟时间的计划任务 executor.scheduleWithFixedDelay(new Runnable() { @Override public void run() { if (haveMsgAtCurrentTime()) { System.out.println(df.format(new Date())); System.out.println("大家注意了，我要发消息了"); } } }, 1, 1, TimeUnit.SECONDS); } public static boolean haveMsgAtCurrentTime(){ //查询数据库，有没有当前时间需要发送的消息 //这里省略实现，直接返回true return true; } } ``` 下面截取前面的输出（这个demo会一直运行下去）： ```java 2019-01-23 16:16:48 大家注意了，我要发消息了 2019-01-23 16:16:49 大家注意了，我要发消息了 2019-01-23 16:16:50 大家注意了，我要发消息了 2019-01-23 16:16:51 大家注意了，我要发消息了 2019-01-23 16:16:52 大家注意了，我要发消息了 2019-01-23 16:16:53 大家注意了，我要发消息了 2019-01-23 16:16:54 大家注意了，我要发消息了 2019-01-23 16:16:55 大家注意了，我要发消息了 ``` 这就是`ScheduledThreadPoolExecutor`的一个简单运用，想要知道奥秘，接下来的东西需要仔细的看哦。 ## 类结构 ```java public class ScheduledThreadPoolExecutor extends ThreadPoolExecutor implements ScheduledExecutorService { public ScheduledThreadPoolExecutor(int corePoolSize,ThreadFactory threadFactory) { super(corePoolSize, Integer.MAX_VALUE, 0, NANOSECONDS, new DelayedWorkQueue(), threadFactory); } //…… } ``` `ScheduledThreadPoolExecutor`继承了`ThreadPoolExecutor`，实现了`ScheduledExecutorService`。线程池在之前的章节介绍过了，我们先看看`ScheduledExecutorService`。 ```java public interface ScheduledExecutorService extends ExecutorService { public ScheduledFuture schedule(Runnable command,long delay, TimeUnit unit); public ScheduledFuture schedule(Callable callable,long delay, TimeUnit unit); public ScheduledFuture scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit); public ScheduledFuture scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit); } ``` `ScheduledExecutorService`实现了`ExecutorService` ,并增加若干定时相关的接口。前两个方法用于单次调度执行任务，区别是有没有返回值。重点理解一下后面两个方法： * scheduleAtFixedRate 该方法在`initialDelay`时长后第一次执行任务，以后每隔`period`时长，再次执行任务。注意，period是从**任务开始执行算起**的。开始执行任务后，定时器每隔period时长**检查该任务是否完成**，如果完成则再次启动任务，否则等该任务结束后才再次启动任务。 * scheduleWithFixDelay 该方法在`initialDelay`时长后第一次执行任务，以后每当任务执行**完成后**，等待`delay`时长，再次执行任务。 ## 主要方法介绍 ### schedule ```java // delay时长后执行任务command，该任务只执行一次 public ScheduledFuture schedule(Runnable command, long delay, TimeUnit unit) { if (command == null || unit == null) throw new NullPointerException(); // 这里的decorateTask方法仅仅返回第二个参数 RunnableScheduledFuture t = decorateTask(command, new ScheduledFutureTask(command, null, triggerTime(delay,unit))); // 延时或者周期执行任务的主要方法,稍后统一说明 delayedExecute(t); return t; } ``` 我们先看看里面涉及到的几个类和接口`ScheduledFuture`、 `RunnableScheduledFuture`、 `ScheduledFutureTask`的关系： ![类图](http://cdn.tobebetterjavaer.com/tobebetterjavaer/images/thread/ScheduledThreadPoolExecutor-cd4cead8-2ce3-4460-8ea3-9534cd4925f2.jpg) 我们先看看这几个接口和类： #### Delayed接口 ```java // 继承Comparable接口，表示该类对象支持排序 public interface Delayed extends Comparable { // 返回该对象剩余时延 long getDelay(TimeUnit unit); } ``` `Delayed`接口很简单，继承了`Comparable`接口，表示对象是可以比较排序的。 #### ScheduledFuture接口 ```java // 仅仅继承了Delayed和Future接口，自己没有任何代码 public interface ScheduledFuture extends Delayed, Future { } ``` 没有添加其他方法。 #### RunnableScheduledFuture接口 ```java public interface RunnableScheduledFuture extends RunnableFuture, ScheduledFuture { // 是否是周期任务，周期任务可被调度运行多次，非周期任务只被运行一次 boolean isPeriodic(); } ``` #### ScheduledFutureTask类回到`schecule`方法中，它创建了一个`ScheduledFutureTask`的对象，由上面的关系图可知，`ScheduledFutureTask`直接或者间接实现了很多接口，一起看看`ScheduledFutureTask`里面的实现方法吧。 **构造方法** ```java ScheduledFutureTask(Runnable r, V result, long ns, long period) { // 调用父类FutureTask的构造方法 super(r, result); // time表示任务下次执行的时间 this.time = ns; // 周期任务，正数表示按照固定速率，负数表示按照固定时延,0表示不是周期任务 this.period = period; // 任务的编号 this.sequenceNumber = sequencer.getAndIncrement(); } ``` **Delayed接口的实现** ```java // 实现Delayed接口的getDelay方法，返回任务开始执行的剩余时间 public long getDelay(TimeUnit unit) { return unit.convert(time - now(), TimeUnit.NANOSECONDS); } ``` **Comparable接口的实现** ```java // Comparable接口的compareTo方法，比较两个任务的”大小”。 public int compareTo(Delayed other) { if (other == this) return 0; if (other instanceof ScheduledFutureTask) { ScheduledFutureTask x = (ScheduledFutureTask)other; long diff = time - x.time; // 小于0，说明当前任务的执行时间点早于other，要排在延时队列other的前面 if (diff < 0) return -1; // 大于0，说明当前任务的执行时间点晚于other，要排在延时队列other的后面 else if (diff > 0) return 1; // 如果两个任务的执行时间点一样，比较两个任务的编号，编号小的排在队列前面，编号大的排在队列后面 else if (sequenceNumber < x.sequenceNumber) return -1; else return 1; } // 如果任务类型不是ScheduledFutureTask，通过getDelay方法比较 long d = (getDelay(TimeUnit.NANOSECONDS) - other.getDelay(TimeUnit.NANOSECONDS)); return (d == 0) ? 0 : ((d < 0) ? -1 : 1); } ``` **setNextRunTime** ```java // 任务执行完后，设置下次执行的时间 private void setNextRunTime() { long p = period; // p > 0，说明是固定速率运行的任务 // 在原来任务开始执行时间的基础上加上p即可 if (p > 0) time += p; // p < 0，说明是固定时延运行的任务， // 下次执行时间在当前时间(任务执行完成的时间)的基础上加上-p的时间 else time = triggerTime(-p); } ``` **Runnable接口实现** ```java public void run() { boolean periodic = isPeriodic(); // 如果当前状态下不能执行任务，则取消任务 if (!canRunInCurrentRunState(periodic)) cancel(false); // 不是周期性任务，执行一次任务即可，调用父类的run方法 else if (!periodic) ScheduledFutureTask.super.run(); // 是周期性任务，调用FutureTask的runAndReset方法，方法执行完成后 // 重新设置任务下一次执行的时间，并将该任务重新入队，等待再次被调度 else if (ScheduledFutureTask.super.runAndReset()) { setNextRunTime(); reExecutePeriodic(outerTask); } } ``` 总结一下run方法的执行过程： 1. 如果当前线程池运行状态不可以执行任务，取消该任务，然后直接返回，否则执行步骤2； 2. 如果不是周期性任务，调用FutureTask中的run方法执行，会设置执行结果，然后直接返回，否则执行步骤3； 3. 如果是周期性任务，调用FutureTask中的runAndReset方法执行，不会设置执行结果，然后直接返回，否则执行步骤4和步骤5； 4. 计算下次执行该任务的具体时间； 5. 重复执行任务。 `runAndReset`方法是为任务多次执行而设计的。`runAndReset`方法执行完任务后不会设置任务的执行结果，也不会去更新任务的状态，维持任务的状态为初始状态（**NEW**状态），这也是该方法和`FutureTask`的`run`方法的区别。 ### scheduleAtFixedRate 我们看一下代码： ```java // 注意，固定速率和固定时延，传入的参数都是Runnable，也就是说这种定时任务是没有返回值的 public ScheduledFuture scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit) { if (command == null || unit == null) throw new NullPointerException(); if (period <= 0) throw new IllegalArgumentException(); // 创建一个有初始延时和固定周期的任务 ScheduledFutureTask sft = new ScheduledFutureTask(command, null, triggerTime(initialDelay, unit), unit.toNanos(period)); RunnableScheduledFuture t = decorateTask(command, sft); // outerTask表示将会重新入队的任务 sft.outerTask = t; // 稍后说明 delayedExecute(t); return t; } ``` `scheduleAtFixedRate`这个方法和`schedule`类似，不同点是`scheduleAtFixedRate`方法内部创建的是`ScheduledFutureTask`，带有初始延时和固定周期的任务。 ### scheduleWithFixedDelay `FixedDelay`也是通过`ScheduledFutureTask`体现的，唯一不同的地方在于创建的`ScheduledFutureTask`不同。这里不再展示源码。 ### delayedExecute 前面讲到的`schedule`、`scheduleAtFixedRate`和`scheduleWithFixedDelay`最后都调用了`delayedExecute`方法，该方法是定时任务执行的主要方法。一起来看看源码： ```java private void delayedExecute(RunnableScheduledFuture task) { // 线程池已经关闭，调用拒绝执行处理器处理 if (isShutdown()) reject(task); else { // 将任务加入到等待队列 super.getQueue().add(task); // 线程池已经关闭，且当前状态不能运行该任务，将该任务从等待队列移除并取消该任务 if (isShutdown() && !canRunInCurrentRunState(task.isPeriodic()) && remove(task)) task.cancel(false); else // 增加一个worker，就算corePoolSize=0也要增加一个worker ensurePrestart(); } } ``` `delayedExecute`方法的逻辑也很简单，主要就是将任务添加到等待队列，然后调用`ensurePrestart`方法。 ```java void ensurePrestart() { int wc = workerCountOf(ctl.get()); if (wc < corePoolSize) addWorker(null, true); else if (wc == 0) addWorker(null, false); } ``` `ensurePrestart`方法主要是调用了`addWorker`，线程池中的工作线程是通过该方法来启动并执行任务的。具体可以查看前面讲的线程池章节。对于`ScheduledThreadPoolExecutor`，`worker`添加到线程池后会在等待队列上等待获取任务，这点是和`ThreadPoolExecutor`一致的。**但是worker是怎么从等待队列取定时任务的？** 因为`ScheduledThreadPoolExecutor`使用了`DelayedWorkQueue`保存等待的任务，该等待队列队首应该保存的是最近将要执行的任务，如果队首任务的开始执行时间还未到，`worker`也应该继续等待。 ## DelayedWorkQueue `ScheduledThreadPoolExecutor`使用了`DelayedWorkQueue`保存等待的任务。该等待队列队首应该保存的是**最近将要执行的任务**，所以`worker`只关心队首任务即可，如果队首任务的开始执行时间还未到，worker也应该继续等待。 DelayedWorkQueue是一个无界优先队列，使用数组存储，底层是使用堆结构来实现优先队列的功能。我们先看看DelayedWorkQueue的声明和成员变量： ```java static class DelayedWorkQueue extends AbstractQueue implements BlockingQueue { // 队列初始容量 private static final int INITIAL_CAPACITY = 16; // 数组用来存储定时任务，通过数组实现堆排序 private RunnableScheduledFuture[] queue = new RunnableScheduledFuture[INITIAL_CAPACITY]; // 当前在队首等待的线程 private Thread leader = null; // 锁和监视器，用于leader线程 private final ReentrantLock lock = new ReentrantLock(); private final Condition available = lock.newCondition(); // 其他代码，略 } ``` 当一个线程成为leader，它只要等待队首任务的delay时间即可，其他线程会无条件等待。leader取到任务返回前要通知其他线程，直到有线程成为新的leader。每当队首的定时任务被其他更早需要执行的任务替换时，leader设置为null，其他等待的线程（被当前leader通知）和当前的leader重新竞争成为leader。同时，定义了锁lock和监视器available用于线程竞争成为leader。当一个新的任务成为队首，或者需要有新的线程成为leader时，available监视器上的线程将会被通知，然后竞争成为leader线程。有些类似于生产者-消费者模式。接下来看看`DelayedWorkQueue`中几个比较重要的方法 ### take ```java public RunnableScheduledFuture take() throws InterruptedException { final ReentrantLock lock = this.lock; lock.lockInterruptibly(); try { for (;;) { // 取堆顶的任务，堆顶是最近要执行的任务 RunnableScheduledFuture first = queue[0]; // 堆顶为空，线程要在条件available上等待 if (first == null) available.await(); else { // 堆顶任务还要多长时间才能执行 long delay = first.getDelay(TimeUnit.NANOSECONDS); // 堆顶任务已经可以执行了，finishPoll会重新调整堆，使其满足最小堆特性，该方法设置任务在 // 堆中的index为-1并返回该任务 if (delay <= 0) return finishPoll(first); // 如果leader不为空，说明已经有线程成为leader并等待堆顶任务 // 到达执行时间，此时，其他线程都需要在available条件上等待 else if (leader != null) available.await(); else { // leader为空，当前线程成为新的leader Thread thisThread = Thread.currentThread(); leader = thisThread; try { // 当前线程已经成为leader了，只需要等待堆顶任务到达执行时间即可 available.awaitNanos(delay); } finally { // 返回堆顶元素之前将leader设置为空 if (leader == thisThread) leader = null; } } } } } finally { // 通知其他在available条件等待的线程，这些线程可以去竞争成为新的leader if (leader == null && queue[0] != null) available.signal(); lock.unlock(); } } ``` `take`方法是什么时候调用的呢？在线程池的章节中，介绍了`getTask`方法，工作线程会循环地从`workQueue`中取任务。但计划任务却不同，因为如果一旦`getTask`方法取出了任务就开始执行了，而这时可能还没有到执行的时间，所以在`take`方法中，要保证只有在到指定的执行时间的时候任务才可以被取走。总结一下流程： 1. 如果堆顶元素为空，在available条件上等待。 2. 如果堆顶任务的执行时间已到，将堆顶元素替换为堆的最后一个元素并调整堆使其满足**最小堆**特性，同时设置任务在堆中索引为-1，返回该任务。 3. 如果leader不为空，说明已经有线程成为leader了，其他线程都要在available监视器上等待。 4. 如果leader为空，当前线程成为新的leader，并等待直到堆顶任务执行时间到达。 5. take方法返回之前，将leader设置为空，并通知其他线程。再来说一下leader的作用，这里的leader是**为了减少不必要的定时等待**，当一个线程成为leader时，它只等待下一个节点的时间间隔，但其它线程无限期等待。 leader线程必须在从`take()`或`poll()`返回之前signal其它线程，除非其他线程成为了leader。举例来说，如果没有leader，那么在执行take时，都要执行`available.awaitNanos(delay)`，假设当前线程执行了该段代码，这时还没有signal，第二个线程也执行了该段代码，则第二个线程也要被阻塞。但只有一个线程返回队首任务，其他的线程在`awaitNanos(delay)`之后，继续执行for循环，因为队首任务已经被返回了，所以这个时候的for循环拿到的队首任务是新的，又需要重新判断时间，又要继续阻塞。所以，为了不让多个线程频繁的做无用的定时等待，这里增加了leader，如果leader不为空，则说明队列中第一个节点已经在等待出队，这时其它的线程会一直阻塞，减少了无用的阻塞（注意，在`finally`中调用了`signal()`来唤醒一个线程，而不是`signalAll()`）。 ### offer 该方法往队列插入一个值，返回是否成功插入。 ```java public boolean offer(Runnable x) { if (x == null) throw new NullPointerException(); RunnableScheduledFuture e = (RunnableScheduledFuture)x; final ReentrantLock lock = this.lock; lock.lock(); try { int i = size; // 队列元素已经大于等于数组的长度，需要扩容，新堆的容量是原来堆容量的1.5倍 if (i >= queue.length) grow(); // 堆中元素增加1 size = i + 1; // 调整堆 if (i == 0) { queue[0] = e; setIndex(e, 0); } else { // 调整堆，使的满足最小堆，比较大小的方式就是上文提到的compareTo方法 siftUp(i, e); } if (queue[0] == e) { leader = null; // 通知其他在available条件上等待的线程，这些线程可以竞争成为新的leader available.signal(); } } finally { lock.unlock(); } return true; } ``` 在堆中插入了一个节点，这个时候堆有可能不满足最小堆的定义，`siftUp`用于将堆调整为最小堆，这属于数据结构的基本内容，本文不做介绍。 ## 总结内部使用优化的DelayQueue来实现，由于使用队列来实现定时器，有出入队调整堆等操作，所以定时并不是非常非常精确。 --- >编辑：沉默王二，内容大部分来源以下三个开源仓库： >- [深入浅出 Java 多线程](http://concurrent.redspider.group/) >- [并发编程知识总结](https://github.com/CL0610/Java-concurrency) >- [Java八股文](https://github.com/CoderLeixiaoshuai/java-eight-part)