线程池异常信息统一处理，从线程异常信息丢失说起

异常信息作为我们平时定位问题的一大法宝，其重要性是不言而喻的。一段代码出现了问题，如果它的异常信息被吃了，那么一个本来很简单的问题，定位起来也会变的很麻烦。
今天我们就从异常信息被吃掉，导致相应信息没有输出到日志的问题说起。

一个简单的例子

首先我们看看如下的代码：

public class ThreadLogTestApplication {

    public static void main(String[] args) {
        ThreadPoolExecutor pool = new ThreadPoolExecutor(1,
                1, 1000, TimeUnit.SECONDS, new LinkedBlockingQueue<Runnable>());
        Runnable runnable = new Runnable() {
            public void run() {
                System.out.println("Do thread work!");
                throw new RuntimeException("Test Message!");
            }
        };
        pool.execute(runnable);
        pool.submit(runnable);
        pool.shutdown();
    }
}

这段代码非常的简单，创建一个线程池，实现一个Runnable，然后通过两种不同方式来执行这个它。代码很简单，那么它的运行结果是怎么样的呢？
下图就是这段代码的执行输出：

从结果可以发现，通过execute执行是可以正常输出出错堆栈的。而通过submit的方式执行异常信息不见了，这是为什么呢？

submit方法执行时异常信息为什么消失了

要想了解为什么submit执行的线程异常信息为什么消失了，就需要进一步分析它的源码：

public Future<?> submit(Runnable task) {
    if (task == null) throw new NullPointerException();
    RunnableFuture<Void> ftask = newTaskFor(task, null);
    execute(ftask);
    return ftask;
}

从小段源码我们就可以知道submit和execute的区别了，submit会把参数中的Runnable通过RunnableFuture封装一层后再调用execute，所以很明显这个异常信息是被这个Future吃掉的了。

Future是如何吃掉异常信息的

进一步查看代码，我们可以知道submit方法创建的Future实际类型是FutureTask，下面就是它最为核心的run方法源码：

public void run() {
    // ...
    try {
        Callable<V> c = callable;
        if (c != null && state == NEW) {
            V result;
            boolean ran;
            try {
                result = c.call();
                ran = true;
            } catch (Throwable ex) {
                result = null;
                ran = false;
                setException(ex);
            }
            if (ran)
                set(result);
        }
    } finally {
      // ...
    }
}
protected void setException(Throwable t) {
    if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
        outcome = t;
        UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // final state
        finishCompletion();
    }
}

从这段代码可以发现，线程执行时抛出的任何异常信息（catch的是Throwable，所以连OOM都会被catch掉）都会被catch并通过setException保存为执行结果。
所以submit提交的线程任务执行的异常信息是不会直接抛出的，而是作为结果保存在返回的Future中，当我们调用Future.get方法的时候异常就会被抛出。由于run方法返回值类型是void的，所以Future中保存的一般都是异常信息。

如何拿到submit提交的线程任务的异常信息

上面分析了submit提交会生成Future，并且异常信息是作为结果保存在Future中的，所以想要拿到submit提交的线程任务的异常信息也就非常的简单了。

public class ThreadLogTestApplication {

    public static void main(String[] args) {
        ThreadPoolExecutor pool = new ThreadPoolExecutor(1,
                1, 1000, TimeUnit.SECONDS, new LinkedBlockingQueue<Runnable>());
        Runnable runnable = new Runnable() {
            public void run() {
                System.out.println("Do thread work!");
                throw new RuntimeException("Test Message!");
            }
        };
        pool.execute(runnable);
        Future future = pool.submit(runnable);
        try {
            future.get();
        }
        catch (Exception e){
            e.printStackTrace();
        }
        pool.shutdown();
    }
}

通过上面的分析，我们已经清楚了submit方式和execute方式的异常信息的处理方法。但是还有一个问题：这两种提交方式的异常信息处理方式是不一样的，那么有没有办法实现统一呢？办法肯定是有的！

通过统一Runnable父类实现异常信息的统一处理

我们可以实现一个统一的Runnable父类，重写父类的run方法，定义一个running方法，然后run中通过try-catch包裹调用running方法，就能够抓取全部的异常信息，从而不向上抛异常，并且能够统一处理这些异常信息。实现代码如下：

public abstract class CustomRunnable implements Runnable{

    public final void run() {
        try{
            this.running();
        }
        catch (Exception e){
            e.printStackTrace();
        }
    }

    public abstract void running();
}

通过自定义的线程池来对异常信息进行统一的处理。

通过查看线程池run方法相关的源码我们可以发现，每次执行完线程任务后都会调用afterExecute方法，如下面的代码所示：

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

所以我们可以通过继承线程池类来重写这个afterExecute方法，从而达到异常信息的统一处理。实现如下所示：

@Override
protected void afterExecute(Runnable r, Throwable t) {
    super.afterExecute(r, t);
    if(t != null){
        t.printStackTrace();
    }
    if(r instanceof Future){
        Future f = (Future)r;
        try{
            f.get();
        }
        catch (Exception e){
            e.printStackTrace();
        }
    }
}

扫码关注
头条号：　　微信公众号：