Spring Bootで詳細な例外情報をエラーログにて出す方法

こんにちは。エキサイト株式会社の三浦です。

コードを書く上で、例外が起きたときに任意のエラーログを出力したい場面は多々出てきます。

今回は、Spring Bootで詳細な例外情報をエラーログにて出す方法を紹介します。

文字列だけのエラーログを出す方法
詳細なエラーログを出す方法
最後に

文字列だけのエラーログを出す方法

エラーログを出す上で最も簡単なのは、文字列だけのエラーログを出すことでしょう。

例えば、以下のような方法です。

@Slf4j
public class SampleClass {
    public void sample() {
        try {
            sampleException();
        } catch (Exception exception) {
            log.error("エラーが起きました: " + exception.getMessage());
        }
    }

    private void sampleException() {
        throw new RuntimeException("sampleException");
    }
}

これで十分であればよいですが、例えば起きた例外が何のクラスなのか、どの場所で起きたのかなど、詳細を知りたい場合はどうすれば良いでしょうか？

詳細なエラーログを出す方法

実はエラーログには、例外をそのまま渡すことが出来ます。

@Slf4j
public class SampleClass {
    public void sample() {
        try {
            sampleException();
        } catch (Exception exception) {
            log.error("エラーが起きました", exception);
        }
    }

    private void sampleException() {
        throw new RuntimeException("sampleException");
    }
}