Java并发编程源码分析系列:
- 分析Java线程池的创建
- 分析Java线程池执行原理
- 分析Java线程池Callable任务执行原理
- 分析ReentrantLock的实现原理
- 分析CountDownLatch的实现原理
- 分析同步工具Semaphore和CyclicBarrier的实现原理
延迟或周期执行任务可以使用Timer或者ScheduledThreadPoolExecutor,前者可以抛弃,后者是今天的主角。
ScheduledThreadPoolExecutor继承了ThreadPoolExecutor,对应执行任务变成ScheduledFutureTask。本文会在前三篇分析线程池原理的基础上,分析ScheduledThreadPoolExecutor的实现原理,最后介绍下为什么不用Timer了。
ScheduledThreadPoolExecutor的创建
ScheduledExecutorService scheduledThreadPool = Executors.newScheduledThreadPool(10);
ScheduledExecutorService singleScheduledThreadPool = Executors.newSingleThreadScheduledExecutor();
public ScheduledThreadPoolExecutor(int corePoolSize,
ThreadFactory threadFactory,
RejectedExecutionHandler handler) {
super(corePoolSize, Integer.MAX_VALUE, 0, NANOSECONDS,
new DelayedWorkQueue(), threadFactory, handler);
}
ScheduledThreadPoolExecutor的创建可以使用Executors,也可以自己传参构建。上面的构造函数是参数最全的版本,可以设置线程目标数量、线程工厂和饱和策略。至于等待队列,使用内部类DelayedWorkQueue,看后文分析。
ScheduledFutureTask
ScheduledFutureTask的构造函数没什么特别,保存了三个参数。
ScheduledFutureTask(Runnable r, V result, long ns, long period) {
super(r, result);
this.time = ns;
this.period = period;
this.sequenceNumber = sequencer.getAndIncrement();
}
ScheduledFutureTask(Callable callable, long ns) {
super(callable);
this.time = ns;
this.period = 0;
this.sequenceNumber = sequencer.getAndIncrement();
}
- time:任务执行时间;
- period:任务周期执行间隔;
- sequenceNumber:自增的任务序号。
Callable默认period=0,表示任务不是周期执行,因为只有Runnable可以周期执行。想想也是,Callable目的是获得执行结果,没有必要重复调用。
ScheduledFutureTask继承了我们熟悉的FutureTask,这个不用多说。图1是它实现的接口,比较陌生的是Delayed,而Delayed又继承了Comparable。
public long getDelay(TimeUnit unit) {
return unit.convert(time - now(), NANOSECONDS);
}
public int compareTo(Delayed other) {
if (other == this) // compare zero if same object
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;
}
这两个接口的存在很容易理解,ScheduledFutureTask在等待队列里调度不再按照FIFO,而是按照执行时间,谁即将执行,谁就排在前面。在这里也可以看到sequenceNumber的作用,当执行时间相同时,按照序号排序。
添加延迟任务
对ScheduledThreadPoolExecutor使用通用的execute或者submit提交任务,最终调用schedule方法,默认马上执行。如果需要延迟执行,需要直接使用schedule,传递时间参数。
public ScheduledFuture schedule(Callable callable,
long delay,
TimeUnit unit) {
if (callable == null || unit == null)
throw new NullPointerException();
RunnableScheduledFuture t = decorateTask(callable,
new ScheduledFutureTask(callable,
triggerTime(delay, unit)));
delayedExecute(t);
return t;
}
Runnable和Callable包装成ScheduledFutureTask实例,保存了延迟信息,然后执行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();
}
}
boolean canRunInCurrentRunState(boolean periodic) {
return isRunningOrShutdown(periodic ?
continueExistingPeriodicTasksAfterShutdown :
executeExistingDelayedTasksAfterShutdown);
}
如果线程池已经关闭,直接调用饱和策略,否则将任务加入等待队列。加入之后,需要再判断线程池的状态,和当前任务是否能运行。如果不能继续执行,将任务移出队列并取消任务。
canRunInCurrentRunState处理任务加入等待队列后,又未执行就发生线程池关闭的情况,它通过预设的两个变量判断任务到底能不能执行。
- 延迟任务用executeExistingDelayedTasksAfterShutdown
- 周期任务用continueExistingPeriodicTasksAfterShutdown
void ensurePrestart() {
int wc = workerCountOf(ctl.get());
if (wc < corePoolSize)
addWorker(null, true);
else if (wc == 0)
addWorker(null, false);
}
最后调用到ensurePrestart,使用addWorkder增加工作线程,这在ThreadPoolExecutor解释过了
添加周期任务
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 sft =
new ScheduledFutureTask(command,null,triggerTime(initialDelay, unit),unit.toNanos(period));
RunnableScheduledFuture t = decorateTask(command, sft);
sft.outerTask = t;
delayedExecute(t);
return t;
}
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 sft =
new ScheduledFutureTask(command,null,triggerTime(initialDelay, unit),
unit.toNanos(-delay));
RunnableScheduledFuture t = decorateTask(command, sft);
sft.outerTask = t;
delayedExecute(t);
return t;
}
执行周期任务有上面两个方法,具体作用方法名写得很清楚:
- scheduleAtFixedRate:按固定的频率执行,不受执行时长影响,到点就执行;
- scheduleWithFixedDelay:任务执行完后,按固定的延后时间再执行。
两个方法几乎一样,不同的是构建ScheduledFutureTask时,period一个传正数,另一个传负数。不用怀疑,区分两种情况就是用正负。
等待队列
线程池的等待队列使用了内部类DelayedWorkQueue,和普通线程池等待队列最大的不同是它的任务是按照目标执行时间进行排序。
入队的offer被重写了,add和put方法也是调用offer,具体BlockingQueue的实现逻辑不在这里讨论,重点是看offer里的siftUp方法。
private void siftUp(int k, RunnableScheduledFuture> key) {
while (k > 0) {
int parent = (k - 1) >>> 1;
RunnableScheduledFuture> e = queue[parent];
if (key.compareTo(e) >= 0)
break;
queue[k] = e;
setIndex(e, k);
k = parent;
}
queue[k] = key;
setIndex(key, k);
}
siftUp根据任务的compareTo,将任务移动到队列中指定的位置,就是这样。
对应地,出队take方法,根据任务的delay时间,小于等于0时将任务出队,否则等待。
任务执行
当线程池从等待队列取出一个任务时,会执行它的run方法。
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);
}
}
方法有三个分支,第一个if判断任务在当前线程池状态下是否能执行,canRunInCurrentRunState已经讲解过。第二个if是判断是否周期任务,不是的话直接执行,不需要多余的操作。重点来看第三个if,也就是周期执行任务。
- runAndReset:任务执行完重置为初始状态,等待下一次执行;
- setNextRunTime:计算下次执行时间;
- reExecutePeriodic:再调度任务。
private void setNextRunTime() {
long p = period;
if (p > 0)
time += p;
else
time = triggerTime(-p);
}
计算下次执行时间,period根据正负有不同的计算逻辑,负的时间也会先改正,很明显对应上文的scheduleAtFixedRate和scheduleWithFixedDelay两个方法。
void reExecutePeriodic(RunnableScheduledFuture> task) {
if (canRunInCurrentRunState(true)) {
super.getQueue().add(task);
if (!canRunInCurrentRunState(true) && remove(task))
task.cancel(false);
else
ensurePrestart();
}
}
将任务重新加入等待队列,中间几个方法都解释过了。
Timer的缺陷
自从知道ScheduledThreadPoolExecutor,再没有使用Timer,因为它有几个缺陷:
- 多任务在单线程里执行,一个任务结束,另一个任务才能开始,时间间隔不准;
- 出现异常会导致全部任务停止;
- 绝对时间,受系统时间影响。
private final TaskQueue queue = new TaskQueue();
private final TimerThread thread = new TimerThread(queue);
Timer的代码很简单,主要数据结构是一个任务队列和一个执行线程。新增的任务会加入任务队列,到达时间后,由执行线程执行。只有一个线程,很容易理解上面讲的缺陷。
ScheduledThreadPoolExecutor每个任务都有对应的执行线程,时间使用相对时间计算,也就没有上面的缺陷,所以没有理由使用Timer了。