defer
関数の実行中にエラーが発生したり、条件によって早めに return したりして、関数の最後まで到達しないことがあります。このとき、後片付けとして予定していた処理が実行されないと、思わぬ問題を引き起こします。
例えば、ファイルやデータベースへの接続を開いた後、使い終わったら「閉じる」処理を書いておくのが基本です。ところが、途中の分岐で return して抜けたときにその「閉じる」処理が実行されないと、ファイルディスクリプタやデータベースへのコネクションを掴んだままになり、リソースリークにつながります。
以下は、ファイルを開いて末尾で file.Close() を呼ぶ書き方ですが、「ここでファイルを読み書きする処理」の途中で return すると file.Close() は呼ばれずに終わります。
file, err := os.Open("data.txt")
if err != nil {
return err
}
// ここでファイルを読み書きする処理(この途中で return するとどうなる?)
file.Close()
関数内の分岐が増えるほど、閉じ忘れが起きる箇所も増え、ミスに気付きにくくなります。
Go はこの課題に対して、「関数を抜けるときに必ず実行する処理」を登録できる defer を提供しています。開いた直後に defer file.Close() を書けば、途中でどの経路から return しても、ファイルは必ず閉じられます。
1. 基本の書き方
defer を関数呼び出しの前に付けると、その処理はこの関数を抜けるときに実行されます。複数書いた場合は登録の逆順で実行されます。書き方は以下のとおりです。
defer 関数呼び出し // この関数を抜けるときに実行される
次のコードは、defer に登録した処理が、関数を抜けるタイミングで登録の逆順に実行されることを示す例です。
package main
import "fmt"
func main() {
fmt.Println("開始")
defer fmt.Println("終了処理1")
defer fmt.Println("終了処理2")
fmt.Println("処理中")
}
以下のような実行結果が表示されます。
開始
処理中
終了処理2
終了処理1
開始 と 処理中 は普通の順で表示され、main を抜けるタイミングで defer に登録した「終了処理2 → 終了処理1」が登録の逆順で実行されました。
コードを解説します。
defer fmt.Println("終了処理1")
defer fmt.Println("終了処理2")
defer を関数呼び出しの前に付けると、その処理はこの関数(main)を抜けるときに実行されるように予約されます。書いた時点では実行されません。関数終了時には登録の逆順(LIFO: Last In First Out)で実行されます。
2. ファイル操作での利用
defer が実際にどう役立つのかを、ファイルの書き込みで確認します。ファイルを扱うときは「開いたら閉じる」がお決まりですが、書き込みの途中でエラーが起きたときにも、成功して最後まで到達したときにも、同じように閉じてほしいものです。開いた直後に defer file.Close() を登録しておくと、この「どちらの経路でも必ず閉じる」を1行で実現できます。
package main
import (
"fmt"
"os"
)
func writeData() error {
file, err := os.Create("data.txt")
if err != nil {
return fmt.Errorf("ファイルを作成できません: %w", err)
}
defer file.Close()
_, err = file.WriteString("Hello, defer!\n")
if err != nil {
return fmt.Errorf("書き込みに失敗: %w", err)
}
return nil
}
func main() {
if err := writeData(); err != nil {
fmt.Println("エラー:", err)
return
}
fmt.Println("書き込み完了")
}
以下のような実行結果が表示されます。
書き込み完了
正常に処理が完了したので 書き込み完了 が表示されました。実行後にはカレントディレクトリに data.txt が作成され、中に Hello, defer! が書き込まれています。もし途中で書き込みが失敗して return した場合でも、登録した defer file.Close() が実行されるため、ファイルは必ず閉じられます。
コードを解説します。
file, err := os.Create("data.txt")
if err != nil {
return fmt.Errorf("ファイルを作成できません: %w", err)
}
defer file.Close()
os.Create でファイルを作成し、成功したら直後に defer file.Close() を登録します。作成に失敗した場合は file が使えないため、その前で return して抜けます。登録する位置を「開いた直後」にしておくことで、以降のどこで return しても閉じられる形になります。
_, err = file.WriteString("Hello, defer!\n")
if err != nil {
return fmt.Errorf("書き込みに失敗: %w", err)
}
return nil
書き込みに失敗した場合は return して関数を抜けますが、その時点で先に登録した defer file.Close() が実行されるので、ファイルはきちんと閉じられます。正常に return nil で抜ける場合も同じです。
このパターンはファイルに限らず、リソースを掴む処理全般で使われます。例えばデータベース接続の解放(defer db.Close())や、ミューテックスのロック解除(defer mu.Unlock())でも、同じように「開いた/取得した直後に閉じる/解放する処理を defer で予約する」書き方が基本パターンです。
3. パニックの回収(recover)
3.1 パニックの発生
Goでは通常のエラーは return err で戻しますが、実装バグや配列の範囲外アクセスといった予期しない状況に遭遇すると、panic(パニック)と呼ばれる異常終了が発生し、プログラム全体が停止します。
例えば、以下のコードは配列の範囲外アクセスによってパニックが発生する例です。
package main
import "fmt"
func main() {
fmt.Println("開始")
nums := []int{1, 2, 3}
fmt.Println(nums[10])
fmt.Println("この行は実行されない")
}
以下のような実行結果が表示されます。
開始
panic: runtime error: index out of range [10] with length 3
goroutine 1 [running]:
main.main()
/path/to/main.go:8 +0x25
exit status 2
開始 までは表示されますが、nums[10] で範囲外アクセスが起きた瞬間にパニックが発生してプログラムが停止するため、後続の fmt.Println("この行は実行されない") は実行されません。
3.2 recoverによる回収
複数の処理を順に実行するプログラムで、1件目でパニックが起きても残りの処理まで止めたくない場合があります。このとき defer と recover を組み合わせると、パニックを捕まえて処理を継続できます。書き方は以下のとおりです。recover は defer の中でしか意味を持たないため、無名関数を defer に登録するのが基本パターンです。
defer func() {
if r := recover(); r != nil {
// パニックが起きたときの後処理(r はパニックに渡された値)
}
}()
次のコードは、safeRun の中で範囲外アクセスによって発生したパニックを recover で捕まえ、main の処理を継続する例です。
package main
import "fmt"
func safeRun() {
defer func() {
if r := recover(); r != nil {
fmt.Println("パニックを回収:", r)
}
}()
nums := []int{1, 2, 3}
fmt.Println(nums[10]) // ここでパニックが発生
}
func main() {
safeRun()
fmt.Println("処理を継続")
}
以下のような実行結果が表示されます。
パニックを回収: runtime error: index out of range [10] with length 3
処理を継続
safeRun の中でパニックが起きても、recover で捕まえたため main は停止せず、後続の 処理を継続 が出力されました。
コードを解説します。
defer func() {
if r := recover(); r != nil {
fmt.Println("パニックを回収:", r)
}
}()
defer に無名関数を登録し、その中で recover() を呼んでいます。recover() はパニックが発生していない場合は nil を返し、発生している場合はパニックの値(今回は runtime error: index out of range [10] with length 3)を返します。nil でなければ「捕まえた」と判定し、後処理をします。
recover は defer の中でしか意味を持ちません。複数の処理単位(例えば1件ずつのファイル処理や入力処理)の境界となる場所だけで使うのが典型的な使い方です。