ScheduledThreadPoolExecutor详解

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. 源码详解

       本文首要分为六个部分,第一片段首先会对ScheduledThreadPoolExecutor举行简易的介绍,并且会介绍其重大API的选择办法,然后介绍了其应用时的注意点,第二有的则着重对ScheduledThreadPoolExecutor的实现细节举办介绍。

2.4 scheduleAtFixedRate()和scheduleWithFixedDelay()方法

       前面我们对ScheduledThreadPoolExecutor的根本性能和紧要性内部类都开展了详实的授课,基本上已经可以看出其是如何贯彻定时执行任务的效率的,接下去我们着重对客户端可以调用的严重性方法开展简短介绍,这里scheduleAtFixedRate()和scheduleWithFixedDelay()方法的贯彻要旨是如出一辙的,多少个办法最微小的界别在于ScheduledFutureTask的setNextRun提姆(Tim)e()方法的实现,该方法的兑现后面早已拓展了讲解,我们这边则以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()方法得到任务执行。

1. 选拔简介

       ScheduledThreadPoolExecutor是一个使用线程池执行定时任务的类,相较于Java中提供的另一个实践定时任务的类提姆er,其重要有如下两个优点:

  • 动用多线程执行任务,不用担心任务执行时间过长而导致任务相互阻塞的状态,提姆er是单线程执行的,因此会出现这些问题;
  • 并非顾虑任务履行过程中,倘使线程失活,其会新建线程执行任务,提姆er类的单线程挂掉之后是不会再也创造线程执行后续任务的。

       除去上述四个亮点外,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.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.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分支中,其首先会履行当前任务,在进行到位时才会调用setNextRunTime()方法设置下次任务履行时间,也就是说对于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()方法时,即便该任务不为周期性任务,那么执行该任务之后就不会有其他的动作,假设该任务为周期性任务,那么在将当前任务执行完毕之后,还会重置当前任务的情状,并且总结下次履行当前任务的时间,然后将其放入队列中以便下次执行。

相关文章