【JUC进阶】如何优雅地处理线程池异常？

忘是亡心i 2024-03-25 03:40 119阅读 0赞

#### 文章目录 ####

*  1. 线程池异常的出现
 *  2. 如何获取和处理异常
 *   *  2.1 使用try-catch
     *  2.2 使用Thread.setDefaultUncaughtExceptionHandler方法捕获异常
     *   *  2.2.1 submit和execute源码分析
     *  2.3 重写afterExecute进行异常处理

## 1. 线程池异常的出现 ##

在开发中，我们经常使用线程池，会将不同的任务提交到线程池中，但是如果任务出现了异常，会发生什么呢？该怎么处理呢？怎么获取到异常信息来解决异常？

想要知道如何解决，就需要了解了解线程池提交任务的两个方法`execute`与`submit`

void execute(Runnable command);
    Future<?> submit(Runnable task);

由源码可见，两个任务最本质的区别就是`execute`无返回值，而`submit`由返回值。

接着用两个方法提交一个会抛出异常的任务看看发生什么？

public class Test {
        
        public static void main(String[] args) throws InterruptedException {
        
    
            //创建一个线程池
            ExecutorService executorService= Executors.newFixedThreadPool(1);
    
            //使用submit提交任务
            executorService.submit(new task());
    
            //使用execute提交任务
            executorService.execute(new task());
    
        }
    
    
    }
    // 会抛出异常的任务
    class task implements Runnable {
        
        @Override
        public void run() {
        
            System.out.println("进入了task方法！！！");
            int i = 1 / 0;
        }
    }

![image-20230319142626880][]

由输出结果可见

1.  **当线程池抛出异常后 submit无提示，其他线程继续执行**
2.  **当线程池抛出异常后 execute抛出异常，其他线程继续执行新任务**

当`submit`提交任务时，即使任务出现异常也不会打印异常信息，这是不友好的，这样开发者就不知道程序是否有异常。

其实，`submit`方法是将异常信息封装到其类型为`Future<?>`的返回值中去了，想要获取异常信息，就必须使用`get()`方法

public static void main(String[] args) throws InterruptedException, ExecutionException {
        
    
        //创建一个线程池
        ExecutorService executorService= Executors.newFixedThreadPool(1);
    
        //使用submit提交任务
        Future<?> submit = executorService.submit(new task());
        submit.get();
    
        //使用execute提交任务
        executorService.execute(new task());
    
    }

![image-20230319143438770][]

--------------------

## 2. 如何获取和处理异常 ##

--------------------

### 2.1 使用try-catch ###

在任务中可能出现异常的地方使用try-catch捕获异常，然后抛出。

class task implements Runnable {
        
        @Override
        public void run() {
        
            System.out.println("进入了task方法！！！");
            try {
        
                int i = 1 / 0;
            }catch (Exception e){
        
                e.printStackTrace();
            }
        }
    }

![image-20230319143851527][]

--------------------

### 2.2 使用Thread.setDefaultUncaughtExceptionHandler方法捕获异常 ###

`java.lang.Thread.setDefaultUncaughtExceptionHandler()`方法设置处理程序时调用线程突然终止默认由于未捕获到异常，并没有其他的处理程序被定义为该线程。

public static void setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler eh) {
        
        SecurityManager sm = System.getSecurityManager();
        if (sm != null) {
        
            sm.checkPermission(
                new RuntimePermission("setDefaultUncaughtExceptionHandler")
                    );
        }
    
         defaultUncaughtExceptionHandler = eh;
     }

内部的`uncaughtException`是一个处理线程内发生的异常的方法，参数为线程对象t和异常对象e。

![image-20230319144448284][]

因此，可以自己实现一个线程工厂，为每一个线程创建的线程设置`UncaughtExceptionHandler`对象 里面实现异常的默认逻辑。

public class Test {
        
        public static void main(String[] args) throws InterruptedException, ExecutionException {
        
    
            //1.实现一个自己的线程池工厂
            ThreadFactory factory = (Runnable r) -> {
        
                //创建一个线程
                Thread t = new Thread(r);
                //给创建的线程设置UncaughtExceptionHandler对象 里面实现异常的默认逻辑
                t.setDefaultUncaughtExceptionHandler((Thread thread1, Throwable e) -> {
        
                    //出现异常
                    if (e != null){
        
                        e.printStackTrace();
                    }
                });
                return t;
            };
    
            //2.创建一个自己定义的线程池，使用自己定义的线程工厂
            ExecutorService executorService = new ThreadPoolExecutor(
                    1,
                    1,
                    0,
                    TimeUnit.MILLISECONDS,
                    new LinkedBlockingQueue(10),
                    factory);
    
            // submit
            Future<?> submit = executorService.submit(new task());
            submit.get();
    
            Thread.sleep(1000);
            System.out.println("==================为检验打印结果，1秒后执行execute方法");
    
            // execute
            executorService.execute(new task());
    
        }
    
    }

![image-20230319145133900][]

这里使用`submit`提交任务时，控制台打印的异常信息，其实是因为`submit.get();`，如果没有调用`get`方法，控制台只会打印一条异常信息，也就是`execute`出现异常时候而打印的异常信息。

**那么，就说明了`submit`的返回值内部存有异常信息，那么为什么使用`submit`提交的任务出现异常的时候，没有打印异常信息呢？**

**其实是因为`submit`方法内部已经捕获了异常， 只是没有打印出来，也因为异常已经被捕获，因此`jvm`也就不会去调用`Thread`的`UncaughtExceptionHandler`去处理异常。**

这需要结合submit和execute的源码分析

--------------------

#### 2.2.1 submit和execute源码分析 ####

在`submit`源码中，可以看见，其实底层也是调用了`execute`方法，只是比`execute`封装多了一层`RunnableFuture`，而这个`RunnableFuture`就是`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`中，当任务数量少于核心线程数的时候，会调用`addWorker(command, true)`为每个任务创建一个`Worker`去处理这些线程

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

这个`Worker`也是一个线程，执行任务时调用的就是`Worker`的`run`方法！run方法内部又调用了`runworker`方法！：

private boolean addWorker(Runnable firstTask, boolean core) {
        
    		.......
                ......
                Worker w = null;
        try {
        
            w = new Worker(firstTask);
            final Thread t = w.thread;
                	......
    }
    
    public void run() {
        
        runWorker(this);
    }

**可见，当使用`execute`提交任务的时候，会被封装成了一个`runable`任务，然后进去 再被封装成一个`Worker`,最后在`worker`的`run`方法里面调用`runWoker`方法，`runWoker`方法里面执行任务任务。**

在`runWorker`中，执行线程任务的是`task.run();`了

如果任务出现异常，用`try-catch`捕获异常往外面抛，我们在最外层使用`try-catch`捕获到了 `runWoker`方法中抛出的异常。**因此我们在execute中看到了我们的任务的异常信息。**

final void runWorker(Worker w) {
        
         Thread wt = Thread.currentThread();
         Runnable task = w.firstTask;
         w.firstTask = null;
         w.unlock(); // allow interrupts
         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 {
        
                      //执行线程
                         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 {
        
                      //execute的方式可以重写此方法处理异常
                         afterExecute(task, thrown);
                     }
                 } finally {
        
                     task = null;
                     w.completedTasks++;
                     w.unlock();
                 }
             }
             //出现异常时completedAbruptly不会被修改为false
             completedAbruptly = false;
         } finally {
        
          //如果如果completedAbruptly值为true，则出现异常，则添加新的Worker处理后边的线程
             processWorkerExit(w, completedAbruptly);
         }
     }

而`submit`方法t是将任务封装成了一个`futureTask`，然后这个`futureTask`被封装`worker`成，在`woker`的`run`方法里面，最终调用的是`futureTask`的`run`方法，而在`run`方法里面，将异常吞掉了，并没有抛出异常，因此在`worker`的`runWorker`方法里面无法捕获到异常。

public void run() {
        
         if (state != NEW ||
             !UNSAFE.compareAndSwapObject(this, runnerOffset,
                                          null, Thread.currentThread()))
             return;
         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);
             }
             //省略下文
     。。。。。。

在`run`方法中，如果出现了异常，不会将异常往外抛，则是将异常设置给`outcome`

protected void setException(Throwable t) {
        
           if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
        
            //将异常对象赋予outcome，记住这个outcome，
               outcome = t;
               UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // final state
               finishCompletion();
           }

在`submit`方法返回值对象`Future`中，当调用`Future.get()`时， 会调用内部的`report`方法

public V get() throws InterruptedException, ExecutionException {
        
        int s = state;
        if (s <= COMPLETING)
            s = awaitDone(false, 0L);
        //注意这个方法
        return report(s);
    }

在`report`中返回值实际上就是上面的`outcome`

private V report(int s) throws ExecutionException {
        
     //设置`outcome`
        Object x = outcome;
        if (s == NORMAL)
         //返回`outcome`
            return (V)x;
        if (s >= CANCELLED)
            throw new CancellationException();
        throw new ExecutionException((Throwable)x);
    }

因此，在使用`submit`方法提交任务时候，任务对象`Runable`会被封装程`Future`类型。

`future` 里面的 `run`方法在处理异常时， `try-catch`了所有的异常，通过`setException(ex);`方法设置到了变量`outcome`里面， 可以通过`future.get`获取到`outcome`。

**在`submit`里面，除了从返回结果里面取到异常之外, 没有其他方法。因此，在不需要返回结果的情况下，最好用`execute`，这样就算没有写`try-catch`，疏漏了异常捕捉，也不至于丢掉异常信息。**

--------------------

### 2.3 重写afterExecute进行异常处理 ###

在`excute`的方法里面，可以通过重写`afterExecute`进行异常处理，当然也适用于`submit`，但是因为`submit`的方式比较麻烦，`submit`的`task.run`里面把异常吞了，根本不会跑出来异常，因此也不会有异常进入到`afterExecute`里面。

在`runWorker`里面，调用`task.run`之后，会调用线程池的 `afterExecute(task, thrown)`方法。

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 ((runStateAtLeast(ctl.get(), STOP) ||
                         (Thread.interrupted() &&
                          runStateAtLeast(ctl.get(), STOP))) &&
                        !wt.isInterrupted())
                        wt.interrupt();
                    try {
        
                        beforeExecute(wt, task);
                        Throwable thrown = null;
                        try {
        
                        //直接就调用了task的run方法 
                            task.run(); //如果是futuretask的run,里面是吞掉了异常，不会有异常抛出，
                           // 因此Throwable thrown = null;  也不会进入到catch里面
                        } 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和异常
                            afterExecute(task, thrown);
                        }
                    } finally {
        
                        task = null;
                        w.completedTasks++;
                        w.unlock();
                    }
                }
                completedAbruptly = false;
            } finally {
        
                processWorkerExit(w, completedAbruptly);
            }
        }

因此，我们在创建线程池的时候可以重写`afterExecute`方法

但是对于`afterExecute`处理`submit`提交的异常的时候，需要进行额外的处理，也就是判断`Throwable`是否是`FutureTask`

public class Test {
        
        public static void main(String[] args) throws InterruptedException, ExecutionException {
        
    
    
            //1.创建一个自己定义的线程池
            ExecutorService executorService = new ThreadPoolExecutor(
                    2,
                    3,
                    0,
                    TimeUnit.MILLISECONDS,
                    new LinkedBlockingQueue(10)
            ) {
        
                //重写afterExecute方法
                @Override
                protected void afterExecute(Runnable r, Throwable t) {
        
                    //这个是excute提交的时候
                    if (t != null) {
        
                        System.out.println("afterExecute里面获取到excute提交的异常信息，处理异常" + t.getMessage());
                    }
                    //如果r的实际类型是FutureTask 那么是submit提交的，所以可以在里面get到异常
                    if (r instanceof FutureTask) {
        
                        try {
        
                            Future<?> future = (Future<?>) r;
                            //get获取异常
                            future.get();
    
                        } catch (Exception e) {
        
                            System.out.println("afterExecute里面获取到submit提交的异常信息，处理异常" + e);
                        }
                    }
                }
            };
            //当线程池抛出异常后 execute
            executorService.execute(new task3());
    
            //当线程池抛出异常后 submit
            executorService.submit(new task3());
        }
    }
    
    class task3 implements Runnable {
        
        @Override
        public void run() {
        
            System.out.println("进入了task方法！！！");
            int i = 1 / 0;
        }
    }

![image-20230319161241336][]

--------------------

> 参考：[面试官：线程池中线程抛了异常，该如何处理？\_Java精选的技术博客\_51CTO博客][Java_51CTO]

[image-20230319142626880]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/2fa2d2e616ed4bc09f20758c797d6bbb.png
[image-20230319143438770]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/42d0014be15f4d948dca3b0fbe1a7522.png
[image-20230319143851527]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/1bc03c49f3ab4748a3fa6873629a911f.png
[image-20230319144448284]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/c09835472ce64a4eac1225b4c4b2573d.png
[image-20230319145133900]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/0e472e688e4348f7b14e00210f8bf108.png
[image-20230319161241336]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/9f5b7bde8fbb4164a7d77f88307abf03.png
[Java_51CTO]: https://blog.51cto.com/u_15191078/5788158