知识图谱整理之Java基础ThreadPoolExecutor

ThreadPoolExecutor介绍

ThreadPoolExecutor是一个管理线程的一个类，可以有效的复用和控制线程。之前比较好奇，像这样的池化技术是如何实现的，今天我们就来一起探究下。本文是在JDK8的源码下进行阅读的，由于是自己总结，所以太过基础的东西不做赘述。

ThreadPoolExecutor源码解析

构造方法

我们先从构造方法开始入手来了解这个类，初学者也都是从了解构造方法中参数含义来开始了解的。

 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.corePoolSize = corePoolSize;
        this.maximumPoolSize = maximumPoolSize;
        this.workQueue = workQueue;
        this.keepAliveTime = unit.toNanos(keepAliveTime);
        this.threadFactory = threadFactory;
        this.handler = handler;
    }

• 我们可能知道阿里规范的话，让我们直接自己使用构造函数定义ThreadPoolExecutor，目的就是清晰展示线程池的参数，防止线程池出现问题，比如内存溢出。
• corePoolSize代表核心线程数
• maximumPoolSize代表最大线程数
• keepAliveTime代表空闲线程最大存活时间
• unit代表时间单位
• workQueue代表任务存储队列
• threadFactory代表线程工厂
• handler代表任务拒绝策略

成员变量ctl介绍

先来看下源码：

 private final AtomicInteger ctl = new AtomicInteger(ctlOf(RUNNING, 0));
    private static final int COUNT_BITS = Integer.SIZE - 3;
    private static final int CAPACITY   = (1 << COUNT_BITS) - 1;

    // runState is stored in the high-order bits
    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;

    // Packing and unpacking ctl
    private static int runStateOf(int c)     { return c & ~CAPACITY; }
    private static int workerCountOf(int c)  { return c & CAPACITY; }
    private static int ctlOf(int rs, int wc) { return rs | wc; }

这里截取一篇文章的介绍：

COUNT_BITS表示ctl变量中表示有效线程数量的位数，这里COUNT_BITS=29；
CAPACITY表示最大有效线程数，根据位运算得出COUNT_MASK=11111111111111111111111111111，这算成十进制大约是5亿，在设计之初就已经想到不会开启超过5亿条线程，所以完全够用了；
线程池状态的位运算得到以下值：
RUNNING：高三位值111
SHUTDOWN：高三位值000
STOP：高三位值001
TIDYING：高三位值010
TERMINATED：高三位值011
在多线程的环境下，运行状态和有效线程数量往往需要保证统一，不能出现一个改而另一个没有改的情况，如果将他们放在同一个AtomicInteger中，利用AtomicInteger的原子操作，就可以保证这两个值始终是统一的。

• 这里有点疑惑的可能是runStateOf、workerCountOf三个方法
• runStateOf其实是截取高三位，代表线程池状态
• workerCountOf是低29位，代表线程个数

execute和submit方法源码

介绍完一些参数后，我们来看看是如何运行的，这里先看下submit方法源码：

    public <T> Future<T> submit(Callable<T> task) {
        if (task == null) throw new NullPointerException();
        RunnableFuture<T> ftask = newTaskFor(task);
        execute(ftask);
        return ftask;
    }

• 这里就是比对execute方法会有值返回，我们不做深究，直接来看execute方法源码

    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);
    }

• 运行逻辑是，如果传入线程为null，直接抛出异常，之后再判断工作线程是否小于corePoolSize，然后就是addWorker方法，关于这个方法源码我们之后解析
• 如果大于等于corePoolSize，就会在workQueue也就是构造函数中传入的阻塞队列中添加，如果成功，下面一些判断条件主要是防御性检查
• 最后如果没添加进workQueue中，会再次尝试addWorker，不过这是针对的是maximumPoolSize，不行也会直接拒绝
• 这里涉及到的addWorker、reject源码我们稍后来看

reject方法源码

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

• 这里比较简单，就是调用拒绝策略，不做过多分析

addWorker方法源码

private boolean addWorker(Runnable firstTask, boolean core) {
		//<1>
        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;
                // else CAS failed due to workerCount change; retry inner loop
            }
        }
		//<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 {
                    // 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) {
                    t.start();
                    workerStarted = true;
                }
            }
        } finally {
            if (! workerStarted)
                addWorkerFailed(w);
        }
        return workerStarted;
    }

• 第<1>块内容，主要是针对ctl加一，来代表工作线程数量
• 其中的core参数是来决定是否是核心线程
• 第<2>块内容是真实添加Worker，首先会创建Worker，其次拿出worker中的Thread，注意，这里的Thread不是我们初始化Worker中的firstTask，具体我们等下来看，然后会把创建的worker加到workers中，最后启动线程
• 这里会有疑问，那线程池是如何控制的呢？答案我们进入Worker来寻找

Worker内部类源码

这里我们只截取部分源码帮助我们理解即可，若后续有展开，我们继续分析：

private final class Worker
        extends AbstractQueuedSynchronizer
        implements Runnable
    {
        /**
         * This class will never be serialized, but we provide a
         * serialVersionUID to suppress a javac warning.
         */
        private static final long serialVersionUID = 6138294804551838833L;

        /** Thread this worker is running in.  Null if factory fails. */
        final Thread thread;
        /** Initial task to run.  Possibly null. */
        Runnable firstTask;
        /** Per-thread task counter */
        volatile long completedTasks;

        /**
         * Creates with given first task and thread from ThreadFactory.
         * @param firstTask the first task (null if none)
         */
        Worker(Runnable firstTask) {
            setState(-1); // inhibit interrupts until runWorker
            this.firstTask = firstTask;
            this.thread = getThreadFactory().newThread(this);
        }

        /** Delegates main run loop to outer runWorker  */
        public void run() {
            runWorker(this);
   
        }
        ...
   }

• 这里看到我们运行的线程是通过传入的threadFactory来创建的
• 运行这个线程，我们来看下run方法实际是跑了runWorker方法，我们接下来看下源码

runWorker方法源码

final void runWorker(Worker w) {
        Thread wt = Thread.currentThread();
        Runnable task = w.firstTask;
        w.firstTask = null;
        w.unlock(); // allow interrupts
        boolean completedAbruptly = true;
        try {
            while (task != null || (task = getTask()) != null) {
                w.lock();
                // If pool is stopping, ensure thread is interrupted;
                // if not, ensure thread is not interrupted.  This
                // requires a recheck in second case to deal with
                // shutdownNow race while clearing interrupt
                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);
        }
    }

• 这里主要的逻辑就是while不断循环，然后通过getTask方法去取相应任务，持续运行，如果取到的task为null，则会结束线程。注意这里的task在调用run方法之后会直接设置为null，代表清除，那么重要的就是getTask是怎么控制任务的了，我们来看下

getTask方法源码

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.
            if (rs >= SHUTDOWN && (rs >= STOP || workQueue.isEmpty())) {
                decrementWorkerCount();
                return null;
            }

            int wc = workerCountOf(c);

            // Are workers subject to culling?
            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;
            }
        }
    }

• 前面一堆，是用来检查线程池状态的，之后有一段很关键的代码，是来控制核心线程和其它线程区别的boolean timed = allowCoreThreadTimeOut || wc > corePoolSize;，这段代码的意思是如果大于核心线程，则为true，具体作用我们往下看
• 在Runnable r = timed ? workQueue.poll(keepAliveTime, TimeUnit.NANOSECONDS) : workQueue.take();中我们可以看到这里我们是通过阻塞队列来分别的，如果是核心线程，我们会通过阻塞队列的task方法阻塞着，如果不是则通过poll定时，超时空闲时间没有取到任务则代表是空闲的，返回timedOut = true;
• 这时再看上面一段代码逻辑((wc > maximumPoolSize || (timed && timedOut)) && (wc > 1 || workQueue.isEmpty()))会返回true，则方法最终会返回null，最终也会结束外层的线程。

个人总结

源码看的差不多了，到了总结环节，毕竟不是为了看源码而看源码，那么ThreadPoolExecutor是如何协同运作的呢？

个人认为主要还是通过Worker这个内部类来进行协作的，我们可以理解线程池执行的线程内存，其实可以理解为传入了一个执行方法而已，并且都有一个实现类，这时其实传入的线程实现类本身的线程意义就没有了，其实就是一个方法，线程的话是通过线程池的内部属性。然后具体的管控任务，空闲线程的回收，是通过阻塞队列的take和poll超时方法来控制的。大概线程池遇到对的问题就这些，如果有大家有其他问题，也欢迎交流。

今日知识图谱：