💭
Go言語のエラーメッセージの書き方
Go言語でerror型のメッセージを書く指針をいくつかのスタイルガイドを参考にまとめます。
failed toなどの定型句は不要
error型である以上、何かに失敗したメッセージであることは明白です。
// bad
s, err := store.New()
if err != nil {
return fmt.Errorf("failed to create new store: %w", err)
}
// good
s, err := store.New()
if err != nil {
return fmt.Errorf("new store: %w", err)
}
前者はfailed to x: failed to y: failed to create new store: the errorのように出力され冗長です。後者はx: y: new store: the errorのように出力されます。
重複なくエラーに情報を追加する
基本的にGo言語では呼び出した関数からのエラーを伝播させていきます。その際に重複した情報を追加してはいけません。
例えば標準パッケージのos.Open()でファイルを開けなかった場合、エラーには既にファイル名が含まれているため、追加する必要はありません。
// Bad:
if err := os.Open("settings.txt"); err != nil {
// Output: could not open settings.txt: open settings.txt: no such file or directory
return fmt.Errorf("could not open settings.txt: %w", err)
}
// Good:
if err := os.Open("settings.txt"); err != nil {
// Output: open settings.txt: no such file or directory
return err
}
またエラーの背景についての情報を追加することが推奨されます。
下記例ではsettings.txtファイルを開けなかったことによって「プログラムの起動コードが動作していない」情報を追加します。
// Good:
if err := os.Open("settings.txt"); err != nil {
// launch codes unavailable: open settings.txt: no such file or directory
return fmt.Errorf("launch codes unavailable: %v", err)
}
Discussion