新萄京ScheduledThreadPoolExecutor详解。ScheduledThreadPoolExecutor详解。

       本文主要分为两单部分,第一有些首先会对ScheduledThreadPoolExecutor进行简易的牵线,并且会介绍那利害攸关API的采用办法,然后介绍了那以时之注意点,第二组成部分则根本针对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);

       上述四单办法中,第一只跟第二只主意属于第一接近,即以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被提供的任何一个行定时任务的类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()方法,而第二独用例调用的凡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分支中,其首先会履行当前任务,在履行得时才会调用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.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.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()方法得到任务执行。

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()方法赢得任务尽。

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注