阅读异常堆栈信息的正确方式

迷南。 2023-01-13 08:51 232阅读 0赞

# 异常 #

### 文章目录 ###

*  异常
 *   *  一、Throwable类中的常用方法
     *   *  1. 四个构造方法
         *  2. getMessage
         *  3. toString
         *  4. getStackTrace
         *  5. printStackTrace
     *  二、异常演示

## 一、Throwable类中的常用方法 ##

### 1. 四个构造方法 ###

*  空参
    
        //构造一个将null作为其详细信息的Throwable对象
        public Throwable() { 
            
            //清空原来的栈内的trace信息，然后在当前的调用位置处重新建立trace信息
            fillInStackTrace();
        }
 *  String类型参数
    
        //构造一个带有详细信息的Throwable对象
        public Throwable(String message) { 
            
            //清空原来的栈内的trace信息，然后在当前的调用位置处重新建立trace信息
            fillInStackTrace();
            
            //将传递的String类型的参数赋值给detailMessage属性
            detailMessage = message;
        }
 *  Throwable类型参数
    
        //构造一个带有产生此异常原因的Throwable对象
        public Throwable(Throwable cause) { 
            
            //清空原来的栈内的trace信息，然后在当前的调用位置处重新建立trace信息
            fillInStackTrace();
            
            //将产生此异常原因的详细信息赋值给detailMessage
            detailMessage = (cause==null ? null : cause.toString());
            
            this.cause = cause;
        }
 *  String + Throwable类型参数
    
        //构造一个带有详细信息 + 产生此异常原因的Throwable对象
        public Throwable(String message, Throwable cause) { 
            
            //清空原来的栈内的trace信息，然后在当前的调用位置处重新建立trace信息
            fillInStackTrace();
            
            //参数message赋值给detailMessage属性
            detailMessage = message; 
            
            this.cause = cause;
        }

### 2. getMessage ###

*  获取此异常的详细信息

public String getMessage() { 
        return detailMessage;
    }

### 3. toString ###

*  返回带有异常类名的异常的详细信息

public String toString() { 
        
        //获取异常对应的类名
        String s = getClass().getName();
        
        //getLocalizedMessage调用了getMessage，返回的是异常的详细信息
        String message = getLocalizedMessage();
        
        return (message != null) ? (s + ": " + message) : s;
    }

### 4. getStackTrace ###

*  通过此方法获取StackTraceElement\[\]
 *  StackTraceElement表示StackTrace(堆栈轨迹)中的一个元素，属性包括方法调用者的类名、方法名、文件名以及调用的行数，其实就是异常堆栈的栈帧
    
        public final class StackTraceElement implements java.io.Serializable { 
        
            private String declaringClass;
            private String methodName;
            private String fileName;
            private int    lineNumber;
            
            //省略其余部分...
        }
 *  StackTraceElement数组包含了StackTrace(堆栈轨迹)的内容，通过遍历它可以得到方法间的调用过程

`getStackTrace()` 方法源码如下：

public StackTraceElement[] getStackTrace() { 
        
        //调用getOurStackTrace获得StackTraceElement[]
        return getOurStackTrace().clone();
    }

### 5. printStackTrace ###

*  将当前的Throwable对象的堆栈轨迹输出至错误流
 *  `printStackTrace()` 方法源码如下：
    
        public void printStackTrace() { 
            
            //调用带参的printStackTrace方法
            printStackTrace(System.err);
        }
 *  `printStackTrace(PrintStreamOrWriter s)` 方法源码如下：
    
        //省略其余...
        
        //获得StackTraceElement[]
        StackTraceElement[] trace = getOurStackTrace();
        
        //遍历StackTraceElement[]得到方法间的调用过程并输出
        for (StackTraceElement traceElement : trace)
            //每一个StackTraceElement对象独占一行，且以at开头
            s.println("\tat " + traceElement);
        
        //省略其余...

## 二、异常演示 ##

测试代码如下：

public class MyException { 
        public static void main(String[] args) { 
            try { 
                method3(); //第6行
            } catch (Exception e) { 
                e.printStackTrace();
            }
        }
    
        private static void method1() throws Exception { 
            throw new Exception("method1有异常"); //第13行
        }
    
        private static void method2() throws Exception { 
            try { 
                method1(); //第18行
            } catch (Exception e) { 
                throw new Exception("method2有异常", e); //第20行
            }
        }
    
        private static void method3() throws Exception { 
            try { 
                method2(); //第26行
            } catch (Exception e) { 
                throw new RuntimeException("method3有异常", e); //第28行
            }
        }
    }

运行结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70][]

**对异常信息的分析：**

*  异常轨迹以栈的形式打印出来，最下面的异常最早出现（method1），逐渐导致上方的异常被抛出，最上面的异常最晚被抛出并且没有被捕获（method3）
 *  下一个异常是上一个异常被抛出的原因，比如method1的异常导致了method2的异常，所以method1的异常以 Caused by 开头，故异常的源头是method1
 *  每一个异常的组成（图中有三个）
    
     *  第一行，异常类型：创建异常时参数传递的message信息
     *  其余行表示异常路径
        
         *  一行是一个路径（StackTraceElement对象），以 at 开头，包括类名、异常所在的方法名、产生异常时对应的代码的行数
         *  路径打印的顺序是先进先出的方式，最上层的路径最先被异常经过，比如最上层的异常先经过method3，再经过main方法
         *  只有在创建异常对象时调用了两个参数的构造器才会将 message 信息和 Caused by 打印出来，比如method1之后就没有Caused by

**上述运行结果的阅读顺序：**

*  首先锁定栈中最后一个异常，确定导致异常的原因是method1
 *  进入method1的异常路径中，发现异常在method1中产生，之后传递到了method2中
 *  观察栈中的上一个异常，进入路径中，发现此异常在method2中产生，之后传递到了method3中
 *  继续观察栈中的上一个异常，进入路径中，发现此异常在method3中产生，之后传递到了main方法中，在main方法中将此异常处理
 *  总的来说，异常在method1方法的第13行产生，通过传递，最终在第6行的main方法中解决

**对一些情况的说明：**

可以发现上述的运行结果中有两行是 `...1 more`，出现的原因是什么呢？

*  省略的内容是重复的栈帧信息，省略的原因是减少IO次数，方便阅读
 *  打印异常信息的方法是 `Throwable` 类中的 `printEnclosedStackTrace` 方法，部分源码如下：
    
        //enclosingTrace是trace的父级堆栈，二者有一部分的栈帧是重复的
        int m = trace.length - 1;
        int n = enclosingTrace.length - 1;
        
        //从栈顶倒序的判断二者重复的栈帧有多少个
        while (m >= 0 && n >=0 && trace[m].equals(enclosingTrace[n])) { 
            m--; n--;
        }
        int framesInCommon = trace.length - 1 - m;
        
        //重复的栈帧不重复输出，只提示有几个相同的栈帧
        if (framesInCommon != 0)
            s.println(prefix + "\t... " + framesInCommon + " more");

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80OTM0MzE5MA_size_16_color_FFFFFF_t_70]: /images/20221022/bdc28753185a4c7685bb96bcc85f7c77.png