线程池源码分析

public ThreadPoolExecutor(int corePoolSize, // 核心线程数
                          int maximumPoolSize, // 最大线程数
                          long keepAliveTime, // 非核心线程闲置存活时间
                          TimeUnit unit, // 时间单位
                          BlockingQueue workQueue, // 工作队列
                          ThreadFactory threadFactory, // 创建线程使用的线程工厂
                          RejectedExecutionHandler handler // 拒绝策略) {
}

private final AtomicInteger ctl = new AtomicInteger(ctlOf(RUNNING, 0));
// 29（32-3）
private static final int COUNT_BITS = Integer.SIZE - 3;
// 允许的最大工作线程（2^29-1 约5亿）
private static final int CAPACITY   = (1 << COUNT_BITS) - 1;

// 运行状态。线程池接受并处理新任务
private static final int RUNNING    = -1 << COUNT_BITS;
// 关闭状态。线程池不能接受新任务，处理完剩余任务后关闭。调用shutdown()方法会进入该状态。
private static final int SHUTDOWN   =  0 << COUNT_BITS;
// 停止状态。线程池不能接受新任务，并且尝试中断旧任务。调用shutdownNow()方法会进入该状态。
private static final int STOP       =  1 << COUNT_BITS;
// 整理状态。由关闭状态转变，线程池任务队列为空时进入该状态，会调用terminated()方法。
private static final int TIDYING    =  2 << COUNT_BITS;
// 终止状态。terminated()方法执行完毕后进入该状态，线程池彻底停止。
private static final int TERMINATED =  3 << COUNT_BITS;

private static boolean isRunning(int c) {
    return c < SHUTDOWN;
}

// 根据当前运行状态和工作线程数获取当前的 ctl
private static int ctlOf(int rs, int wc) { return rs | wc; }
// 获取运行状态
private static int runStateOf(int c)     { return c & ~CAPACITY; }
// 获取工作线程数
private static int workerCountOf(int c)  { return c & CAPACITY; }

private boolean compareAndIncrementWorkerCount(int expect) {
    // 通过 CAS 递增 ctl
    return ctl.compareAndSet(expect, expect + 1);
}

private void advanceRunState(int targetState) {
        for (;;) {
            int c = ctl.get();
            if (runStateAtLeast(c, targetState) ||       
          // 通过 CAS 改变 ctl
                ctl.compareAndSet(c, ctlOf(targetState, workerCountOf(c))))
                break;
        }
    }

public void execute(Runnable command) {
    if (command == null)
        throw new NullPointerException();
    int c = ctl.get();
    
    // 1.当前工作线程数小于核心线程数，启动新线程
    if (workerCountOf(c) < corePoolSize) {
        // 添加任务
        if (addWorker(command, true))
            return;
        c = ctl.get();
    }
    
    // 2. 当前工作线程数大于核心线程数，但是未大于最大线程数，尝试添加到工作队列
    if (isRunning(c) && workQueue.offer(command)) {
        int recheck = ctl.get();
        // 如果当前线程处于非运行态，并且移除当前任务成功，则拒绝任务（防止添加到一半就shutdown）
        if (! isRunning(recheck) && remove(command)) 
            reject(command);
        // 如果当前没有工作线程了，就启动新线程
        else if (workerCountOf(recheck) == 0)
            addWorker(null, false);
    }
    
    // 3.当前线程池核心线程和队列都满了，尝试创建新非核心线程
    else if (!addWorker(command, false))
        // 4.线程池彻底满了，执行拒绝策略
        reject(command);
}

private boolean addWorker(Runnable firstTask, boolean core) {
    retry:
    // 1.改变 ctl 使工作线程+1
    for (;;) {
        int c = ctl.get();
        int rs = runStateOf(c);

        // 如果当前不处于运行状态，传入任务为空，并且任务队列为空的时候拒绝添加新任务
        // 即线程池 shutdown 时不让添加新任务，但是运行继续跑完任务队列里的任务。
        if (rs >= SHUTDOWN &&
            ! (rs == SHUTDOWN &&
               firstTask == null &&
               ! workQueue.isEmpty()))
            return false;

        for (;;) {
            int wc = workerCountOf(c);
            // 线程不允许超过最大线程数，核心线程不允许超过最大核心线程数
            if (wc >= CAPACITY ||
                wc >= (core ? corePoolSize : maximumPoolSize))
                return false;
            // CAS 递增工作线程数
            if (compareAndIncrementWorkerCount(c))
                // 失败了就重新回到上面的retry处继续往下执行
                break retry;
            // 更新 ctl
            c = ctl.get();
            // 如果运行状态改变了就全部从来
            if (runStateOf(c) != rs)
                continue retry;
        }
    }

    // 2.启动新线程
    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());
      
                // 如果线程池处于运行状态，或者没有新任务的SHUTDOWN状态（即SHUTDOW以后还在消费工作队列里的任务） 
                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;
}

private final class Worker
        extends AbstractQueuedSynchronizer
        implements Runnable
    {

        // 工作线程
        final Thread thread;
    
        // 要执行的任务
        Runnable firstTask;
    
        // 线程执行过的任务数
        volatile long completedTasks;

        // 通过线程工厂创建工作线程
        Worker(Runnable firstTask) {
            setState(-1);
            this.firstTask = firstTask;
            this.thread = getThreadFactory().newThread(this);
        }

        // 执行任务
        public void run() {
            runWorker(this);
        }
    
     ... ...
    }

private final HashSet workers = new HashSet();

final void runWorker(Worker w) {
    Thread wt = Thread.currentThread();
    Runnable task = w.firstTask;
    w.firstTask = null;
    w.unlock(); // 新创建的Worker默认state为-1，AQS的unlock方法会将其改为0，此后允许使用interruptIfStarted()方法进行中断
    
    // 完成任务以后是否需要移除当前Worker，即当前任务是否意外退出
    boolean completedAbruptly = true;
    
    try {
        // 循环获取任务
        while (task != null || (task = getTask()) != null) {
            // 加锁，防止 shundown 时中断正在运行的任务
            w.lock();
            // 如果线程池状态为 STOP 或更后面的状态，中断线程任务
            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 {
        // 根据completedAbruptly决定是否要移除意外退出的Worker，并补充新的Worker
        // 也就是说，如果上述过程顺利完成，工作线程没有挂掉，就不删除，下次继续用，否则就干掉它再补充一个。
        processWorkerExit(w, completedAbruptly);
    }
}

private Runnable getTask() {
    boolean timedOut = false; // Did the last poll() time out?

    for (;;) {
        int c = ctl.get();
        int rs = runStateOf(c);

        // Check if queue empty only if necessary.
        // 如果线程池关闭了，并且工作队列里的任务都完成了，或者线程池直接进入了 STOP 或更进一步的状态，就不返回新任务
        if (rs >= SHUTDOWN && (rs >= STOP || workQueue.isEmpty())) {
            decrementWorkerCount();
            return null;
        }

        // 获取当前工作线程
        int wc = workerCountOf(c);

        // 核心线程是否超时（默认false）或当前是否存在非核心线程，即判断当前当前是否需要进行超时控制
        boolean timed = allowCoreThreadTimeOut || wc > corePoolSize;

        // 判断线程是否超过最大线程数或存在非核心线程
        if ((wc > maximumPoolSize || (timed && timedOut))
            // 并且除非任务队列为空，否则池中最少有一个线程
            && (wc > 1 || workQueue.isEmpty())) {
            if (compareAndDecrementWorkerCount(c))
                return null;
            continue;
        }

        try {
            // 获取任务
            Runnable r = timed ?
                // 阻塞 keepaliveTime 以获取任务，如果在 keepaliveTime 时间内没有获取到任务，则返回 null.
                workQueue.poll(keepAliveTime, TimeUnit.NANOSECONDS) :
                workQueue.take();
            if (r != null)
                return r;
            // 如果获取不到任务，说明非核心线程超时了，下一轮判断确认是否退出循环。
            timedOut = true;
        } catch (InterruptedException retry) {
            timedOut = false;
        }
    }
}

public void shutdown() {
    final ReentrantLock mainLock = this.mainLock;
    // 加锁
    mainLock.lock();
    try {
        checkShutdownAccess();
        // 改变当前线程池状态
        advanceRunState(SHUTDOWN);
        // 中断当前线程
        interruptIdleWorkers();
        // 钩子函数，默认空实现
        onShutdown(); // hook for ScheduledThreadPoolExecutor
    } finally {
        mainLock.unlock();
    }
    tryTerminate();
}

private void interruptIdleWorkers(boolean onlyOne) {
    final ReentrantLock mainLock = this.mainLock;
    mainLock.lock();
    try {
        // 遍历工作队列中的全部 Worker
        for (Worker w : workers) {
            Thread t = w.thread;
            if (!t.isInterrupted() && w.tryLock()) {
                try {
                    // 标记为中断
                    t.interrupt();
                } catch (SecurityException ignore) {
                } finally {
                    w.unlock();
                }
            }
            if (onlyOne)
                break;
        }
    } finally {
        mainLock.unlock();
    }
}

public List shutdownNow() {
    List tasks;
    final ReentrantLock mainLock = this.mainLock;
    mainLock.lock();
    try {
        checkShutdownAccess();
        // 改变当前线程池状态
        advanceRunState(STOP);
        // 中断当前线程
        interruptWorkers();
        // 删除任务队列中的任务
        tasks = drainQueue();
    } finally {
        mainLock.unlock();
    }
    tryTerminate();
    return tasks;
}

final void reject(Runnable command) {
    handler.rejectedExecution(command, this);
}

throw new RejectedExecutionException("Task " + r.toString() +
                                     " rejected from " +
                                     e.toString());

public void rejectedExecution(Runnable r, ThreadPoolExecutor e) {
    if (!e.isShutdown()) {
        r.run();
    }
}

public void rejectedExecution(Runnable r, ThreadPoolExecutor e) {
    if (!e.isShutdown()) {
        // 弹出队头元素
        e.getQueue().poll();
        e.execute(r);
    }
}

public void rejectedExecution(Runnable r, ThreadPoolExecutor e) {
 // Does nothing
}