java异常的栈轨迹记录(stack trace)

当需要记录异常日志时，可以记录异常的调用堆栈信息，以便根据调用堆栈获取代码位置。

printStackTrace()输出堆栈信息。

1.getStackTrace()方法

    这个方法提供了对printStackTrace()方法所打印信息的编程访问。它会返回一个栈轨迹元素的数组。将这些栈轨迹元素保存在一个数组中。每个元素对应栈的一个栈帧。数组的第一个元素保存的是栈顶元素。最后一个元素保存的栈底元素。

    下面是一个使用getStackTrace()访问这些轨迹栈元素并打印输出的例子：

public  class  TestPrintStackTrace {
     public  static  void  f()  throws  Exception{
         throw  new  Exception( "出问题啦！" );
     }
     public  static  void  g()  throws  Exception{
         f();
     }
     public  static  void  main(String[] args) {
         try  {
             g();
         } catch (Exception e) {
             e.printStackTrace();
             System.out.println( "------------------------------" );
             for (StackTraceElement elem : e.getStackTrace()) {
                 System.out.println(elem);
             }
         }
     }
}

 这样的输出和printStackTrace()的输出基本上是一样的，如下： 

java.lang.Exception: 出问题啦！
     at TestPrintStackTrace.f(TestPrintStackTrace.java: 3 )
     at TestPrintStackTrace.g(TestPrintStackTrace.java: 6 )
     at TestPrintStackTrace.main(TestPrintStackTrace.java: 10 )
TestPrintStackTrace.f(TestPrintStackTrace.java: 3 )
TestPrintStackTrace.g(TestPrintStackTrace.java: 6 )
TestPrintStackTrace.main(TestPrintStackTrace.java: 10 )

2.fillInStackTrace()

    在catch代码块中捕获到异常，打印栈轨迹，又重新throw出去。在上一级的方法调用中，再捕获这个异常并且打印出栈轨迹信息。这两个栈轨迹信息会一样吗？我们看一下代码：

public  class  TestPrintStackTrace {
     public  static  void  f()  throws  Exception{
         throw  new  Exception( "出问题啦！" );
     }
     public  static  void  g()  throws  Exception{
         try  {
             f();
         } catch (Exception e) {
             e.printStackTrace();
             throw  e;
         }
         
     }
     public  static  void  main(String[] args) {
         try  {
             g();
         } catch (Exception e) {
             e.printStackTrace();
         }
     }
}

在main方法中捕获的异常，是在g()方法中抛出的，按理说这两个打印栈轨迹的信息应该不同，第二次打印的信息应该没有关于f的信息。但是事实上，两次打印栈轨迹信息是一样的。输出结果如下：

java.lang.Exception: 出问题啦！
     at TestPrintStackTrace.f(TestPrintStackTrace.java: 3 )
     at TestPrintStackTrace.g(TestPrintStackTrace.java: 7 )
     at TestPrintStackTrace.main(TestPrintStackTrace.java: 16 )
java.lang.Exception: 出问题啦！
     at TestPrintStackTrace.f(TestPrintStackTrace.java: 3 )
     at TestPrintStackTrace.g(TestPrintStackTrace.java: 7 )
     at TestPrintStackTrace.main(TestPrintStackTrace.java: 16 )

也就是说，捕获到异常又立即抛出，在上级方法调用中再次捕获这个异常，打印的栈轨迹信息是一样的。原因在于没有将当前线程当前状态下的轨迹栈的状态保存进Throwabe中。现在我们引入fillInStackTrace()方法。这个方法刚好做的就是这样的保存工作。我们看一下这个方法的原型：

public  Throwable fillInStackTrace()

这个方法是有返回值的。返回的是保存了当前栈轨迹信息的Throwable对象。我们看看使用fillInStackTrace()方法处理后，打印的栈轨迹信息有什么不同，代码如下：

public  class  TestPrintStackTrace {
     public  static  void  f()  throws  Exception{
         throw  new  Exception( "出问题啦！" );
     }
     public  static  void  g()  throws  Exception{
         try  {
             f();
         } catch (Exception e) {
             e.printStackTrace();
             //不要忘了强制类型转换
             throw  (Exception)e.fillInStackTrace();
         }
         
     }
     public  static  void  main(String[] args) {
         try  {
             g();
         } catch (Exception e) {
             e.printStackTrace();
         }
     }
}

输出如下：

java.lang.Exception: 出问题啦！
     at TestPrintStackTrace.f(TestPrintStackTrace.java: 3 )
     at TestPrintStackTrace.g(TestPrintStackTrace.java: 7 )
     at TestPrintStackTrace.main(TestPrintStackTrace.java: 17 )
java.lang.Exception: 出问题啦！
     at TestPrintStackTrace.g(TestPrintStackTrace.java: 11 )
     at TestPrintStackTrace.main(TestPrintStackTrace.java: 17 )

我们看到，在main方法中打印栈轨迹已经没有了f相关的信息了。

所以在一个方法或者模块捕获到异常以后，如果不处理异常，继续向外抛出异常的时候，应该调用e.fillInStackTrace()，记录异常栈轨迹，以便排除问题的时候，根据堆栈信息进行问题原因查找。