言語 - Defer, Panic, and Recover - 《Goプログラミング言語

Andrew Gerrand

4 August 2010

Goには、通常の制御フローのメカニズムが備わっています：if、for、switch、goto。また、別のgoroutineでコードを実行するためのgoステートメントもあります。ここでは、あまり一般的でないもの、すなわちdefer、panic、recoverについて説明します。

deferステートメントは、関数呼び出しをリストにプッシュします。保存された呼び出しのリストは、周囲の関数が戻った後に実行されます。Deferは、さまざまなクリーンアップアクションを実行する関数を簡素化するために一般的に使用されます。

たとえば、2つのファイルを開き、1つのファイルの内容を別のファイルにコピーする関数を見てみましょう：

func CopyFile(dstName, srcName string) (written int64, err error) {
   src, err := os.Open(srcName)
   if err != nil {
   return
   }
   dst, err := os.Create(dstName)
   if err != nil {
   return
   }
   written, err = io.Copy(dst, src)
   dst.Close()
   src.Close()
   return
}

これは機能しますが、バグがあります。os.Createの呼び出しが失敗した場合、関数はソースファイルを閉じることなく戻ります。これは、2番目のreturnステートメントの前にsrc.Closeを呼び出すことで簡単に修正できますが、関数がより複雑であれば、問題に気づき、解決するのはそれほど簡単ではないかもしれません。deferステートメントを導入することで、ファイルが常に閉じられることを保証できます：

func CopyFile(dstName, srcName string) (written int64, err error) {
   src, err := os.Open(srcName)
   if err != nil {
   return
   }
   defer src.Close()
   dst, err := os.Create(dstName)
   if err != nil {
   return
   }
   defer dst.Close()
   return io.Copy(dst, src)
}

Deferステートメントを使用すると、各ファイルを開いた直後に閉じることを考えることができ、関数内のreturnステートメントの数に関係なく、ファイルが必ず閉じられることが保証されます。

Deferステートメントの動作は簡単で予測可能です。3つの簡単なルールがあります：

1. deferステートメントが評価されるときに、遅延関数の引数が評価されます。

この例では、Println呼び出しが遅延されるときに式「i」が評価されます。遅延された呼び出しは、関数が戻った後に「0」を印刷します。

func a() {
   i := 0
   defer fmt.Println(i)
   i++
   return
}

1. 遅延関数呼び出しは、周囲の関数が戻った後に、後入れ先出しの順序で実行されます。

この関数は「3210」を印刷します：

func b() {
   for i := 0; i < 4; i++ {
   defer fmt.Print(i)
   }
}

1. 遅延関数は、戻り関数の名前付き戻り値を読み取り、割り当てることができます。

この例では、遅延関数が周囲の関数が戻った後に戻り値iをインクリメントします。したがって、この関数は2を返します：

func c() (i int) {
   defer func() { i++ }()
   return 1
}

これは、関数のエラー戻り値を修正するのに便利です。これについての例をすぐに見ていきます。

Panicは、通常の制御フローを停止し、パニックを開始する組み込み関数です。関数Fがpanicを呼び出すと、Fの実行は停止し、F内のすべての遅延関数は通常通り実行され、その後Fは呼び出し元に戻ります。呼び出し元にとって、Fはpanicへの呼び出しのように振る舞います。このプロセスはスタックを上に進み、現在のgoroutine内のすべての関数が戻るまで続き、その時点でプログラムがクラッシュします。パニックは、panicを直接呼び出すことで開始できます。また、配列の範囲外アクセスなどのランタイムエラーによっても引き起こされる可能性があります。

Recoverは、パニック状態のgoroutineの制御を取り戻すための組み込み関数です。Recoverは、遅延関数内でのみ有用です。通常の実行中にrecoverを呼び出すと、nilが返され、他の効果はありません。現在のgoroutineがパニック状態の場合、recoverを呼び出すとpanicに渡された値をキャプチャし、通常の実行を再開します。

以下は、panicとdeferのメカニズムを示す例プログラムです：

package main
import "fmt"
func main() {
   f()
   fmt.Println("Returned normally from f.")
}
func f() {
   defer func() {
   if r := recover(); r != nil {
   fmt.Println("Recovered in f", r)
   }
   }()
   fmt.Println("Calling g.")
   g(0)
   fmt.Println("Returned normally from g.")
}
func g(i int) {
   if i > 3 {
   fmt.Println("Panicking!")
   panic(fmt.Sprintf("%v", i))
   }
   defer fmt.Println("Defer in g", i)
   fmt.Println("Printing in g", i)
   g(i + 1)
}

関数gはint iを受け取り、iが3より大きい場合はパニックを起こし、そうでない場合は引数i+1で自分自身を呼び出します。関数fはrecoverを呼び出し、回復した値（nilでない場合）を印刷する関数を遅延させます。このプログラムの出力がどのようになるかを考えてみてください。

プログラムは次のように出力します：

Calling g.
Printing in g 0
Printing in g 1
Printing in g 2
Printing in g 3
Panicking!
Defer in g 3
Defer in g 2
Defer in g 1
Defer in g 0
Recovered in f 4
Returned normally from f.

fから遅延関数を削除すると、パニックは回復されず、goroutineの呼び出しスタックの最上部に達し、プログラムが終了します。この修正されたプログラムは次のように出力します：

Calling g.
Printing in g 0
Printing in g 1
Printing in g 2
Printing in g 3
Panicking!
Defer in g 3
Defer in g 2
Defer in g 1
Defer in g 0
panic: 4
panic PC=0x2a9cd8
[stack trace omitted]

panicとrecoverの実際の例については、Go標準ライブラリのjsonパッケージを参照してください。これは、再帰関数のセットを持つインターフェースをエンコードします。値をトラバースする際にエラーが発生すると、panicが呼び出され、スタックが最上位の関数呼び出しまで巻き戻され、そこからパニックを回復し、適切なエラー値を返します（encode.goのencodeState型の「error」と「marshal」メソッドを参照）。

Goライブラリの慣例は、パッケージが内部でpanicを使用している場合でも、その外部APIは明示的なエラー戻り値を提示することです。

deferの他の使用法（前述のfile.Closeの例を超えて）には、ミューテックスの解放が含まれます：

mu.Lock()
defer mu.Unlock()

フッターの印刷：

printHeader()
defer printFooter()

などがあります。

要約すると、deferステートメント（panicやrecoverの有無にかかわらず）は、制御フローのための異常で強力なメカニズムを提供します。これは、他のプログラミング言語の特別な構造によって実装される多くの機能をモデル化するために使用できます。試してみてください。