[Goのはじめ方] Part12: defer, panic, recoverの使い方

defer: 関数の実行を遅延させる

Go言語のdefer文は、関数呼び出しを即座に実行せず、そのdefer文を含む関数が終了する直前まで実行を遅延させる機能です。リソースのクリーンアップ処理（ファイルのクローズ、ミューテックスのアンロックなど）を、リソース確保の直後に記述できるため、コードの可読性と安全性を高めるのに役立ちます。✨

defer文の主な特徴は以下の通りです。

実行タイミング: defer文を含む関数がreturnするか、パニック(panic)が発生して終了する直前に実行されます。
引数の評価: defer文が実行された時点で、遅延実行される関数の引数は評価されます。ただし、関数自体はすぐには実行されません。
実行順序 (LIFO): 1つの関数内で複数のdefer文がある場合、最後に記述されたdefer文から順に実行されます（Last-In, First-Out）。スタックのように後から積まれたものが先に取り出されるイメージです。

基本的な使い方

package main

import "fmt"

func main() {
    defer fmt.Println("World") // この行はmain関数の最後に実行される

    fmt.Println("Hello") // この行が先に実行される
}

実行結果:

Hello
World

この例では、fmt.Println("World")の呼び出しがdeferされているため、fmt.Println("Hello")が実行された後、main関数が終了する直前に実行されます。

複数のdefer文

package main

import "fmt"

func main() {
    fmt.Println("開始")

    defer fmt.Println("1番目のdefer")
    defer fmt.Println("2番目のdefer")
    defer fmt.Println("3番目のdefer")

    fmt.Println("終了")
}

実行結果:

開始
終了
3番目のdefer
2番目のdefer
1番目のdefer

複数のdefer文がある場合、LIFO（後入れ先出し）の順序で実行されることがわかります。

リソースクリーンアップでの利用例

ファイル操作などでリソースを確実に解放するためにdeferは非常によく使われます。

package main

import (
	"fmt"
	"os"
)

func main() {
	file, err := os.Open("example.txt")
	if err != nil {
		fmt.Println("ファイルを開けませんでした:", err)
		return
	}
	// file.Close()をdeferで呼び出す
	// これにより、関数がどのように終了しても（エラー発生時も含む）、
	// ファイルが確実にクローズされる
	defer file.Close()

	fmt.Println("ファイルを開きました:", file.Name())
	// ここでファイルに対する操作を行う...
}

この例では、os.Openでファイルを開いた直後にdefer file.Close()を記述しています。これにより、関数のどこでreturnしても、あるいは後述するpanicが発生しても、file.Close()が実行されることが保証されます。🧹

panic: 予期せぬエラーとプログラムの停止

panicは、Go言語の組み込み関数で、プログラムの通常の実行フローを停止させ、パニック状態を開始します。これは、プログラムが回復不可能なエラーに遭遇したときや、開発者が予期しない状況が発生したことを示すために使用されます。💥

panicが呼び出されると、以下のことが起こります。

現在の関数の実行が停止します。
その関数内でdeferされていた関数呼び出しが、通常の順序（LIFO）で実行されます。
関数は呼び出し元に制御を戻します。
呼び出し元でも同様のプロセスが繰り返され、スタックを遡っていきます。
現在のゴルーチン内の全ての関数が終了すると、プログラムはクラッシュし、エラーメッセージとスタックトレースが出力されます。

panicは、配列の範囲外アクセスやゼロ除算などのランタイムエラーによっても引き起こされることがあります。

panicの呼び出し例

package main

import "fmt"

func main() {
    fmt.Println("処理開始")
    performCalculation(0)
    fmt.Println("処理終了（この行は実行されない）") // panicによりここまで到達しない
}

func performCalculation(divisor int) {
    defer fmt.Println("計算関数のdefer実行") // panicが発生してもdeferは実行される

    if divisor == 0 {
        panic("ゼロ除算エラー！") // panicを発生させる
    }
    result := 100 / divisor
    fmt.Println("計算結果:", result)
}

実行結果 (例):

処理開始
計算関数のdefer実行
panic: ゼロ除算エラー！

goroutine 1 [running]:
main.performCalculation(0x0)
        /path/to/your/file.go:16 +0xbf
main.main()
        /path/to/your/file.go:7 +0x65
exit status 2

この例では、performCalculation関数内でdivisorが0の場合にpanicを呼び出しています。これにより、"処理終了..."の行は実行されず、プログラムは停止します。しかし、panicが発生する前にdeferされていたfmt.Println("計算関数のdefer実行")は実行されている点に注目してください。

注意: Go言語では、エラーは通常、関数の戻り値（特にerror型）として扱うのが慣例です。panicは、本当に予期しない、回復不能な状況を示すために限定的に使用すべきです。ライブラリの内部でpanicを使用する場合でも、外部APIでは通常のerror値を返すように設計することが推奨されます。

recover: パニックからの回復

recoverは、Go言語の組み込み関数で、パニック状態にあるゴルーチンの制御を取り戻すために使用されます。recoverは、deferされた関数内でのみ有効です。🛡️

recoverの動作は以下の通りです。

通常の実行時: recoverを呼び出してもnilが返され、他に何の影響もありません。
パニック発生時: 現在のゴルーチンがパニック状態の場合、deferされた関数内でrecoverを呼び出すと、panicに渡された値を取得し、通常の実行フローを再開します。パニックシーケンスは停止し、プログラムはクラッシュしません。
defer外での呼び出し: deferされた関数以外でrecoverを呼び出しても、パニック状態を回復することはできません（nilが返るだけです）。

recoverの使用例

package main

import "fmt"

func main() {
    fmt.Println("main開始")
    safeCall()
    fmt.Println("main終了 (正常に終了)")
}

func safeCall() {
    // deferされた無名関数内でrecoverを呼び出す
    defer func() {
        // recover()はpanicが発生した場合にpanicに渡された値を返す
        // panicが発生していない場合はnilを返す
        if r := recover(); r != nil {
            fmt.Println("パニックを回復しました:", r)
        }
    }() // deferキーワードの後に関数を直接定義し、即座に呼び出し(}() )を登録

    fmt.Println("safeCall: 処理実行中...")
    triggerPanic()
    fmt.Println("safeCall: panicの後 (この行は実行されない)") // panicによりここまで到達しない
}

func triggerPanic() {
    fmt.Println("triggerPanic: パニックを発生させます！")
    panic("意図的なパニック")
}

実行結果:

main開始
safeCall: 処理実行中...
triggerPanic: パニックを発生させます！
パニックを回復しました: 意図的なパニック
main終了 (正常に終了)

この例では、triggerPanic関数でpanicが発生しますが、safeCall関数内でdeferされた関数がrecoverを呼び出します。recoverはpanicに渡された値（"意図的なパニック"）を取得し、nilではないためif文の中が実行されます。重要なのは、recoverによってパニックシーケンスが停止し、プログラムがクラッシュせずにmain関数の最後まで正常に実行されている点です。😊

panicをerrorに変換する

recoverを使ってpanicを捕捉し、それを通常のerror値として返すパターンもよく見られます。これにより、予期せぬパニックが発生しても、呼び出し元は通常のエラーハンドリングの仕組みで対応できます。

package main

import (
	"fmt"
)

// この関数は内部でpanicを起こす可能性があるが、errorとして返す
func process(shouldPanic bool) (err error) {
	defer func() {
		if r := recover(); r != nil {
			// recoverした値をerror型に変換して返す
			// fmt.Errorfを使ってエラーメッセージを作成
			err = fmt.Errorf("内部でパニックが発生しました: %v", r)
		}
	}()

	if shouldPanic {
		panic("何かがおかしい！")
	}

	fmt.Println("正常に処理されました")
	return nil // エラーがない場合はnilを返す
}

func main() {
	err1 := process(false)
	if err1 != nil {
		fmt.Println("エラー発生:", err1)
	}

	fmt.Println("---")

	err2 := process(true) // ここでpanicが発生するが、recoverされる
	if err2 != nil {
		fmt.Println("エラー発生:", err2) // 捕捉されたエラーが表示される
	}
}

実行結果:

正常に処理されました
---
エラー発生: 内部でパニックが発生しました: 何かがおかしい！

このようにrecoverを使うことで、内部的なパニックを外部には通常のerrorとして見せることができます。ただし、前述の通りpanicの使用は慎重に行うべきです。

まとめ

defer, panic, recoverはGo言語における特殊な制御フローの仕組みです。

機能	概要	主な用途	注意点
`defer`	関数呼び出しを、現在の関数が終了する直前まで遅延させる	リソースのクリーンアップ（ファイルクローズ、ロック解除など）	引数は`defer`文実行時に評価される。実行順序はLIFO。
`panic`	プログラムの通常の実行フローを停止させ、パニック状態にする	回復不能なエラー、予期しない状態の通知	乱用は避ける。通常のエラーは`error`値で扱うべき。
`recover`	パニック状態のゴルーチンの制御を取り戻す	パニックの捕捉と処理、プログラムのクラッシュ防止、パニックを`error`への変換	`defer`された関数内でのみ有効。

これらの機能を理解し、適切に使い分けることで、より堅牢で信頼性の高いGoプログラムを作成することができます。特にdeferはリソース管理において非常に強力なツールです。💪