【Java】例外チェーン（cause）の使い方（エラーの原因特定）

はじめに
例外チェーン（cause）とは？
1. 例外チェーン（cause）を実施する例
2. 使わない場合の例
Throwable.getCause() の仕組み
1. 例外メッセージ例
まとめ
ドキュメント
最後に

はじめに

Javaで開発していると、例外をキャッチして処理する場面はたくさん出てきます。しかし、ただ例外を捕まえて「新しい例外として投げ直す」だけでは、元々どんなエラーが発生したのか分からなくなってしまうことがよくあります。
そんなときに重要になるのが 例外チェーン（cause） です。
今回は、例外チェーン（cause）の使い方についてログとして記載していきたいと思います。

他にも、体系的にJavaを学びたい方には以下の教材がおすすめです：

👉スッキリわかるJava入門
👉スッキリわかるJava入門実践編

例外チェーン（cause）とは？

例外チェーン（cause）とは、例外を再スローするときに「元の例外」を cause として保持する仕組みのことです。

例外チェーン（cause）を実施する例

第2引数に実際に発生した Exception を設定することで、「元の例外」を cause として保持できます。

try {
    execute();
} catch (Exception e) {
    // 第2引数に元のExceptionの内容も併せて設定
    throw new RuntimeException("エラーが発生しました", e);
}

使わない場合の例

「元の例外」を cause を使用しない場合、何にExceptionでエラーが発生したかを握りつぶしてしまい、大元のExceptionがわからなくなってしまいます。

try {
    execute();
} catch (Exception e) {
    throw new RuntimeException("エラーが発生しました");
}

Throwable.getCause() の仕組み

causeの仕組みは、Javaの例外クラス Throwable によって実現されています。Throwable には次のような cause を管理するメソッドが存在し、例外チェーンでは、この内部フィールドに「元の例外オブジェクト」が格納されます。

Throwable getCause();
Throwable initCause(Throwable cause);

例外メッセージ例

以下のように、どこで何が発生したのかを階層的に追跡できるのが例外チェーンの最大の利点です。

Exception in thread "main" java.lang.RuntimeException: DB処理でエラーが発生しました
        at com.example.App3.main(App3.java:31)
Caused by: java.io.FileNotFoundException: user.json (アクセスが拒否されました。)
        at java.base/java.io.FileOutputStream.open0(Native Method)
        at java.base/java.io.FileOutputStream.open(FileOutputStream.java:289)
        at java.base/java.io.FileOutputStream.<init>(FileOutputStream.java:230)
        at java.base/java.io.FileOutputStream.<init>(FileOutputStream.java:118)
        at java.base/java.io.FileWriter.<init>(FileWriter.java:67)
        at com.example.App3.main(App3.java:28)