Java 9のStackWalker.getCallerClass()メソッドとは？使い方と仕組みを解説

Java 9では、StackWalker APIによって、遅延アクセスに対応した効率的なスタックウォーキングや、スタックトレースのフィルタリングが可能になりました。StackWalkerのオブジェクトを利用することで、スタックフレームの走査やアクセスを行えます。このクラスには、walk()、forEach()、getCallerClass()など、実用的なメソッドが複数用意されています。

getCallerClass()メソッドの役割

getCallerClass()メソッドは、「このメソッドを呼び出したメソッド」をさらに呼び出したクラス、つまり呼び出し元のクラスを返します。呼び出し元クラスのインスタンスを取得するには、StackWalkerインスタンスを取得する際にRETAIN_CLASS_REFERENCEオプションを指定する必要があります。

RETAIN_CLASS_REFERENCEは、StackWalkerが走査したすべてのクラスのインスタンスを保持するためのオプションです。このオプションを付けずにgetCallerClass()を呼び出すと、UnsupportedOperationExceptionがスローされる点に注意してください。

構文

public Class<?> getCallerClass()

サンプルコード

以下は、3段階のメソッド呼び出しチェーンの中でgetCallerClass()を使用した例です。

import java.lang.StackWalker.Option;

public class StackWalkerTest {
    public static void main(String args[]) {
        StackWalkerTest1.test1();
    }
}

class StackWalkerTest1 {
    protected static void test1() {
        StackWalkerTest2.test2();
    }
}

class StackWalkerTest2 {
    protected static void test2() {
        System.out.println(StackWalker.getInstance(Option.RETAIN_CLASS_REFERENCE).getCallerClass());
    }
}

実行結果

class StackWalkerTest1

このように、test2()内でgetCallerClass()を呼び出すと、直接の呼び出し元であるtest1()を持つStackWalkerTest1クラスが出力されます。ロギングやデバッグ、セキュリティチェックなどで「どのクラスから呼ばれたか」を特定したい場合に、このAPIは非常に有用です。