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);

       上述多个方式中,第1个和第贰个方法属于第一类,即在delay钦命的推迟之后执行第三个参数所钦点的职务,分歧在于,第三个办法实施之后会有重回值,而首先个点子推行之后是未有重回值的。第1个和第七个主意则属于第二类,即在其次个参数(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的重大品质和要害内部类都进展了详实的授课,基本阳节经足以看看其是怎么着贯彻按时实践职务的效力的,接下去我们任重(Ren Zhong)而道远对顾客端能够调用的首要性情势实行简易介绍,这里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()方法获得职务试行。

相关文章