Java 9のStackWalker APIとは？効率的にスタックトレースを取得する方法

StackWalker APIは、任意のメソッド内でタスクを実行する際に、フィルタリングや遅延アクセス（Lazy Access）を容易に行えるAPIです。Java 9では、スタックトレース情報を効率的に取得するための手段として導入されました。

StackWalker APIには、次の3つの重要なクラスが新しく追加されています。StackWalker、StackWalker.StackFrame、そしてStackWalker.Optionです。

StackWalker APIの主要クラス

1. StackWalker

StackWalkerは、このAPIの中核となるメインクラスです。StackWalker.forEach()メソッドを使ってスタックフレームを走査したり、StackWalker.getCallerClass()メソッドを呼び出すことで、呼び出し元のクラスを効率的に取得できます。また、StackWalker.walk()メソッドを利用すれば、スタックトレースを走査しながら、スタックフレームのストリームに対して関数を適用することも可能です。

2. StackWalker.StackFrame

StackWalker.StackFrameは、StackWalkerの静的ネストクラス（static nested class）であり、StackWalkerが返すメソッド呼び出しの情報を表します。特定のスタックフレーム情報へアクセスするためのメソッドとして、getDeclaringClass()やgetLineNumber()などが用意されています。

3. StackWalker.Option

StackWalker.OptionもStackWalkerの静的ネストクラスの一つです。StackWalker.getInstance()でインスタンスを生成する際に、スタックフレーム情報の取得方法を設定するためのオプションを指定できます。

コード例

import java.util.List;
import java.util.stream.Collectors;

public class StackWalkingTest {
    public static void main(String args[]) {
        final List<StackWalker.StackFrame> stack = StackWalker.getInstance()
            .walk(s -> s.collect(Collectors.toList()));
        for(StackWalker.StackFrame sf : stack) {
            System.out.println(sf.getClassName() + "::" + sf.getMethodName() + ":" + sf.getLineNumber());
        }
    }
}

実行結果

StackWalkingTest::main:6

このように、StackWalker APIを活用することで、従来のThread.currentThread().getStackTrace()よりも軽量かつ柔軟にスタックトレースへアクセスできるようになります。必要なフレームだけを遅延評価で取得できるため、アプリケーションのパフォーマンス向上にも大きく貢献します。