帰ってきた「しっぽのさきっちょ」

Error の構造化 — プログラミング言語 Go

今回は「エラー・ハンドリングについて」の続き。 とりあえず,エラーハンドリングのデモ用にこんなパッケージを考える。

package errdemo1

import "os"

// F returns error.
func F() error {
    file, err := os.Open("not-exist.txt")
    if err != nil {
        return err
    }
    defer file.Close()

    return nil
}

呼び出し側の main() 関数では,このパッケージを以下のようにハンドリングする。

package main

import (
    "fmt"
    "os"

    "errdemo/errdemo1"
)

func main() {
    if err := errdemo1.F(); err != nil {
        fmt.Fprintln(os.Stderr, err)
        return
    }

    return
}

not-exist.txt が存在しない場合,実行結果は以下のようになる。

$ go run main1.go
open not-exist.txt: The system cannot find the file specified.

まぁハンドリングというか Error() 関数が吐くエラー内容(文字列)を垂れ流してるだけだけど。 もし errdemo1.F() 関数が返す errortype を知りたければ Conversion 構文を使って

package main

import (
    "fmt"
    "os"

    "errdemo/errdemo1"
)

func main() {
    if err := errdemo1.F(); err != nil {
        switch err.(type) {
        case *os.PathError:
            fmt.Fprintln(os.Stderr, "*os.PathError")
        default:
        }
        fmt.Fprintln(os.Stderr, err)
        return
    }

    return
}

のように書ける1。 実行結果は

$ go run main2.go
*os.PathError
open not-exist.txt: The system cannot find the file specified.

となる。

この方法の欠点は大元の error を吐いた位置と error の伝達経路が分かりにくい点である。 errdemo1.F() 関数で error を拾ったら errdemo1 パッケージ専用の error に差し替えて呼び出し側に返す方法もあるが,単に error を差し替えただけでは大元の error 情報が消失してしまう。 このようなことが起きるのは error 情報が構造化されていないことに原因がある。

エラーハンドリングのために error を構造化する手段として github.com/pkg/errors というパッケージがあるそうだ。

github.com/pkg/errors パッケージは go get コマンドで導入できる。

$ go get -v github.com/pkg/errors
github.com/pkg/errors (download)
github.com/pkg/errors

あるパッケージで大元の error 情報を含んだ error をセットする場合は errors.Wrap() 関数を使う2

package errdemo2

import (
    "os"

    "github.com/pkg/errors"
)

// F returns error.
func F() error {
    file, err := os.Open("not-exist.txt")
    if err != nil {
        return errors.Wrap(err, "Error by F() function")
    }
    defer file.Close()

    return nil
}

この errdemo2 パッケージを呼び出す側を以下のように書けば

package main

import (
    "fmt"
    "os"

    "errdemo/errdemo2"
)

func main() {
    if err := errdemo2.F(); err != nil {
        fmt.Fprintln(os.Stderr, err)
        return
    }

    return
}

実行結果は以下のようになる。

$ go run main3.go
Error by F() function: open not-exist.txt: The system cannot find the file specified.

また大元の error を取得したければ errors.Cause() 関数を使う。

package main

import (
    "fmt"
    "os"

    "errdemo/errdemo2"

    "github.com/pkg/errors"
)

func main() {
    if err := errdemo2.F(); err != nil {
        switch errors.Cause(err).(type) {
        case *os.PathError:
            fmt.Fprintln(os.Stderr, "*os.PathError")
        default:
        }
        fmt.Fprintln(os.Stderr, err)
        return
    }

    return
}

この場合の実行結果は以下のようになる。

$ go run main4.go
*os.PathError
Error by F() function: open not-exist.txt: The system cannot find the file specified.

ちなみに errors.Cause() 関数の中身はこんな感じ。

// Cause returns the underlying cause of the error, if possible.
// An error value has a cause if it implements the following
// interface:
//
//     type causer interface {
//            Cause() error
//     }
//
// If the error does not implement Cause, the original error will
// be returned. If the error is nil, nil will be returned without further
// investigation.
func Cause(err error) error {
    type causer interface {
        Cause() error
    }

    for err != nil {
        cause, ok := err.(causer)
        if !ok {
            break
        }
        err = cause.Cause()
    }
    return err
}

つまり Cause() 関数を持つ error インスタンスであれば Cause() 関数を辿って大元の error インスタンスを返すが, Cause() 関数がない場合はそのまま引数の error インスタンスを返す。

このように github.com/pkg/errors パッケージを使えば error を構造的に,かつ手軽に扱うことができる。 とても便利なパッケージなので是非活用したいところである。

ブックマーク

Go 言語に関するブックマーク集はこちら

参考図書

photo
プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES)
Alan A.A. Donovan Brian W. Kernighan 柴田 芳樹
丸善出版 2016-06-20
評価

スターティングGo言語 (CodeZine BOOKS) Go言語によるWebアプリケーション開発 Kotlinスタートブック -新しいAndroidプログラミング Docker実戦活用ガイド グッド・マス ギークのための数・論理・計算機科学

著者のひとりは(あの「バイブル」とも呼ばれる)通称 “K&R” の K のほうである。

reviewed by Spiegel on 2016-07-13 (powered by G-Tools)


  1. 実際にはこのような type の判別はパッケージ側で提供すべきなのだろうが,今回はコードの比較のためにこんな書き方をしている。 [return]
  2. 追加する文字列部分を書式文字列とパラメータで指定する errors.Wrapf() 関数も用意されている。 [return]