Slide 1
Slide 1 text
Go でのエラー⽣成パターン
Umeda.go 2019 Summer
Slide 2
Slide 2 text
今⽇話すこと
「Go でどんな error
を⽣成するか」
のいくつかのパターンを紹介 & ⽐較する
2
2
Slide 3
Slide 3 text
⾃⼰紹介
⼩原 ⼀哉 (こはら かず
や)
ウェブエンジニア
フェンリル株式会社
@KoharaKazuya
3
3
Slide 4
Slide 4 text
背景
「Go がそこそこ書けるようになってきたぞ。
よし、エラー処理を書こう」
「あれ、エラーの書き⽅は⾊々あるっぽい」
「⾊々あるけどどう違うんだろう？
どれがいいんだろう？」
4
4
Slide 5
Slide 5 text
まずは⾃分の求めているもの明確にする
5
5
Slide 6
Slide 6 text
私が「エラー」に求めるもの
1. わかりやすいメッセージを出⼒できること
エラー発⽣時にすぐに原因を理解するため
2. プログラムがエラーの種類を識別できること
回復や変換などのエラーハンドリングのため
3. スタックトレースを持つこと
エラー発⽣時に発⽣した箇所を知るため
6
6
Slide 7
Slide 7 text
私が「エラー」に求めるもの
4. エラーの原因のエラーを辿れること
エラーの原因のエラーが存在するなら
そちらの解決が必要な場合がある
5. エラー種別ごとに追加の情報を持てること
エラーによっては追加の情報を
プログラムに読ませたい場合がある
例: HTTP Retry-After ヘッダー
7
7
Slide 8
Slide 8 text
開発者が 読めることと
プログラムが 読めることを
混ぜて考えない
↓
エラーの種類の識別はプログラムのため
メッセージは開発者のため
スタックトレースの表⽰は開発者のため
エラーの原因を辿るのは開発者のため ※
1
※1
理想的にはプログラムは直接呼び出す API
が定義するエラーのみ相⼿にすれば良い。
エラーを⽣成する側は原因となったエラーを「⾃分の⾔葉に翻訳して」エラーを
⽣成し直すべき。エラーの原因を辿るのは知るためで挙動を変えるためではないはず。
8
8
Slide 9
Slide 9 text
これらの観点で様々なエラーの⽅法を
⽐較していく
9
9
Slide 10
Slide 10 text
メッセージ⽂字列チェック
エラーメッセージの⽂字列を使って種別を判定する⽅法
→ やるべきではない
開発者向けのメッセージをプログラムに読ませるべきではない
10
10
Slide 11
Slide 11 text
No Handling
if err != nil {
return err
}
→ やるべきではない
利⽤者にとって知らないエラーが出るので基本は避けるべき。
例:
「両替」ロジックの API
を使ったら
`permission denied`
というエラーが出てきた
11
11
Slide 12
Slide 12 text
翻訳
if err != nil {
return fmt.Errorf("database error: %v", err)
}
下位のエラーを翻訳して上位に投げるだけ
12
12
Slide 13
Slide 13 text
翻訳
観点 可否 理由
1. メッセージ ✔ error
はメッセージを持つ
2. 種類の識別 - その場限りの値のため
3. スタックトレース - fmt.Errorf
により
4. エラーの原因 ✔ %v
に⼊る
5. 追加情報 - ⽂字列のみ
13
13
Slide 14
Slide 14 text
Sentinel Errors
//
定義
var (
ErrInvalid = errors.New("invalid argument")
ErrPermission = errors.New("permission denied")
)
//
⽣成
return ErrInvalid
//
⽐較
if err == os.ErrInvalid {
// ...
}
14
14
Slide 15
Slide 15 text
Sentinel Errors
観点 可否 理由
1. メッセージ ✔ error
はメッセージを持つ
2. 種類の識別 ✔
等価性により確認可能
3. スタックトレース - 固定の値のため
4. エラーの原因 - 固定の値のため
5. 追加情報 - 固定の値のため
15
15
Slide 16
Slide 16 text
専⽤の型
//
定義
type PathError struct {
// ...
}
//
⽣成
return &PathError{ ... }
//
⽐較
if x, ok := err.(*os.PathError); ok {
// ...
}
16
16
Slide 17
Slide 17 text
専⽤の型
観点 可否 理由
1. メッセージ ✔ error
はメッセージを持つ
2. 種類の識別 ✔
型アサーションの成否により
3. スタックトレース ※
値を⽣成時に埋め込み
4. エラーの原因 ※
値を⽣成時にラップ
5. 追加情報 ✔
型ごとに独⾃定義
※ error.Error
のメッセージに混ぜ込めるがノイジー
17
17
Slide 18
Slide 18 text
特殊なチェック関数
//
定義
func IsNotExist(err error) bool {
return err == syscall.ENOENT
}
//
もしくは
func IsNotExist(err error) bool {
if x, ok := err.(*customError); ok {
return x.code == 123
}
return false
}
//
⽐較
if os.IsNotExist(err) {
// ...
} 18
18
Slide 19
Slide 19 text
特殊なチェック関数
観点 可否 理由
1. メッセージ ✔ error
はメッセージを持つ
2. 種類の識別 ✔
型アサーションの成否により
3. スタックトレース N/A エラー⽣成⽅法は任意
4. エラーの原因 N/A エラー⽣成⽅法は任意
5. 追加情報 N/A エラー⽣成⽅法は任意
19
19
Slide 20
Slide 20 text
ここまでは昔の知識
20
20
Slide 21
Slide 21 text
最近のエラー事情
Go では⻑らく
エラーとはエラーメッセージ⽂字列を持っている値だ
というスタンスを取ってきたが、
エラーの ラップ と 詳細情報の出⼒ の標準化のため
Go 1.13 からオプショナルなインターフェースと
標準機能が追加されることになった。
(現在でも xerrors パッケージで同等の機能が利⽤可能)
21
21
Slide 22
Slide 22 text
エラーがラップ可能になった
( %+v
でスタックトレースも)
22
22
Slide 23
Slide 23 text
種類の識別をラップ対応版にする
Sentinel Errors
//
等価性テスト
if err == os.ErrInvalid { ... }
//
ラップ対応版
if errors.Is(err, os.ErrInvalid) { ... }
23
23
Slide 24
Slide 24 text
種類の識別をラップ対応版にする
専⽤の型
//
型アサーションの成否
if x, ok := err.(*os.PathError); ok { ... }
//
ラップ対応版
var x *os.PathError
if errors.As(err, &x) { ... }
24
24
Slide 25
Slide 25 text
各種インターフェースを実装した型
観点 可否 理由
1. メッセージ ✔ error
はメッセージを持つ
2. 種類の識別 ✔
型アサーションの成否により
3. スタックトレース ✔
値を⽣成時に埋め込み
4. エラーの原因 ✔
値を⽣成時にラップ
5. 追加情報 ✔
型ごとに独⾃定義
適切にインタフェースを実装すれば全て可能
ただし、 エラー種別ごとに実装が必要なので⾯倒 25
25
Slide 26
Slide 26 text
各種インターフェースを実装した型
エラー種類ごとに実装がいちいち実装が必要で ⾯倒くさい
Sentinel Errors
スタックトレース、エラーの原因、追加情報などを持てず
エラー情報として 貧弱
26
26
Slide 27
Slide 27 text
⼿軽でリッチなエラーを⽣成する⽅法を考える
27
27
Slide 28
Slide 28 text
翻訳
if err != nil {
return fmt.Errorf("database error: %v", err)
}
下位のエラーを翻訳して上位に投げるだけ
→ 実は何もしなくても Go 1.13 でアップデートされる
28
28
Slide 29
Slide 29 text
翻訳
観点 可否 理由
1. メッセージ ✔ error
はメッセージを持つ
2. 種類の識別 - その場限りの値のため
3. スタックトレース ✔ fmt.Errorf
により
4. エラーの原因 ✔ %v
に⼊る
5. 追加情報 - ⽂字列のみ
29
29
Slide 30
Slide 30 text
Sentinel Errors + fmt.Errorf
//
定義
var (
ErrInvalid = errors.New("invalid argument")
ErrPermission = errors.New("permission denied")
)
//
⽣成
return fmt.Errorf("error: %w", ErrInvalid)
ラップしつつ新しくエラーを⽣成するため、
スタックトレースが出⼒できる
追加のメッセージが少し冗⻑
30
30
Slide 31
Slide 31 text
Sentinel Errors + fmt.Errorf
観点 可否 理由
1. メッセージ ✔ error
はメッセージを持つ
2. 種類の識別 ✔ errors.Is
により
3. スタックトレース ✔ fmt.Errorf
により
4. エラーの原因 - 複数のエラーのラップは不可
5. 追加情報 - ⽂字列のみ
31
31
Slide 32
Slide 32 text
もっとリッチなエラーを⼿軽に作りたい
32
32
Slide 33
Slide 33 text
ライブラリを作りました
github.com/KoharaKazuya/errval
github.com/KoharaKazuya/errbase
33
33
Slide 34
Slide 34 text
errval
//
定義
var (
ErrInvalid = errval.Type("invalid argument")
ErrPermission = errval.Type("permission denied")
)
//
⽣成
return ErrInvalid.New()
return ErrInvalid.Wrap(err) //
ラップする場合
//
⽐較
if xerrors.Is(err, provider.ErrInvalid) {
// ...
}
34
34
Slide 35
Slide 35 text
errval
観点 可否 理由
1. メッセージ ✔ error
はメッセージを持つ
2. 種類の識別 ✔ errors.Is
により
3. スタックトレース ✔ errval
により
4. エラーの原因 ✔ ErrType.Wrap
により
5. 追加情報 - errval
が提供しない
35
35
Slide 36
Slide 36 text
errbase
//
定義
type MyCustomError struct {
errbase.Err
CustomField string
}
//
⽣成
err := &MyCustomError{
CustomField: "additional information",
}
err.Build("failed to xxx")
return err
//
⽐較
var x *MyCustomError
if xerrors.As(err, &x) {
}
36
36
Slide 37
Slide 37 text
errbase
観点 可否 理由
1. メッセージ ✔ error
はメッセージを持つ
2. 種類の識別 ✔ errors.As
により
3. スタックトレース ✔ errbase
により
4. エラーの原因 ✔ Err.Wrap
により
5. 追加情報 ✔
独⾃の型定義が可能
37
37
Slide 38
Slide 38 text
⼿軽でリッチなエラー！
38
38
Slide 39
Slide 39 text
まとめ
エラーに求める機能を整理した
Go で error
を⽣成する様々なパターンを紹介、⽐較した
Go でエラーの⽣成をサポートするライブラリを作った
github.com/KoharaKazuya/errval
github.com/KoharaKazuya/errbase
39
39