JavaのdumpStack()メソッドとは？目的と使い方を実例付きで解説

dumpStack()メソッドとは

dumpStack()メソッドは、Threadクラスに用意されているstatic（静的）メソッドの一つです。このメソッドを呼び出すと、現在実行中のスレッドのスタックトレースがSystem.err（標準エラー出力）に出力されます。

dumpStack()メソッドの主な目的はデバッグです。プログラムのどの位置から呼び出されたのか、どのようなメソッド呼び出しの経路をたどってきたのかを確認したい場面で役立ちます。内部的には、ThrowableクラスのprintStackTrace()メソッドを呼び出してスタックトレースを出力しています。また、このメソッドは例外をスローしないため、try-catchブロックで囲む必要がなく、コードの任意の場所に手軽に組み込めるのが特徴です。

構文

public static void dumpStack()

使用例

以下のコードでは、現在のスレッド情報やアクティブなスレッド一覧を表示した後、dumpStack()メソッドを呼び出してスタックトレースを出力しています。

public class ThreadDumpStackTest {
    public static void main(String args[]) {
        Thread t = Thread.currentThread();
        t.setName("ThreadDumpStackTest");
        t.setPriority(1);
        System.out.println("Current Thread: " + t);
        int count = Thread.activeCount();
        System.out.println("Active threads: " + count);
        Thread threads[] = new Thread[count];
        Thread.enumerate(threads);
        for (int i = 0; i < count; i++) {
            System.out.println(i + ": " + threads[i]);
        }
        Thread.dumpStack();
    }
}

実行結果

Current Thread: Thread[ThreadDumpStackTest,1,main]
Active threads: 1
0: Thread[ThreadDumpStackTest,1,main]
java.lang.Exception: Stack trace
        at java.lang.Thread.dumpStack(Thread.java:1336)
        at ThreadDumpStackTest.main(ThreadDumpStackTest.java:14)

押さえておきたいポイント

• dumpStack()はThreadクラスの静的メソッドなので、「Thread.dumpStack()」の形式でインスタンス化なしに呼び出せます。
• スタックトレースは標準エラー出力（System.err）に出力されるため、通常のSystem.outとは異なるストリームに流れる点に注意しましょう。
• 内部でThrowable#printStackTrace()を利用しているため、実際に例外を発生させることなく、その時点の呼び出し履歴を取得できます。
• 例外をスローしない設計なので、try-catchで囲む必要がなく、デバッグ目的で気軽に埋め込むことができます。