Java中使用StackWalker和Stream API进行堆栈遍历
作者:牛旦教育IT课堂
1.Java 9以前堆栈遍历
到目前为止,官方解决方案是获取当前线程并调用其getStackTrace()
方法:
StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace();
另一个智能解决方案涉及.抛出异常并从中提取堆栈跟踪信息。 但是,无法操纵结果,它会立即打印出来:
new Exception().printStackTrace();
两种解决方案都存在同样的问题——它们都急切地捕获整个堆栈的快照,可不方便使用。
2. JEP-259: Stack-Walking API
JEP-259应该解决这些问题,而且确实如此。 新的API提供了一种使用Stream API懒惰地遍历堆栈跟踪的便捷方法。
我们可以像这样轻松地创建StackWalker 实例:
StackWalker stack = StackWalker.getInstance();
此外,我们可以提供一些初始选项:
StackWalker = StackWalker.getInstance(StackWalker.Option.RETAIN_CLASS_REFERENCE);
如果我们想要遍历整个堆栈,那只需要调用forEach()
方法:
stack.forEach(System.out::println);
3. StackWalker.StackFrame
如果我们查看Java 1.4的StackTraceElement——它几乎是一个包含有关声明类、方法名、类加载器名等的详细字符串信息。
StackWalker.StackFrame是一个更加类型安全友好的升级,在其上面提到了丰富的方法:
public Class<?> getDeclaringClass();
public MethodType getMethodType();
…甚至可这样:
public StackTraceElement toStackTraceElement();
4.示例
让我们将前面那些付诸实践,来创建一个简单的调用层次结构
(代码包和类名:com.nd.stackwalker. StackWalker): public static void main(String[] args) { foo(); } private static void foo() { bar(); } private static void bar() { java.lang.StackWalker .getInstance(java.lang.StackWalker.Option.RETAIN_CLASS_REFERENCE) .forEach(System.out::println); }
如果我们在IDE中(jshell运行显示会不一样,这个它的处理模式有关)中运行它,结果将是(注意堆栈元素的顺序):
com.nd.stackwalker.StackWalker.bar(StackWalker.java:22)
com.nd.stackwalker.StackWalker.foo(StackWalker.java:17)
com.nd.stackwalker.StackWalker.main(StackWalker.java:14)
5.高级特性
如果我们想利用惰性或帧过滤,我们可以使用另一个名为walk()的专用API方法,它允许我们使用Stream API来方便地遍历堆栈。 在阅读本文时,您可能想象walk()方法只是返回一个Stream实例。事实并非如此。
实际的签名是:
public <T> T walk(Function<? super Stream<StackFrame>, ? extends T> function)
还有一个很好的理由使它成为这种方式——堆栈需要被冻结以便遍历它,并且这发生在walk()方法调用的范围内 - 所以使用基于函数接口的模板方法实现这一目标是有意义的 。
即使你试图通过返回一个Stream实例来欺骗它,它也无法使用(自己试试看!)。
一旦我们知道了这个限制,我们只受我们的想象力和Stream API功能的约束。例如,我们可以优雅地跳过一些帧,然后挑选第一个遇到的帧:
java.lang.StackWalker .getInstance(java.lang.StackWalker.Option.RETAIN_CLASS_REFERENCE) .walk(s -> s.skip(1).limit(1).collect(Collectors.toList())) .forEach(System.out::println);
// 结果如下:
com.nd.stackwalker.StackWalker.main(StackWalker.java:17)
6.完整代码清单
/* *测试堆栈遍历 */ package com.nd.stackwalker; import java.util.stream.Collectors; /** * * @author Solo Cui */ public class StackWalker { public static void main(String[] args) { foo(); } private static void foo() { java.lang.StackWalker .getInstance(java.lang.StackWalker.Option.RETAIN_CLASS_REFERENCE) .walk(s -> s.skip(1).limit(1).collect(Collectors.toList())) .forEach(System.out::println);//第一次运行,注释掉 //bar();//第二次运行注释掉 } private static void bar() { java.lang.StackWalker .getInstance(java.lang.StackWalker.Option.RETAIN_CLASS_REFERENCE) .forEach(System.out::println); } }
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对脚本之家的支持。如果你想了解更多相关内容请查看下面相关链接