ScheduledThreadPoolExecutor
在进一步了解ScheduledThreadPoolExecutor类之前,先学习下ScheduledFutureTask类的构造。
类的继承图:
类图显示,该类实现Runnable接口并继承FutureTask类,表明该类是一个被包装的任务,同时该类实现Delayed接口和Comparable< Delayed>接口,表明该任务具有延迟性和优先级
。所以,我们可以初步断定ScheduledFutureTask任务使得Runnable任务具有延迟性。下面详细分析该类。
// FIFO队列的序列号
private final long sequenceNumber;
// 以毫秒为单位的相对于任务创建时刻的等待时间,即延迟时间
private long time;
// 以纳秒为单位的周期时间,正数表明fixed-rate执行,负数表明delay-rate执行,0表明非重复
private final long period;
// 当前任务
RunnableScheduledFuture<V> outerTask = this;
// 进入延迟队列的索引值,它便于取消任务
int heapIndex;
类的三个构造函数:
// 创建延迟时间为ns的非重复任务,返回结果为result
ScheduledFutureTask(Runnable r, V result, long ns) {
super(r, result);
this.time = ns;
this.period = 0; // 0表示非重复
this.sequenceNumber = sequencer.getAndIncrement(); // 当前任务的序列号
}
// 创建延迟时间为ns,周期时间为period,返回结果为result的任务
ScheduledFutureTask(Runnable r, V result, long ns, long period) {
super(r, result);
this.time = ns;
this.period = period;
this.sequenceNumber = sequencer.getAndIncrement();
}
// 创建延迟时间为ns的非重复任务
ScheduledFutureTask(Callable<V> callable, long ns) {
super(callable);
this.time = ns;
this.period = 0;
this.sequenceNumber = sequencer.getAndIncrement();
}
通过类的属性和构造函数可知,ScheduledFutureTask类使得Runnable任务可以延迟执行,甚至设置周期执行;同时记录每个Runnable任务进入延迟队列的序列号.
ScheduledFutureTask类继承FutureTask类,所以可以执行带有返回结果的任务.
// 重写FutureTask的run方法
public void run() {
// 属性period不等于0返回true,表明周期任务;否则返回false,表明非周期任务
boolean periodic = isPeriodic();
// 当前线程池状态下是否可以继续执行
if (!canRunInCurrentRunState(periodic))
cancel(false); // 终止线程并移除任务
// 非周期任务执行FutureTask的run()方法
else if (!periodic)
ScheduledFutureTask.super.run();
// 周期任务,新建任务且可执行
else if (ScheduledFutureTask.super.runAndReset()) {
// 根据period值设置该任务的time值,如果period为正数,则直接与time值相加,如果是负数,则去掉符号后与系统当前时间相加
setNextRunTime();
// 当前任务加入队列
reExecutePeriodic(outerTask);
}
}
private void setNextRunTime() {
// 构造函数中设置的周期时间
long p = period;
// 若周期时间为正数
if (p > 0)
// 则把周期时间与延迟时间相加作为任务下次执行的时间
time += p;
else
// 若为负数,则忽略延迟时间,以当前时间为基准加上周期时间作为下次任务执行时间
time = triggerTime(-p);
}
long triggerTime(long delay) {
return now() +
((delay < (Long.MAX_VALUE >> 1)) ? delay : overflowFree(delay));
}
如果delay值小于Long.MAX_VALUE值的一半,则取delay的值,否则delay值取overflowFree(delay)方法返回的值.
private long overflowFree(long delay) {
// 获取队列的头部节点,即优先级最高的任务
Delayed head = (Delayed) super.getQueue().peek();
if (head != null) {
// 获取任务的延迟时间
long headDelay = head.getDelay(NANOSECONDS);
// 若任务时间已到但还没有被处理且delay和headDelay相加溢出
if (headDelay < 0 && (delay - headDelay < 0))
// delay取差值
delay = Long.MAX_VALUE + headDelay;
}
return delay;
}
overflowFree()方法的目的是保证队列内任务的延迟时间都在Long.MAX_VALUE范围内
。
run()在处理任务时,会根据任务是否是周期任务走不通的流程:
该方法是把周期任务插入优先队列的过程.
void reExecutePeriodic(RunnableScheduledFuture<?> task) {
// 当前状态可以运行线程
if (canRunInCurrentRunState(true)) {
// task任务放入delayedWorkQueue队列中,实际执行offer()方法
super.getQueue().add(task);
// 当前状态(shutdown)不可以运行线程,删除任务
if (!canRunInCurrentRunState(true) && remove(task))
task.cancel(false); // 且中断线程
else
ensurePrestart(); // 否则判断是否要创建新的线程
}
}
boolean canRunInCurrentRunState(boolean periodic) {
return isRunningOrShutdown(periodic ?
continueExistingPeriodicTasksAfterShutdown :
executeExistingDelayedTasksAfterShutdown);
}
continueExistingPeriodicTasksAfterShutdown属性值默认为false,表示shutDown状态下取消周期性任务.
executeExistingDelayedTasksAfterShutdown属性值默认为true,表示shutDown状态下不会取消非周期性任务.
我们这里判断的是周期性任务,所以取continueExistingPeriodicTasksAfterShutdown属性的值.
void ensurePrestart() {
int wc = workerCountOf(ctl.get());
if (wc < corePoolSize)
addWorker(null, true);
else if (wc == 0)
addWorker(null, false);
}
方法表明即使corePoolSize为0,也会创建一个线程.该线程会去等待获取队列中的任务.
通过上面的分析,可知reExecutePeriodic(outerTask)方法把周期任务插入优先队列的过程:
compareTo(T)方法是核心方法,在周期任务插入优先队列的时候会根据该方法判断队列的插入位置.
public int compareTo(Delayed other) {
// 如果与自己比较则返回0
if (other == this) // compare zero if same object
return 0;
// 放进来的任务为ScheduledFutureTask类型
if (other instanceof ScheduledFutureTask) {
ScheduledFutureTask<?> x = (ScheduledFutureTask<?>)other;
// 当前任务的延迟时间与比较任务的延迟时间之差
long diff = time - x.time;
// 如果小于0,则返回-1
if (diff < 0)
return -1;
// 如果大于0,则返回1
else if (diff > 0)
return 1;
// 如果等于0,则比较任务的序列号,当前任务序列号小则返回-1
else if (sequenceNumber < x.sequenceNumber)
return -1;
// 当前序列号大则返回1
else
return 1;
}
// 任务不为ScheduledFutureTask类型,则直接比较两者的延迟时间
long diff = getDelay(NANOSECONDS) - other.getDelay(NANOSECONDS);
return (diff < 0) ? -1 : (diff > 0) ? 1 : 0;
}
compareTo(Delayed)方法表明:
PS:这个过程需要结合DelayedWorkQueue类的siftUp()和siftDown()方法理解,表明这里使用的是最小堆,即延迟时间最短的任务放置在头部节点,即优先级最高.
分析ScheduledFutureTask类可知:
类的主要作用
它是一个可以把提交的任务延迟执行或者周期执行的线程池。比起java.util.Timer类,它更加灵活。延迟任务提交到线程池后开始执行,但具体何时执行则不知道,延迟任务是根据先进先出(FIFO)的提交顺序来执行的。
当提交的任务在运行之前被取消时,执行将被禁止。默认情况下,这样一个被取消的任务不会自动从工作队列中删除,直到它的延迟过期为止。虽然这可以进行进一步的检查和监视,但也可能导致取消的任务无限制地保留。为了避免这种情况,将setRemoveOnCancelPolicy设置为true,这将导致任务在取消时立即从工作队列中删除。
通过scheduleAtFixedRate或scheduleWithFixedDelay调度的任务的连续执行不会重叠。
虽然这个类继承自ThreadPoolExecutor,但是一些继承的调优方法对它并不有用。特别是,由于它使用corePoolSize线程和无界队列(队列最大为Integer.MAX_VALUE)充当固定大小的池,所以对maximumPoolSize的调整没有任何有用的效果。
// 线程池停止后,周期任务取消执行则为false,默认为false,不取消则为ture
private volatile boolean continueExistingPeriodicTasksAfterShutdown;
// 线程池停止后,取消非周期任务则为false,不取消非周期任务则为true,默认为true
private volatile boolean executeExistingDelayedTasksAfterShutdown = true;
// 取消的任务是否移出队列,默认为false不移出
private volatile boolean removeOnCancel = false;
// 任务进入队列的序列号
private static final AtomicLong sequencer = new AtomicLong();
// 参数corePoolSize为核心线程数
public ScheduledThreadPoolExecutor(int corePoolSize) {
super(corePoolSize, Integer.MAX_VALUE, 0, NANOSECONDS,
new DelayedWorkQueue());
}
// 参数corePoolSize为核心线程数,threadFactory为自定义线程工厂
public ScheduledThreadPoolExecutor(int corePoolSize,
ThreadFactory threadFactory) {
super(corePoolSize, Integer.MAX_VALUE, 0, NANOSECONDS,
new DelayedWorkQueue(), threadFactory);
}
//参数corePoolSize为核心线程数,handler为拒绝策略
public ScheduledThreadPoolExecutor(int corePoolSize,
RejectedExecutionHandler handler) {
super(corePoolSize, Integer.MAX_VALUE, 0, NANOSECONDS,
new DelayedWorkQueue(), handler);
}
//参数corePoolSize为核心线程数, threadFactory为自定义线程工厂,handler为拒绝策略
public ScheduledThreadPoolExecutor(int corePoolSize,
ThreadFactory threadFactory,
RejectedExecutionHandler handler) {
super(corePoolSize, Integer.MAX_VALUE, 0, NANOSECONDS,
new DelayedWorkQueue(), threadFactory, handler);
}
构造函数都是调用父类ThreadPoolExecutor的构造函数,如果不清楚可以看这篇文章的分析。不过,这里可以看出:
PS:关于DelayedWorkQueue队列,可以看这篇文章的介绍.
或许此时你想问为什么最大线程数设置为Integer.MAX_VALUE?
如果你知道DelayedWorkQueue队列的原理,你就能理解了。这是因为延迟队列内用数组存放任务,数组初始长度为16,但数组长度会随着任务数的增加而动态扩容,直到数组长度为Integer.MAX_VALUE;既然队列能存放Integer.MAX_VALUE个任务,又因为任务是延迟任务,因此保证任务不被抛弃,最多需要Integer.MAX_VALUE个线程.
那么为什么空闲线程的超时时间设置为0呢?
第三个参数为0,表示空闲线程超时时间 ,第四个参数为前一个参数的时间位;ScheduledThreadPoolExecutor的四个构造函数,空闲线程超时时间都为0,表示池内不存在空闲线程.
如何定义池内的空闲线程是关键
.我们知道ScheduledThreadPoolExecutor线程池会把池内的某一个线程定义为leader线程,该leader线程用于等待队列的根节点直到获取并运行任务,而其他线程则会阻塞等待;阻塞等待的线程等待leader线程释放唤醒的信号,等待队列中的某个线程会被升级为leader线程,其他线程继续等待.那么,这里等待的线程都为空闲线程,为了避免过多的线程浪费资源,所以ScheduledThreadPool线程池内更多的存活的是核心线程.
PS:核心线程数的设置应该跟任务的周期时间和实际执行完成的时间有关.若任务周期短,但执行时间长,则核心线程数设置大一点,这样避免线程频繁的创建和销毁.若任务周期长,但执行时间短,则核心线程数设置小一点,避免核心线程数内存活过多的空闲线程.
ScheduledThreadPoolExecutor类的execute(Runnable)和submit(Runnable)方法都是调用schedule(Runnable,long,TimeUnit)方法.
首先看下被重写的execute(Runnable)方法:
public void execute(Runnable command) {
schedule(command, 0, NANOSECONDS);
}
public Future<?> submit(Runnable task) {
return schedule(task, 0, NANOSECONDS);
}
public <T> Future<T> submit(Runnable task, T result) {
return schedule(Executors.callable(task, result), 0, NANOSECONDS);
}
public <T> Future<T> submit(Callable<T> task) {
return schedule(task, 0, NANOSECONDS);
}
通过正常方法提交的任务, 内部调用的都是schedule(Runnable,long,TimeUnit);方法第一个参数就是执行的任务,第二个参数都为0,表示任务的延迟时间为0,第三个参数为前一个参数的时间单位.
public ScheduledFuture<?> schedule(Runnable command,
long delay,
TimeUnit unit) {
if (command == null || unit == null)
throw new NullPointerException();
RunnableScheduledFuture<?> t = decorateTask(command,
new ScheduledFutureTask<Void>(command, null,
triggerTime(delay, unit)));
delayedExecute(t);
return t;
}
参数含义:
执行过程:
分析schedule执行过程可知,首先Runnable任务需要转变成ScheduledFutureTask任务,然后该任务由delayedExecute(RunnableScheduledFuture)方法执行.
以上方法提交到线程池的任务都是普通任务,属于非延迟任务.
delayedExecute(RunnableScheduledFuture)方法如何执行任务?
private void delayedExecute(RunnableScheduledFuture<?> task) {
if (isShutdown())
// 线程池状态为shutdown,则执行拒绝策略拒绝任务
reject(task);
else {
// 线程状态正常,则把任务放入优先队列
super.getQueue().add(task);
// shutdown状态下,非周期任务不会移除队列
if (isShutdown() &&
!canRunInCurrentRunState(task.isPeriodic()) &&
remove(task))
// shutdown状态下,周期任务会默认移除队列
task.cancel(false);
else
// 如果池内线程数小于核心线程数,则新建一个线程
ensurePrestart();
}
}
队列中的任务等待leader线程消费任务.
目前为止,我们讨论的都是普通任务,而么有讨论周期性任务.ScheduledThreadPool线程池通过下面两个方法提交周期任务并处理周期任务.也是该线程池的核心任务.
该方法创建一个周期性任务,且设置任务的首次执行时间,即延迟时间;方法参数:
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;
delayedExecute(t);
return t;
}
方法执行逻辑:
这里可能会问,如果任务的执行时间超过周期时间会如何?
关于这个问题的答案应该是,任务的执行时间和周期性没有任何关系;即会按照固定的周期时间设置该任务的下次执行时间,然后放入优先队列;优先队列最大深度为Integer.MAX_VALUE,线程池最大线程数也为Integer.MAX_VALUE.
注意:由于线程在执行该任务,即拥有该Runnable对象的锁,因此即使下一次runnable对象的延迟时间到期也会因为锁没有被释放而无法执行;所以,表现出来的现象是只有该runnable任务执行完,才会开始执行下一次的任务。
ScheduleWithFixedDelay()方法创建并执行一个周期性的Runnable方法,该方法会在给定的初始化延迟时间之后执行;Runnable方法执行结束之后,在给定的delay值(延迟时间)后再次执行;该周期性操作会在Runnable方法执行出现异常时停止,或者线程池终止时停止.
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
long initialDelay,
long delay,
TimeUnit unit) {
if (command == null || unit == null)
throw new NullPointerException();
if (delay <= 0)
throw new IllegalArgumentException();
ScheduledFutureTask<Void> sft =
new ScheduledFutureTask<Void>(command,
null,
triggerTime(initialDelay, unit),
unit.toNanos(-delay));
RunnableScheduledFuture<Void> t = decorateTask(command, sft);
sft.outerTask = t;
delayedExecute(t);
return t;
}
ScheduleWithFixedDelay与ScheduleAtFixedRate的区别在于Runnable方法的执行方式;前者是方法执行结束之后,延迟一段时间之后再执行下一次,表明前后两次执行关系紧密;后者时不管前一次方法执行有没有结束,在固定的时间后都会再次重复该方法;当然,由于两者的Runnable任务都是延迟任务,因此任务都会加入到优先队列中等候.
既然是这样,那么如果使用ScheduleWithFixedDelay()方法,核心线程数尽量取小一点,这样可以避免空闲线程
.
围绕ScheduledThreadPoolExecutor类来讲,讲到内部任务类ScheduledFutureTask的属性和方法;然后讲到周期线程池的属性和方法,特别强调ScheduleWithFixedDelay()和ScheduleAtFixedRate()方法的使用和区别.