ThreadPoolExecutor 源码解析一
作者：互联网
1. 构造函数解析
- corePoolSize ：线程池中活跃的线程数量，线程一般不会回收。
- maximumPoolSize ：maximumPoolSize - corePoolSize等于救急线程，当任务队列已经满了，每进来一个任务，就会开启一个救急线程。
- keepAliveTime & unit ： 救急线程工作完成后的等待时间，超时后自动回收。
- workQueue ：任务队列，存放没来得急执行的任务。
- threadFactory ：线程工厂，创建线程。不论是核心线程还是救急线程都是用线程工厂创建
- handler ：拒绝策略，任务队列满了，救急线程全部工作，新来的任务需要对应的拒绝策略来处理。
public ThreadPoolExecutor(int corePoolSize,
int maximumPoolSize,
long keepAliveTime,
TimeUnit unit,
BlockingQueue<Runnable> workQueue,
ThreadFactory threadFactory,
RejectedExecutionHandler handler) {
//参数合法性校验
if (corePoolSize < 0 ||
maximumPoolSize <= 0 ||
maximumPoolSize < corePoolSize ||
keepAliveTime < 0)
throw new IllegalArgumentException();
if (workQueue == null || threadFactory == null || handler == null)
throw new NullPointerException();
this.acc = System.getSecurityManager() == null ?
null :
AccessController.getContext();
//参数赋值
this.corePoolSize = corePoolSize;
this.maximumPoolSize = maximumPoolSize;
this.workQueue = workQueue;
this.keepAliveTime = unit.toNanos(keepAliveTime);
this.threadFactory = threadFactory;
this.handler = handler;
}2. ThreadPoolExecutor属性说明
- AtomicInteger ctl ：高3位表示线程池状态，后29位表示工作线程数量
- int RUNNING ：运行状态。-1 左移 29 位，相当于高3位表示状态。
- int SHUTDOWN ：待关闭状态。0 左移 29位，相当于高3位表示状态。此时线程池不接受新任务，但是会将队列中的任务执行完。
- int STOP ：停止状态。1 左移 29位，相当于高3位表示状态。此时线程池不接受新任务，同时将队列中的任务丢弃。
- int TIDYING ：整理状态。2左移 29位，相当于高3位表示状态。此时线程池队列为空，准备调用terminated()方法。
- int TERMINATED ：终止状态。3左移 29位，相当于高3位表示状态。此时线程池真正关闭。
// 保存线程池状态和工作线程数量
private final AtomicInteger ctl = new AtomicInteger(ctlOf(RUNNING, 0));
// 29
private static final int COUNT_BITS = Integer.SIZE - 3;
// 低29位 全1
private static final int CAPACITY = (1 << COUNT_BITS) - 1;
// 线程池运行状态
private static final int RUNNING = -1 << COUNT_BITS;
private static final int SHUTDOWN = 0 << COUNT_BITS;
private static final int STOP = 1 << COUNT_BITS;
private static final int TIDYING = 2 << COUNT_BITS;
private static final int TERMINATED = 3 << COUNT_BITS;
// 计算线程状态
private static int runStateOf(int c) { return c & ~CAPACITY; }
// 计算工作线程数量
private static int workerCountOf(int c) { return c & CAPACITY; }
// 将线程数量和线程状态拼接为ctl
private static int ctlOf(int rs, int wc) { return rs | wc; }
2.execute(Runnable command)方法解析
public void execute(Runnable command) {
if (command == null)
throw new NullPointerException();
int c = ctl.get();
// 工作线程数量是否小于核心线程数量
if (workerCountOf(c) < corePoolSize) {
// 添加新线程（核心线程），执行任务
if (addWorker(command, true))
return;
c = ctl.get();
}
// 添加任务到队列
if (isRunning(c) && workQueue.offer(command)) {
int recheck = ctl.get();
// 重复检查线程池状态，不是运行状态就将任务从任务队列中移除
if (! isRunning(recheck) && remove(command))
//调用拒绝策略
reject(command);
else if (workerCountOf(recheck) == 0)
//添加一个线程（非核心线程）
addWorker(null, false);
}
// 队列满了，创建救急线程
else if (!addWorker(command, false))
//调用拒绝策略
reject(command);
}3.addWorker(Runnable firstTask, boolean core)方法解析
private boolean addWorker(Runnable firstTask, boolean core) {
retry:
for (;;) {
int c = ctl.get();
int rs = runStateOf(c);
// 线程池状态为RUNNING
// 线程池状态为SHUTDOWN ，且firstTask == null, 且任务队列不为空
// 只有以上两种情况才不会被截断
// 其他情况直接方法false, 开启线程失败。
if (rs >= SHUTDOWN &&
! (rs == SHUTDOWN &&
firstTask == null &&
! workQueue.isEmpty()))
return false;
// cas 修改工作线程数量
for (;;) {
int wc = workerCountOf(c);
// 判断是添加的核心线程还是救急线程，不能超过范围
if (wc >= CAPACITY ||
wc >= (core ? corePoolSize : maximumPoolSize))
return false;
if (compareAndIncrementWorkerCount(c))
break retry;
c = ctl.get(); // Re-read ctl
// 线程池状态被改变，退出到上层循环
if (runStateOf(c) != rs)
continue retry;
// else CAS failed due to workerCount change; retry inner loop
}
}
//工作线程是否开启
boolean workerStarted = false;
//工作线程是否添加到集合
boolean workerAdded = false;
Worker w = null;
try {
//创建工作线程
w = new Worker(firstTask);
final Thread t = w.thread;
if (t != null) {
final ReentrantLock mainLock = this.mainLock;
mainLock.lock();
try {
// 运行状态
int rs = runStateOf(ctl.get());
// 线程池状态为RUNNING
// 线程池状态为SHUTDOWN ，且firstTask == null
// 以上两种才能成功添加工作线程
if (rs < SHUTDOWN ||
(rs == SHUTDOWN && firstTask == null)) {
if (t.isAlive()) // precheck that t is startable
throw new IllegalThreadStateException();
workers.add(w);
int s = workers.size();
if (s > largestPoolSize)
largestPoolSize = s;
workerAdded = true;
}
} finally {
mainLock.unlock();
}
//开启工作线程
if (workerAdded) {
t.start();
workerStarted = true;
}
}
} finally {
if (! workerStarted)
addWorkerFailed(w);
}
return workerStarted;
}4.Worker 类解析
// 线程对象
final Thread thread;
// 第一个任务
Runnable firstTask;
// 该线程完成任务的数量
volatile long completedTasks;
//构造方法
Worker(Runnable firstTask) {
//worker 继承 AQS，将state 设置为-1， 是为了防止worker启动过程中被打断。
setState(-1); // inhibit interrupts until runWorker
this.firstTask = firstTask;
// 根据线程工厂，创建线程
this.thread = getThreadFactory().newThread(this);
}
// 运行线程
public void run() {
runWorker(this);
}5.runWorker(Worker w) 方法解析
1. w.unlock() ，将state设置为0， 前面设置为-1，是为了防止worker启动过程中被打断，这里设置为0，表示可以被打断。
2.任务对象为空，则从任务队列中拿任务，如果任务队列为空，则线程阻塞。
3.w.lock() ：加锁，主要是防止工作线程在执行任务过程中被打断。
4.线程池是运行状态，如果线程有打断标识，则清除掉。
5.运行任务。
6.执行退出操作。
final void runWorker(Worker w) {
Thread wt = Thread.currentThread();
//任务
Runnable task = w.firstTask;
w.firstTask = null;
//将state设置为0， 表示可打断
w.unlock(); // allow interrupts
//是否是任务执行完成而导致线程退出。
boolean completedAbruptly = true;
try {
//循环获取任务
while (task != null || (task = getTask()) != null) {
//防止工作线程在执行任务过程中被打断
w.lock();
//线程池是RUNNING | SHUTDOWN 状态下，清除打断表示
//线程池是STOP | TIDYING | TERMINATED 状态下，设置打断标识
if ((runStateAtLeast(ctl.get(), STOP) ||
(Thread.interrupted() &&
runStateAtLeast(ctl.get(), STOP))) &&
!wt.isInterrupted())
wt.interrupt();
try {
//执行任务之前回调
beforeExecute(wt, task);
Throwable thrown = null;
try {
//运行任务
task.run();
} catch (RuntimeException x) {
thrown = x; throw x;
} catch (Error x) {
thrown = x; throw x;
} catch (Throwable x) {
thrown = x; throw new Error(x);
} finally {
//执行任务之后回调
afterExecute(task, thrown);
}
} finally {
task = null;
w.completedTasks++;
w.unlock();
}
}
completedAbruptly = false;
} finally {
//线程将要退出，执行退出方法
processWorkerExit(w, completedAbruptly);
}
}6.getTask() 方法解析
private Runnable getTask() {
// 只有救急线程poll(keepAliveTime, TimeUnit.NANOSECONDS)任务 的情况下，才会设置为ture
boolean timedOut = false; // Did the last poll() time out?
for (;;) {
int c = ctl.get();
int rs = runStateOf(c);
// 线程池状态：RUNNING
// 线程池状态；SHUTDOWN && 任务队列不为空
// 以上两种情况下，才不会被截断，放回空任务。
if (rs >= SHUTDOWN && (rs >= STOP || workQueue.isEmpty())) {
decrementWorkerCount();
return null;
}
int wc = workerCountOf(c);
// 当前线程是否需要设置超时时间
boolean timed = allowCoreThreadTimeOut || wc > corePoolSize;
// wc > maximumPoolSize ：不清楚怎样会满足这个条件
// 这里即使是超时了，也要保证在队列中有任务的情况下，至少有一个线程在运行。
if ((wc > maximumPoolSize || (timed && timedOut))
&& (wc > 1 || workQueue.isEmpty())) {
if (compareAndDecrementWorkerCount(c))
return null;
continue;
}
try {
// 按照有超时时间或没有超时时间的方式获取队列中的任务
// 没有任务，核心线程会阻塞在这里
// 没有任务，救急线程会超时，设置timedOut==true
// 在阻塞被打断的情况下，timedOut == false
Runnable r = timed ?
workQueue.poll(keepAliveTime, TimeUnit.NANOSECONDS) :
workQueue.take();
if (r != null)
return r;
timedOut = true;
} catch (InterruptedException retry) {
timedOut = false;
}
}
}7.processWorkerExit(Worker w, boolean completedAbruptly) 方法解析
1.参数说明：
- Worker w ： 工作线程包装器。
- boolean completedAbruptly ：默认值为true，只有调用getTask()方法，返回null，线程正常退出，会将completedAbruptly设置为false。当task.run()任务运行过程中抛出异常，线程异常退出，completedAbruptly还是默认值true。
2.执行过程：
- 统计执行完成的任务个数。
- tryTerminate() 尝试调用terminated()方法。
- RUNNING | SHUTDOWN 状态下，保证工作线程数量 >= corePoolSize，如果不满足，添加新线程。
private void processWorkerExit(Worker w, boolean completedAbruptly) {
// 线程异常退出，修改工作线程数量。
if (completedAbruptly) // If abrupt, then workerCount wasn't adjusted
decrementWorkerCount();
final ReentrantLock mainLock = this.mainLock;
mainLock.lock();
try {
// 统计执行完成任务个数
completedTaskCount += w.completedTasks;
// 移除当前worker
workers.remove(w);
} finally {
mainLock.unlock();
}
// 尝试调用terminated() 方法
tryTerminate();
int c = ctl.get();
//RUNNING | SHUTDOWN 状态下要保证最小工作线程数。
if (runStateLessThan(c, STOP)) {
// 线程正常退出，需要退出救急线程
// 线程异常退出，直接添加新线程
if (!completedAbruptly) {
// 判断最小线程数量，一般是核心线程数量。
int min = allowCoreThreadTimeOut ? 0 : corePoolSize;
if (min == 0 && ! workQueue.isEmpty())
// 最少一个线程
min = 1;
if (workerCountOf(c) >= min)
// 不需要添加新线程
return; // replacement not needed
}
// 添加新线程
addWorker(null, false);
}
}8.tryTerminate() 方法解析
1.RUNNING || （线程池已经被关闭【TIDYING | TERMINATED】） || （SHUTDOWN && 任务队列不为空），直接返回。
2.工作线程数不为0【不是最后一个工作线程】， 随机打断一个空闲线程，直接放回。
3.最后一个线程修改线程池状态为TIDYING，调用terminated()方法，修改线程状态为TERMINATED，唤醒等待线程【其他线程调用awaitTermination()】。
final void tryTerminate() {
for (;;) {
int c = ctl.get();
//RUNNING || （线程池已经被关闭【TIDYING | TERMINATED】） || （SHUTDOWN && 任务队列不为空），直接退出
if (isRunning(c) ||
runStateAtLeast(c, TIDYING) ||
(runStateOf(c) == SHUTDOWN && ! workQueue.isEmpty()))
return;
// 不是最后一个工作线程，直接退出
if (workerCountOf(c) != 0) { // Eligible to terminate
// 执行到这里，线程池一定需要关闭，这里会随机打断一个空闲工作线程
interruptIdleWorkers(ONLY_ONE);
return;
}
final ReentrantLock mainLock = this.mainLock;
mainLock.lock();
try {
// 修改线程池状态为TIDYING，工作线程数量为0
if (ctl.compareAndSet(c, ctlOf(TIDYING, 0))) {
try {
// 调用方法，这里默认是空
terminated();
} finally {
// 修改线程池状态为TERMINATED， 工作线程数量为0
ctl.set(ctlOf(TERMINATED, 0));
// 唤醒正在等待线程池关闭的线程
termination.signalAll();
}
return;
}
} finally {
mainLock.unlock();
}
// else retry on failed CAS
}
}================================================================以上主要说明execute方法======================================================================
9.shutdown() 方法解析
shutdown方法不会立即关闭线程池，会继续执行工作队列中任务，但是不会接受新任务。
public void shutdown() {
final ReentrantLock mainLock = this.mainLock;
mainLock.lock();
try {
// java 安全管理器校验
checkShutdownAccess();
// cas 将线程池状态修改为SHUTDOWN 状态
advanceRunState(SHUTDOWN);
// 打断所有的空闲工作线程，即workerQueue.take()阻塞的线程
interruptIdleWorkers();
// 调用回掉方法，默认为空方法
onShutdown(); // hook for ScheduledThreadPoolExecutor
} finally {
mainLock.unlock();
}
// 尝试结束线程池
tryTerminate();
}
private void advanceRunState(int targetState) {
for (;;) {
int c = ctl.get();
// 如果线程池状态已经是targetState后面状态，则不需要修改
if (runStateAtLeast(c, targetState) ||
ctl.compareAndSet(c, ctlOf(targetState, workerCountOf(c))))
break;
}
}
private void interruptIdleWorkers(boolean onlyOne) {
final ReentrantLock mainLock = this.mainLock;
mainLock.lock();
try {
for (Worker w : workers) {
Thread t = w.thread;
//w.tryLock() 正在工作的线程，无法被打断。该方法不会被阻塞。
if (!t.isInterrupted() && w.tryLock()) {
try {
// 修改线程打断状态
t.interrupt();
} catch (SecurityException ignore) {
} finally {
w.unlock();
}
}
// 这里onlyOne== true，打断所有空闲线程
if (onlyOne)
break;
}
} finally {
mainLock.unlock();
}
}10.shutdownNow() 方法解析
立即关闭线程池：不接受新的任务，任务队列中的任务全部返回给调用者，不再执行。
public List<Runnable> shutdownNow() {
// 没来得及执行的任务集合
List<Runnable> tasks;
final ReentrantLock mainLock = this.mainLock;
mainLock.lock();
try {
// java 安全管理器验证
checkShutdownAccess();
// 修改线程池状态为STOP
advanceRunState(STOP);
// 打断所有线程，无论线程是否正在执行
interruptWorkers();
// 将未执行的任务，从任务队列中移除
tasks = drainQueue();
} finally {
mainLock.unlock();
}
// 尝试结束线程池
tryTerminate();
return tasks;
}
private void interruptWorkers() {
final ReentrantLock mainLock = this.mainLock;
mainLock.lock();
try {
// 打断所有线程
for (Worker w : workers)
w.interruptIfStarted();
} finally {
mainLock.unlock();
}
}
void interruptIfStarted() {
Thread t;
// 在创建worker对象时，将state设置为-1，就是用到此处，线程还没完全启动时，不能立即打断
if (getState() >= 0 && (t = thread) != null && !t.isInterrupted()) {
try {
t.interrupt();
} catch (SecurityException ignore) {
}
}
}11.awaitTermination(long timeout, TimeUnit unit)方法说明
调用awaitTermination方法线程，等待线程池关闭，调用线程会在这里阻塞。在tryTerminate()成功时，唤醒阻塞线程。
public boolean awaitTermination(long timeout, TimeUnit unit)
throws InterruptedException {
long nanos = unit.toNanos(timeout);
final ReentrantLock mainLock = this.mainLock;
mainLock.lock();
try {
for (;;) {
// 线程池状态如果已经结束，立即返回，无需等待
if (runStateAtLeast(ctl.get(), TERMINATED))
return true;
if (nanos <= 0)
return false;
//阻塞
nanos = termination.awaitNanos(nanos);
}
} finally {
mainLock.unlock();
}
}文章内容为个人理解，如有错误，请指出
标签：mainLock,int,任务,源码,线程,&&,ctl,解析,ThreadPoolExecutor 来源： https://blog.csdn.net/weixin_41009314/article/details/117770590