本文主要分为八个部分,第1盘部首先会对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()方法,而第4个用例调用的是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分支中,其首先会推行业前职分,在施行到位时才会调用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()方法取得职责实践。

相关文章