ScheduledThreadPoolExecutor详解

作者: 策略游戏排行  发布:2019-08-30

       本文主要分为多个部分,第一部分首先会对ScheduledThreadPoolExecutor进行简短的牵线,并且会介绍其入眼API的利用形式,然后介绍了其选拔时的注意点,第二片段则重视对ScheduledThreadPoolExecutor的兑现细节实行介绍。

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

       上述多少个方法中,第3个和第4个法子属于第一类,即在delay钦定的推迟之后实行第八个参数所内定的职务,不同在于,第二个点子试行之后会有再次来到值,而首先个主意试行之后是从未再次回到值的。第五个和第八个章程则属于第二类,即在第3个参数(initialDelay)钦命的小时之后初叶周期性的实行职分,试行周时期隔为第2个参数钦赐的时间,不过那多少个方法的界别在于第五个法子推行职务的距离是固定的,无论上二个任务是不是施行到位,而第八个点子的进行时间距离是不稳固的,其会在周期义务的上三个职责推行到位未来才最早计时,并在内定期间间隔之后才起来推行任务。如下是运用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

ScheduledThreadPoolExecutor详解。ScheduledThreadPoolExecutor详解。      比较上述实践结果能够看出,对于scheduleAtFixedRate()方法,其每回试行职责的开头时间间隔都为定位不改变的30s,与职务施行时间长度非亲非故,而对此scheduleWithFixedDelay()方法,其每一趟推行职责的上丑时间距离都为上次职分施行时间累加内定的大运距离。

       这里关于ScheduledThreadPoolExecutor的利用有三点供给表达如下:

  • ScheduledThreadPoolExecutor详解。ScheduledThreadPoolExecutor继承自ThreadPoolExecutor(ScheduledThreadPoolExecutor详解。ScheduledThreadPoolExecutor详解。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分支中,其首先会施行业前任务,在实施到位时才会调用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()方法时,假使该职分不为周期性任务,那么实施该职务之后就不会有别的的动作,假使该职务为周期性任务,那么在将当前职分实践实现之后,还有大概会复位当前职分的场馆,何况总结后一次实行业前任务的年月,然后将其归入队列中以便下一次推行。

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()方法得到职责实施。

本文由bg游戏资讯发布于策略游戏排行,转载请注明出处:ScheduledThreadPoolExecutor详解

关键词: 编程语言 Java 并发编程