JUC之ThreadPoolExecutor（2）方法介绍

学习本文内容前，建议先学习ThreadPoolExecutor的总体介绍，请戳《JUC之ThreadPoolExecutor（1）总体介绍》

---

█ Worker

在ThreadPoolExecutor线程池中，当任务被提交到线程池后，会被委托给一个Worker对象实际地去执行任务。正如在《JUC之ThreadPoolExecutor（1）总体介绍》中提到的那样，线程池中分了核心worker与临时工worker。以面向对象地角度去看的话，核心worker与临时工worker就对应着一个个Worker对象。每个Worker对象去执行被提交到线程池中的任务。

Worker类：

private final class Worker
    extends AbstractQueuedSynchronizer
    implements Runnable
{
    
    private static final long serialVersionUID = 6138294804551838833L;
    
    // 运行该Worker的线程
    // 因为Worker实现了Runnable接口，因此可以直接通过Thread去运行
    final Thread thread;
     
    // 该Worker所执行的第一个任务。在创建Worker对象的时候，
    // 会指定第一个任务。以后的任务都是从等待队列中去获取了。
    Runnable firstTask;
    
    // 该Worker总共执行完成的任务的数量
    volatile long completedTasks;
    
    // 构造器初始化相关字段
    Worker(Runnable firstTask) {
        setState(-1); // inhibit interrupts until runWorker
        this.firstTask = firstTask;
        this.thread = getThreadFactory().newThread(this);
    }
    
    // 当线程启动时，实际执行的方法
    public void run() {
        runWorker(this);
    }

    protected boolean isHeldExclusively() {
        return getState() != 0;
    }
    
    // 重写tryAcquire方法，依赖AQS提供的功能实现并发锁的逻辑
    protected boolean tryAcquire(int unused) {
        if (compareAndSetState(0, 1)) {
            setExclusiveOwnerThread(Thread.currentThread());
            return true;
        }
        return false;
    }

    protected boolean tryRelease(int unused) {
        setExclusiveOwnerThread(null);
        setState(0);
        return true;
    }

    public void lock()        { acquire(1); }
    public boolean tryLock()  { return tryAcquire(1); }
    public void unlock()      { release(1); }
    public boolean isLocked() { return isHeldExclusively(); }

    void interruptIfStarted() {
        Thread t;
        if (getState() >= 0 && (t = thread) != null && !t.isInterrupted()) {
            try {
                t.interrupt();
            } catch (SecurityException ignore) {
            }
        }
    }
}

从上面Worker类的实现来看，Worker类继承了AbstractQueuedSynchronizer，借助AQS同步器提供的功能来实现多线程并发安全。并且Worker还实现了Runnable接口，所以Worker对象可以直接被Thread运行。（关于AbstractQueuedSynchronizer的介绍，请戳《JUC之AbstractQueuedSynchronizer基本介绍》）

①在Worker中维护了一个thread对象，用来指定要运行Worker对象的线程。因此一个Worker对象对应一个线程。

②因为Worker实现了Runnable接口，当将其作为线程运行的时候，会去执行其run方法。

public void run() {
    runWorker(this);
}

runWorker：

runWorker是ThreadPoolExecutor提供的方法，用来让Worker对象去执行被提交到线程池中的任务。

final void runWorker(Worker w) {
    // 获取当前线程，即Worker中thread对应的线程
    Thread wt = Thread.currentThread();
    // 获取第一个任务
    Runnable task = w.firstTask;
    w.firstTask = null;
    w.unlock();
    boolean completedAbruptly = true;
    try {
        // 当第一个任务不为空或者getTask也不为空，就执行该任务
        while (task != null || (task = getTask()) != null) {
            w.lock();
            if ((runStateAtLeast(ctl.get(), STOP) ||
                 (Thread.interrupted() &&
                  runStateAtLeast(ctl.get(), STOP))) &&
                !wt.isInterrupted())
                wt.interrupt();
            try {
                beforeExecute(wt, task);
                Throwable thrown = null;
                try {
                    // 执行提交的任务的run方法。
                    // 这里是同步运行的，即在Worker所对象的线程中去同步运行
                    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);
    }
}

while (task != null || (task = getTask()) != null) {}，task是Worker中的第一个任务，当第一个任务不为空即在创建Worker对象的时候执行了任务，那就去执行该任务。另外getTask不为空的时候，也去执行获取到的任务。getTask是去等待队列中获取任务，如果等待队列中存在正在等待执行的任务并且获取到了，那返回值不为空即为获取到的任务，那就执行该任务。当阻塞等待队列中一直有等待的任务的时候，(task = getTask()) != null条件是永远成立的。所以while循环是一直进入执行的，不会跳出。直到队列中没有元素可以取出了。

getTask：

去等待队列（BlockingQueue）中去获取正在等待被执行的任务。

private Runnable getTask() {
    boolean timedOut = false;

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

        // Check if queue empty only if necessary.
        if (rs >= SHUTDOWN && (rs >= STOP || workQueue.isEmpty())) {
            decrementWorkerCount();
            return null;
        }

        int wc = workerCountOf(c);

        boolean timed = allowCoreThreadTimeOut || wc > corePoolSize;

        if ((wc > maximumPoolSize || (timed && timedOut))
            && (wc > 1 || workQueue.isEmpty())) {
            if (compareAndDecrementWorkerCount(c))
                return null;
            continue;
        }

        try {
            Runnable r = timed ?
                workQueue.poll(keepAliveTime, TimeUnit.NANOSECONDS) :
                workQueue.take();
            if (r != null)
                return r;
            timedOut = true;
        } catch (InterruptedException retry) {
            timedOut = false;
        }
    }
}

上面的核心代码在于：Runnable r = timed ? workQueue.poll(keepAliveTime, TimeUnit.NANOSECONDS) : workQueue.take(); 当具有超时功能时，使用poll方法，否则使用take。poll和take都是从阻塞队列中获取队首的元素。（关于阻塞队列BlockingQueue的介绍，请戳《BlockingQueue初识》）

关于timed的值为true还是false，通过boolean timed = allowCoreThreadTimeOut || wc > corePoolSize;结果得出。allowCoreThreadTimeOut是设置是否允许核心Worker超时，该值可以通过allowCoreThreadTimeOut(boolean value)方法设置：

public void allowCoreThreadTimeOut(boolean value) {
    if (value && keepAliveTime <= 0)
        throw new IllegalArgumentException("Core threads must have nonzero keep alive times");
    if (value != allowCoreThreadTimeOut) {
        allowCoreThreadTimeOut = value;
        if (value)
            interruptIdleWorkers();
    }
}

---

█ workers

private final HashSet<Worker> workers = new HashSet<Worker>();

在ThreadPoolExecutor中维护了一个集合，用来存放所有创建的Worker对象。包含核心worker与临时工worker。

---

█ execute

execute方法是提交任务到线程池的入口。该方法的参数为Runnable类型，任务对象通过继承Runnable接口，重写run方法。这样被提交到线程池中的任务被委托给Worker对象后，在runWorker中通过调用Runable参数的run方法运行具体的逻辑。

在《JUC之ThreadPoolExecutor（1）总体介绍》中举了一个银行与用户的例子，在读execute方法源码的时候，可以结合这个例子去理解线程池运行的过程。

public void execute(Runnable command) {
    if (command == null)
        throw new NullPointerException();
    int c = ctl.get();
    // 核心worker的逻辑，先创建核心worker
    if (workerCountOf(c) < corePoolSize) {
        // 创建核心worker，并执行command
        if (addWorker(command, true))
            // 创建核心worker执行了后，直接返回，后面的逻辑就不要执行了
            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);
}

workerCountOf：

计算当前线程池中worker的数量。

①workerCountOf(c) < corePoolSize

当worker的数量还小于设置的核心worker数量时，新增核心Worker。这里的逻辑是先新增核心worker去执行任务。

addWorker：

创建Worker对象，并将任务绑定到创建的Worker上。第一个参数为被提交到线程池中的任务，第二个参数表示是否创建的worker为核心worker，true表示为核心worker，false为临时工worker。

private boolean addWorker(Runnable firstTask, boolean core) {
    retry:
    for (;;) {
        int c = ctl.get();
        int rs = runStateOf(c);

        // Check if queue empty only if necessary.
        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;
            if (compareAndIncrementWorkerCount(c))
                break retry;
            c = ctl.get();  // Re-read ctl
            if (runStateOf(c) != rs)
                continue retry;
        }
    }

    boolean workerStarted = false;
    boolean workerAdded = false;
    Worker w = null;
    try {
        // 创建Worker
        w = new Worker(firstTask);
        final Thread t = w.thread;
        if (t != null) {
            final ReentrantLock mainLock = this.mainLock;
            mainLock.lock();
            try {
                // Recheck while holding lock.
                // Back out on ThreadFactory failure or if
                // shut down before lock acquired.
                int rs = runStateOf(ctl.get());

                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) {
                // 启动线程，将会执行参数任务的Runable的run方法。
                t.start();
                workerStarted = true;
            }
        }
    } finally {
        if (! workerStarted)
            addWorkerFailed(w);
    }
    return workerStarted;
}

②if (isRunning(c) && workQueue.offer(command))

如果没有满足第一个if判断语句程序没有return出去的话，就需要进到第二个if条件判断了。什么时候是不满足第一个if条件判断语句的呢，就是当线程池中的核心worker数量已经达到了设置的corePoolSize大小了，此时就不能继续创建核心worker了，新提交进来的任务要被添加到等待队列中。offer方法将新提交的command添加到等待队列中。当阻塞队列BlockingQueue满了无法继续添加元素的时候，offer才会返回false。

③else if (!addWorker(command, false))

当无法继续向阻塞等待队列中插入元素的时候，workQueue.offer会返回false，此时是不满足上面的if条件判断语句的。进入else if条件语句，执行创建临时工worker来执行任务。

---

█ reject

执行拒绝策略。addWorker创建临时工worker执行任务失败，就会执行拒绝策略。

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

---

█ processWorkerExit

回收临时工worker。

在runWorker方法中当队列中没有了等待执行的元素时，会跳出while循环，此时会执行processWorkerExit方法。workers.remove方法会将临时工worker从集合中移除，等到GC的时候会被回收掉。

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;
        workers.remove(w);
    } finally {
        mainLock.unlock();
    }

    tryTerminate();

    int c = ctl.get();
    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);
    }
}