ScheduledThreadPoolExecutor详解爱博体育app下载

       本文重要分为五个部分,第一有些首先会对ScheduledThreadPoolExecutor举行简单的介绍,并且会介绍其紧要API的应用办法,然后介绍了其利用时的注意点,第二片段则第一对ScheduledThreadPoolExecutor的落实细节举办介绍。

       本文紧要分为两个部分,第一部分首先会对ScheduledThreadPoolExecutor举行简单的牵线,并且会介绍其首要API的应用办法,然后介绍了其行使时的注意点,第二局部则重点对ScheduledThreadPoolExecutor的落实细节进行介绍。

1. 施用简介

       ScheduledThreadPoolExecutor是一个使用线程池执行定时任务的类,相较于Java中提供的另一个实践定时任务的类提姆(Tim)er,其利害攸关有如下多少个优点:

  • 运用多线程执行任务,不用担心任务执行时间过长而致使任务相互阻塞的情景,提姆er是单线程执行的,由此会冒出这多少个问题;
  • 不要顾虑任务履行过程中,假诺线程失活,其会新建线程执行任务,提姆(Tim)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类。

1. 运用简介

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

  • 利用多线程执行任务,不用操心任务执行时间过长而导致任务互相阻塞的情形,提姆er是单线程执行的,因此会现出那些题材;
  • 爱博体育app下载,不用担心任务履行过程中,假设线程失活,其会新建线程执行任务,提姆(Tim)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. 源码详解

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.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.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.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的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()方法赢得任务履行。

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()方法取得任务履行。

相关文章