Go言語でループ内のポインタを安全に扱う上での一般的なバグとその解決策 #Go

はじめに

ポインタの取り扱いを間違えると全て同じ値になってしまうバグを起こしてしまうことがあります。Go初心者というかポインタとか使ってきてないエンジニアは一度はハマってしまうのではないでしょうか？
自分もハマった口なので...

説明

このコードは、Go言語でループ内でポインタを使用する際の正しい方法と誤った方法を示す例です。
User構造体のスライスusersがあり、各ユーザーのIDをポインタとして別のスライスに格納しています。
コードには2つの方法が示されており、1つは誤った方法（Incorrect method）、もう1つは正しい方法（Correct method）です。

該当のコードはこちら

package main

import "fmt"

type User struct {
    ID   string
    Name string
}

func main() {
    users := []User{
        {"1", "Alice"},
        {"2", "Bob"},
        {"3", "Charlie"},
    }

    // ポインタのスライスを作成
    idsIncorrect := make([]*string, 0, len(users))
    idsCorrect := make([]*string, 0, len(users))

    // Incorrect method
    for _, user := range users {
        idsIncorrect = append(idsIncorrect, &user.ID)
    }

    // Correct method
    for _, user := range users {
        tmp := user.ID
        idsCorrect = append(idsCorrect, &tmp)
    }

    fmt.Println("Incorrect method:")
    for _, id := range idsIncorrect {
        fmt.Println(*id)
    }

    fmt.Println("Correct method:")
    for _, id := range idsCorrect {
        fmt.Println(*id)
    }
}

1.　ncorrect method（誤った方法）
この方法では、&user.IDを使用して、User構造体のIDフィールドへのポインタをidsIncorrectスライスに追加しています。しかし、userはforループ内で更新される変数であり、ループの各イテレーションで同じメモリアドレスを参照しています。その結果、idsIncorrectに追加されるポインタはすべて同じメモリアドレスを指し、最終的なIDの値がすべて同じになってしまいます。

2. Correct method（正しい方法）
この方法では、tmp := user.IDとして新しい変数tmpにUser構造体のIDフィールドの値をコピーし、その変数へのポインタ（メモリアドレス）をidsCorrectスライスに追加しています。この方法により、各イテレーションで新しい変数が作成され、それぞれ異なるメモリアドレスが参照されるようになります。これによって、各IDに正しい値が設定されます。

結果はこのようになります。

Incorrect method:
3
3
3
Correct method:
1
2
3

ポインタの取り扱いに関する注意事項

1. ループ内でポインタを使用する場合、ループ変数のアドレスを直接参照すると、意図しない動作が発生する可能性があります。ループ変数はイテレーションごとに同じメモリアドレスを使用するためです。

2. ループ内でポインタを使用する場合は、ループ内で新しい変数を作成し、ループ変数の値をその新しい変数にコピーしてから、その新しい変数のアドレスを取得するようにします。これにより、各イテレーションで異なるメモリアドレスが参照されるようになり、意図した動作が得られます。

3. ポインタを使用する際は、nilチェックを行い、nilポインタに対する操作を避けることが重要です。nilポインタをデリファレンス（デリファレンス（値を参照すること）しようとすると、ランタイムパニックが発生し、プログラムがクラッシュする可能性があります。

4. 不要なポインタ操作を避けることで、プログラムの可読性と安全性が向上します。ポインタを使用する理由が明確でない場合は、値渡しを検討してください。ただし、大きなデータ構造をコピーする場合や、関数呼び出しで変更された値を元の変数に反映させたい場合など、ポインタを使用する理由がある場合もあります。

5. ポインタを扱う際には、ガベージコレクションに関する知識も重要です。ポインタが不要になった場合、参照を解除することでメモリリークを回避できます。Go言語はガベージコレクションを自動的に行うため、プログラマは通常これを意識する必要はありませんが、大規模なアプリケーションや特定の状況では、メモリ管理に関する知識が役立ちます。

上記の注意事項を踏まえて、Go言語でポインタを扱う際には、ループ内でのポインタ操作やnilチェック、適切なポインタの使用、メモリ管理に注意を払うことが重要です。これらのポイントを意識することで、ポインタを安全かつ効果的に使用することができます。