ScheduledThreadPoolExecutor详解

       本文首要分为七个部分,第一部分首先会对ScheduledThreadPoolExecutor实行轻便的介绍,而且会介绍其首要API的应用办法,然后介绍了其应用时的注意点,第一局部则首要对ScheduledThreadPoolExecutor的得以实现细节举办介绍。

1. 行使简要介绍

       ScheduledThreadPoolExecutor是一个使用线程池实践定时职责的类,相较于Java中提供的另三个实行定期职分的类Timer,其首要有如下多个亮点:

  • 动用八线程实践职责,不用忧虑任务奉行时间过长而导致职分互相阻塞的场合,Timer是单线程实行的,因此会冒出那些主题素材;
  • 毫不思念职务奉行进度中,假如线程失活,其会新建线程推行职分,Timer类的单线程挂掉之后是不会再一次成立线程实施后续任务的。

       除去上述五个优点外,ScheduledThreadPoolExecutor还提供了非常灵活的API,用于施行职分。其职分的推行政策首要分为两大类:①在分明延迟之后只进行一遍某些职分;②在早晚延迟之北周期性的实施有些任务。如下是其利害攸关API:

public ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit);
public <V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit);
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
                                                 long initialDelay, long delay, TimeUnit unit);
public ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
                                                  long initialDelay, long period, TimeUnit unit);

       上述七个方法中,第八个和第三个法子属于第一类,即在delay钦定的推移之后实践第几个参数所钦命的职务,差异在于,第三个主意试行之后会有重临值,而首先个章程实行之后是不曾再次回到值的。第多个和第多个措施则属于第二类,即在其次个参数(initialDelay)钦赐的小运之后开端周期性的实行职分,推行周时期隔为第多个参数钦点的岁月,不过那多个法子的界别在于第几个法子推行任务的距离是固定的,无论上三个职分是还是不是施行到位,而第多个主意的实践时间距离是不牢固的,其会在周期任务的上多少个职责推行到位以往才起先计时,并在指定期间间隔之后才起来实施职务。如下是行使scheduleWithFixedDelay()和scheduleAtFixedRate()方法编写的测验用例:

public class ScheduledThreadPoolExecutorTest {
  private ScheduledThreadPoolExecutor executor;
  private Runnable task;

  @Before
  public void before() {
    executor = initExecutor();
    task = initTask();
  }

  private ScheduledThreadPoolExecutor initExecutor() {
    return new ScheduledThreadPoolExecutor(2);;
  }

  private Runnable initTask() {
    long start = System.currentTimeMillis();
    return () -> {
      print("start task: " + getPeriod(start, System.currentTimeMillis()));
      sleep(SECONDS, 10);
      print("end task: " + getPeriod(start, System.currentTimeMillis()));
    };
  }

  @Test
  public void testFixedTask() {
    print("start main thread");
    executor.scheduleAtFixedRate(task, 15, 30, SECONDS);
    sleep(SECONDS, 120);
    print("end main thread");
  }

  @Test
  public void testDelayedTask() {
    print("start main thread");
    executor.scheduleWithFixedDelay(task, 15, 30, SECONDS);
    sleep(SECONDS, 120);
    print("end main thread");
  }

  private void sleep(TimeUnit unit, long time) {
    try {
      unit.sleep(time);
    } catch (InterruptedException e) {
      e.printStackTrace();
    }
  }

  private int getPeriod(long start, long end) {
    return (int)(end - start) / 1000;
  }

  private void print(String msg) {
    System.out.println(msg);
  }
}

       能够观察,上述七个测量试验用例代码块基本是一样的,不相同在于第贰个用例调用的是scheduleAtFixedRate()方法,而第二个用例调用的是scheduleWithFixedDelay()。这里多个用例都以安装的在延迟15s后每种30s实践一回钦命的天职,而该任务试行时间长度为10s。如下分别是那八个测验用例的实施结果:

start main thread
start task: 15
end task: 25
start task: 45
end task: 55
start task: 75
end task: 85
start task: 105
end task: 115
end main thread

start main thread
start task: 15
end task: 25
start task: 55
end task: 65
start task: 95
end task: 105
end main thread

      相比上述实行结果能够见见,对于scheduleAtFixedRate()方法,其每便试行职分的开首时间间隔都为稳固不改变的30s,与任务施行时间长度毫无干系,而对于scheduleWithFixedDelay()方法,其每一次实施职务的伊始时间间隔都为上次职务试行时间增加钦点的时日间隔。

       这里关于ScheduledThreadPoolExecutor的接纳有三点需求表明如下:

  • ScheduledThreadPoolExecutor继承自ThreadPoolExecutor(ThreadPoolExecutor详解),因此也可能有延续而来的execute()和submit()方法,不过ScheduledThreadPoolExecutor重写了那五个办法,重写的办法是直接创立三个霎时实行何况只举办一遍的天职;
  • ScheduledThreadPoolExecutor使用ScheduledFutureTask封装各类须求执行的天职,而职责都以放入DelayedWorkQueue队列中的,该队列是三个利用数组完结的开始的一段时期队列,在调用ScheduledFutureTask::cancel()方法时,其会依据removeOnCancel变量的装置来确认是还是不是须求将当前任务真正的从队列中移除,而不只是标志其为已去除状态;
  • ScheduledThreadPoolExecutor提供了二个钩子方法decorateTask(Runnable,
    RunnableScheduledFuture)用于对施行的天职进行李装运饰,该方法第多少个参数是调用方传入的义务实例,第二个参数则是选拔ScheduledFutureTask对用户传入职责实例实行打包之后的实例。这里须求注意的是,在ScheduledFutureTask对象中有多个heapIndex变量,该变量用于记录当前实例处于队列数组中的下标地点,该变量能够将诸如contains(),remove()等措施的岁月复杂度从O(N)裁减到O(logN),因此功能升高是相比高的,不过只要这里用户重写decorateTask()方法封装了队列中的职分实例,那么heapIndex的优化就不设有了,因此这里生硬提议是尽也许不要重写该方法,恐怕重写时也照旧复用ScheduledFutureTask类。

2. 源码详解

2.1 首要品质

       ScheduledThreadPoolExecutor首要有多个性子,分别如下:

private volatile boolean continueExistingPeriodicTasksAfterShutdown;

private volatile boolean executeExistingDelayedTasksAfterShutdown = true;

private volatile boolean removeOnCancel = false;

private static final AtomicLong sequencer = new AtomicLong();
  • continueExistingPeriodicTasksAfterShutdown:用于标记当前Executor对象shutdown时,是或不是继续施行已经存在于义务队列中的定时职务(调用scheduleAtFixedRate()方法生成的天职);
  • executeExistingDelayedTasksAfterShutdown:用于标记当前Executor对象shutdown时,是或不是继续施行已经存在于职分队列中的定时职务(调用scheduleWithFixedDelay()方法生成的天职);
  • removeOnCancel:用于标记假如当前职责已经撤回了,是不是将其从职分队列中真的的移除,而不只是标记其为除去状态;
  • sequencer:其为一个AtomicLong类型的变量,该变量记录了当前义务被创立时是第多少个职分的一个序号,那些序号的尤为重要用以确认当四个职务开首实践时间毫无二致时具体哪些职分先实践,比方四个职分的起始试行时间都为1515847881158,那么序号小的职务将先进行。

2.2 ScheduledFutureTask

       在ScheduledThreadPoolExecutor中,首要行使ScheduledFutureTask封装需求施行的天职,该类的重大证明如下:

private class ScheduledFutureTask<V> extends FutureTask<V> implements RunnableScheduledFuture<V> {

  private final long sequenceNumber;    // 记录当前实例的序列号
  private long time;    // 记录当前任务下次开始执行的时间

  // 记录当前任务执行时间间隔,等于0则表示当前任务只执行一次,大于0表示当前任务为fixedRate类型的任务,
  // 小于0则表示其为fixedDelay类型的任务
  private final long period;

  RunnableScheduledFuture<V> outerTask = this;  // 记录需要周期性执行的任务的实例
  int heapIndex;    // 记录当前任务在队列数组中位置的下标

  ScheduledFutureTask(Runnable r, V result, long ns, long period) {
    super(r, result);
    this.time = ns;
    this.period = period;
    this.sequenceNumber = sequencer.getAndIncrement();  // 序号在创建任务实例时指定,且后续不会变化
  }

  public long getDelay(TimeUnit unit) {
    return unit.convert(time - now(), NANOSECONDS);
  }

  // 各个任务在队列中的存储方式是一个基于时间和序号进行比较的优先队列,当前方法定义了优先队列中两个
  // 任务执行的先后顺序。这里先对两个任务开始执行时间进行比较,时间较小者优先执行,若开始时间相同,
  // 则比较两个任务的序号,序号小的任务先执行
  public int compareTo(Delayed other) {
    if (other == this)
      return 0;
    if (other instanceof ScheduledFutureTask) {
      ScheduledFutureTask<?> x = (ScheduledFutureTask<?>)other;
      long diff = time - x.time;
      if (diff < 0)
        return -1;
      else if (diff > 0)
        return 1;
      else if (sequenceNumber < x.sequenceNumber)
        return -1;
      else
        return 1;
    }
    long diff = getDelay(NANOSECONDS) - other.getDelay(NANOSECONDS);
    return (diff < 0) ? -1 : (diff > 0) ? 1 : 0;
  }

  public boolean isPeriodic() { // 判断是否为周期性任务
    return period != 0;
  }

  // 当前任务执行之后,会判断当前任务是否为周期性任务,如果为周期性任务,那么就调用当前方法计算
  // 当前任务下次开始执行的时间。这里如果当前任务是fixedRate类型的任务(p > 0),那么下次执行时间
  // 就是此次执行的开始时间加上时间间隔,如果当前任务是fixedDelay类型的任务(p < 0),那么下次执行
  // 时间就是当前时间(triggerTime()方法会获取系统当前时间)加上任务执行时间间隔。可以看到,定频率
  // 和定延迟的任务的执行时间区别就在当前方法中进行了指定,因为调用当前方法时任务已经执行完成了,
  // 因而triggerTime()方法中获取的时间就是任务执行完成之后的时间点
  private void setNextRunTime() {
    long p = period;
    if (p > 0)
      time += p;
    else
      time = triggerTime(-p);
  }

  // 取消当前任务的执行,super.cancel(boolean)方法也即FutureTask.cancel(boolean)方法。该方法传入
  // true表示如果当前任务正在执行,那么立即终止其执行;传入false表示如果当前方法正在执行,那么等待其
  // 执行完成之后再取消当前任务。
  public boolean cancel(boolean mayInterruptIfRunning) {
    boolean cancelled = super.cancel(mayInterruptIfRunning);
    // 判断是否设置了取消后移除队列中当前任务,是则移除当前任务
    if (cancelled && removeOnCancel && heapIndex >= 0)  
      remove(this);
    return cancelled;
  }

  public void run() {
    boolean periodic = isPeriodic();    // 判断是否为周期性任务
    if (!canRunInCurrentRunState(periodic)) // 判断是否能够在当前状态下执行该任务
      cancel(false);
    else if (!periodic) // 如果能执行当前任务,但是任务不是周期性的,那么就立即执行该任务一次
      ScheduledFutureTask.super.run();
    else if (ScheduledFutureTask.super.runAndReset()) { // 是周期性任务,则立即执行当前任务并且重置
      setNextRunTime(); // 在当前任务执行完成后调用该方法计算当前任务下次执行的时间
      reExecutePeriodic(outerTask); // 将当前任务放入任务队列中以便下次执行
    }
  }
}

       在ScheduledFutureTask中,首要有三个点需求强调:

  • 对此run()方法的第二个分支,canRunInCurrentRunState()方法的宣示如下所示,可以见见,该办法是用来推断当前职务假诺为周期性任务,那么其是还是不是同意在shutdown状态下继续实施已经存在的周期性职责,是则意味着方今状态下是能够实践业前职务的,这里isRunningOrShutdown()方法承继自ThreadPoolExecutor;

    boolean canRunInCurrentRunState(boolean periodic) {
    return isRunningOrShutdown(periodic ?

                             continueExistingPeriodicTasksAfterShutdown :
                             executeExistingDelayedTasksAfterShutdown);
    

    }

  • 在run()方法的尾声贰个if分支中,其首先会实产业前职责,在实行到位时才会调用setNextRun提姆e()方法设置下一次职务实施时间,约等于说对于fixedRate和fixedDelay类型的任务都是在这么些小时点才设置的,由此即使fixedRate类型的天职,即便该职责后一次推行时间比当下岁月要早,其也只会在当前职责推行到位后当即推行,而不会与当前职务还未实践完时就执行;对于fixedDelay职分则不会存在该问题,因为其是以职分到位后的日子点为底蕴测算后一次试行的时间点;

  • 对此run()方法的尾声贰个拨出中的reExecutePeriodic()方法,其会将当前职分参与到职责队列中,况且调用父类的ensurePrestart()方法确定保障有可用的线程来奉行当前职务,如下是该措施的切切实实贯彻:

    void reExecutePeriodic(RunnableScheduledFuture task) {
    if (canRunInCurrentRunState(true)) { // 判别当前任务是不是足以继续施行

    super.getQueue().add(task); // 将当前任务加入到任务队列中
    if (!canRunInCurrentRunState(true) && remove(task)) // 双检查法判断任务在加入过程中是否取消了
      task.cancel(false);
    else
      ensurePrestart(); // 初始化核心线程等确保任务可以被执行
    

    }
    }

       从ScheduledFutureTask的贯彻总括来看,当每成立贰个此类实例时,会早先化该类的局地第一品质,如后一次起来执行的光阴和试行的周期。当某些线程调用该任务,即进行该任务的run()方法时,假设该职务不为周期性任务,那么实行该职责之后就不会有别的的动作,假使该职务为周期性职责,那么在将当前义务实施实现之后,还有恐怕会重新恢复设置当前职务的气象,而且计算后一次进行业前任务的时间,然后将其归入队列中以便后一次实行。

2.3 DelayedWorkQueue

       DelayedWorkQueue的贯彻与DelayQueue以及PriorityQueue的落到实处宗旨相似,情势都为一个先行队列,况且底层是接纳堆结构来贯彻优先队列的效果,在多少存款和储蓄方式上,其使用的是数组来促成。这里DelayedWorkQueue与DelayQueue以及PriorityQueue差别的点在于DelayedWorkQueue中主要性囤积ScheduledFutureTask类型的职责,该职分中有多少个heapIndex属性保存了当前任务在时下队列数组中的地点下标,其首要进步的是对队列的诸如contains()和remove()等急需牢固当前职分地点的不二等秘书技的频率,时间复杂度能够从O(N)升高到O(logN)。如下是DelayedWorkQueue的兑今世码(这里只列出了此类的根特性能和与落实ScheduledThreadPoolExecutor作用有关的办法,关于怎么样行使数组完成优先队列请读者查阅相关文书档案):

static class DelayedWorkQueue extends AbstractQueue<Runnable> implements BlockingQueue<Runnable> {

  private static final int INITIAL_CAPACITY = 16;   // 数组初始化大小
  private RunnableScheduledFuture<?>[] queue = new RunnableScheduledFuture<?>[INITIAL_CAPACITY];
  private final ReentrantLock lock = new ReentrantLock();   // 对添加和删除元素所使用的锁
  private int size = 0; // 当前队列中有效任务的个数

  private Thread leader = null; // 执行队列头部任务的线程
  private final Condition available = lock.newCondition();  // 除leader线程外其余线程的等待队列

  // 在对任务进行移动时,判断其是否为ScheduledFutureTask实例,如果是则维护其heapIndex属性
  private void setIndex(RunnableScheduledFuture<?> f, int idx) {
    if (f instanceof ScheduledFutureTask)
      ((ScheduledFutureTask)f).heapIndex = idx;
  }

  private void siftUp(int k, RunnableScheduledFuture<?> key) {/* 省略 */}

  private void siftDown(int k, RunnableScheduledFuture<?> key) {/* 省略 */}

  private int indexOf(Object x) {
    if (x != null) {
      if (x instanceof ScheduledFutureTask) {   // 如果为ScheduledFutureTask则可返回其heapIndex属性
        int i = ((ScheduledFutureTask) x).heapIndex;
        if (i >= 0 && i < size && queue[i] == x)
          return i;
      } else {  // 如果不为ScheduledFutureTask实例,则需要遍历队列查询当前元素的位置
        for (int i = 0; i < size; i++)
          if (x.equals(queue[i]))
            return i;
      }
    }
    return -1;
  }

  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;
      if (i >= queue.length)
        grow(); // 队列容量不足,对其进行扩容
      size = i + 1;
      if (i == 0) { // 如果其为队列第一个元素,则将其放入队列头部
        queue[0] = e;
        setIndex(e, 0);
      } else {  //如果不为第一个元素,则通过堆的上移元素操作移动当前元素至合适的位置
        siftUp(i, e);
      }
      if (queue[0] == e) {  // 如果被更新的是队列头部元素,则更新记录的执行头部任务的线程
        leader = null;
        available.signal();
      }
    } finally {
      lock.unlock();
    }
    return true;
  }

  // 完成从队列拉取元素操作,并且将其从队列中移除
  private RunnableScheduledFuture<?> finishPoll(RunnableScheduledFuture<?> f) {
    int s = --size;
    RunnableScheduledFuture<?> x = queue[s];
    queue[s] = null;    // 将队列最尾部的元素置空
    if (s != 0) // 将最后一个元素放入第一个位置,并且将其下推至合适的位置
      siftDown(0, x);   // 这里idx置为0是因为当前方法的入参f都为队列的第一个元素
    setIndex(f, -1);
    return f;
  }

  // 尝试从队列(堆)中获取元素,如果没有元素或者元素的延迟时间还未到则返回空
  public RunnableScheduledFuture<?> poll() {
    final ReentrantLock lock = this.lock;
    lock.lock();
    try {
      RunnableScheduledFuture<?> first = queue[0];
      // 在此处代码控制了当从堆顶拉取元素时,如果元素的延迟时间还未达到,则不返回当前元素
      if (first == null || first.getDelay(NANOSECONDS) > 0)
        return null;
      else
        return finishPoll(first);   // 返回堆顶元素
    } finally {
      lock.unlock();
    }
  }

  // 通过无限for循环获取堆顶的元素,这里take()方法会阻塞当前线程,直至获取到了可执行的任务。
  // 可以看到,在第一次for循环中,如果堆顶不存在任务,则其会加入阻塞队列中,如果存在任务,但是
  // 其延迟时间还未到,那么当前线程会等待该延迟时间长的时间,然后查看任务是否可用,当获取到任务
  // 之后,其会将其从队列中移除,并且唤醒等待队列中其余等待的线程执行下一个任务
  public RunnableScheduledFuture<?> take() throws InterruptedException {
    final ReentrantLock lock = this.lock;
    lock.lockInterruptibly();
    try {
      for (;;) {
        RunnableScheduledFuture<?> first = queue[0];
        if (first == null)
          available.await();    // 堆内没有元素,当前线程进入等待队列中
        else {
          long delay = first.getDelay(NANOSECONDS);
          if (delay <= 0)   // 堆顶元素延迟时间小于0,可立即获取任务
            return finishPoll(first);
          first = null;
          if (leader != null)
            available.await();  // 已经有线程在等待堆顶元素,则当前线程进入等待队列中
          else {
            Thread thisThread = Thread.currentThread();
            leader = thisThread;
            try {
              available.awaitNanos(delay);  // 当前线程等待一定时长后获取任务并执行
            } finally {
              if (leader == thisThread)
                leader = null;
            }
          }
        }
      }
    } finally {
      if (leader == null && queue[0] != null)
        available.signal(); // 当前线程获取完任务之后唤醒等待队列中的下一个线程执行下一个任务
      lock.unlock();
    }
  }
}

       从DelayedWorkQueue的take()和poll()方法能够看出来,对于队列中职责的守候时间的界定重视是在那多少个格局中完结的,借使职责的等待时间还未到,那么该方法就能够阻塞线程池中的线程,直至职责能够施行。

2.4 scheduleAtFixedRate()和scheduleWithFixedDelay()方法

       前边我们对ScheduledThreadPoolExecutor的基本点品质和首要内部类都开始展览了详实的执教,基本仲春经足以看到其是何等贯彻定期试行任务的效果与利益的,接下去大家重视对客户端能够调用的显要格局开始展览简短介绍,这里scheduleAtFixedRate()和scheduleWithFixedDelay()方法的落实大旨是平等的,五个艺术最微小的区分在于ScheduledFutureTask的setNextRunTime()方法的兑现,该办法的贯彻前边已经拓展了教学,大家那边则以scheduleAtFixedRate()方法的实现为例对该办法开始展览教学。如下是该办法的有血有肉落到实处:

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<Void> sft =   // 封装客户端的任务实例
    new ScheduledFutureTask<Void>(command, null, 
                                  triggerTime(initialDelay, unit),unit.toNanos(period));
  RunnableScheduledFuture<Void> t = decorateTask(command, sft); // 对客户端任务实例进行装饰
  sft.outerTask = t;    // 初始化周期任务属性outerTask
  delayedExecute(t);    // 执行该任务
  return t;
}

       从上述代码能够看出来,scheduleAtFixedRate()首先对客户端职务实例实行了包装,装饰,而且起始化了包装后的义务实例的outerTask属性,最终调用delayedExecute()方法实践职务。如下是delayedExecute()方法的兑现:

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
      ensurePrestart(); // 若线程池没有初始化,则进行一些初始化工作
  }
}

       上述方法为入眼的施行职务的法子,该办法首先会将职责参加到任务队列中,假使线程池已经起首化过,那么该职务就能有等待的线程试行该职责。在出席到职责队列之后通过双检查法检查线程池是或不是曾经shutdown了,要是是则将该职务从职责队列中移除。倘若当前线程池未有shutdown,就调用承继自ThreadPoolExecutor的ensurePrestart()方法,该方法会对线程池实行局地初叶化工作,如起初化宗旨线程,然后每家每户线程会调用上述等待队列的take()方法得到职务推行。