リレーション

実際のスキーマでは、ユーザ1人が複数の予約を持つ、といったテーブル間の関係が頻出します。GORMではリレーションを構造体のフィールドで表現でき、Preload を使えば LEFT JOIN 相当の取得を簡潔に書けます。database/sql では、親レコードと子レコードで別々にクエリを組み立てて詰め替える必要がありますが、GORMではフィールド定義とメソッドチェーンだけで済ませられるのが違いです。

1. 1対多の定義

GORMではリレーションを構造体のフィールドで表現します。親側は子のスライスを持ち、子側は「親テーブル名 + ID」の外部キーカラムを持たせます。書き方は以下のとおりです。

type 親モデル struct {
    ID       uint
    子スライス []子モデル   // 1対多を示すフィールド
}

type 子モデル struct {
    ID   uint
    親ID uint       // 外部キー(GORMの慣例: 親テーブル名 + ID)
    親   親モデル    // 逆参照(子から親を辿れるようにするフィールド)
}

これは、User が複数の Reservation を持つ関係を、構造体のフィールドで表現する例です。次のステップで扱うので、この時点ではまだ main.go に貼り付けなくて構いません。

type User struct {
    ID           uint   `gorm:"primaryKey"`
    Name         string `gorm:"size:50;not null"`
    Email        string `gorm:"size:100;not null;uniqueIndex"`
    Reservations []Reservation
}

type Reservation struct {
    ID     uint   `gorm:"primaryKey"`
    RoomID uint   `gorm:"not null"`
    UserID uint   `gorm:"not null"`
    User   User
}

コードを解説します。

Reservations []Reservation

User.Reservations フィールドは「1人の User が複数の Reservation を持つ」ことを表します。スライス型にすることで「1対多」の関係が示されます。

UserID uint   `gorm:"not null"`

Reservation 側の UserID は、外部キーになるカラムです。GORMの慣例(親テーブル名 + ID)に従って命名すると、User テーブルへの外部キーとして自動で認識されます。

User   User

User User を書いておくと「Reservation から User を参照できる」関係も表せます。予約から予約者情報を取り出したいときに使えるフィールドです。

2. 予約テーブルの追加と予約の登録

続いて、上で定義した Reservation モデルを追加して reservations テーブルを作り、user_id = 1 の予約を1件登録します。前ステップで id = 1 のユーザを削除しているので、まずユーザを1件作り直したうえで、予約を1件登録するコードにします。

main.go を以下のように書き換えます。これは、User と Reservation の両方をマイグレーションしたうえで、ユーザを1件作成し、続けてそのユーザに紐づく予約を1件作成するコードです。

package main

import (
    "fmt"
    "os"

    "github.com/joho/godotenv"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

type User struct {
    ID           uint   `gorm:"primaryKey"`
    Name         string `gorm:"size:50;not null"`
    Email        string `gorm:"size:100;not null;uniqueIndex"`
    Reservations []Reservation
}

type Reservation struct {
    ID     uint `gorm:"primaryKey"`
    RoomID uint `gorm:"not null"`
    UserID uint `gorm:"not null"`
    User   User
}

func main() {
    if err := godotenv.Load(); err != nil {
        fmt.Println(".envファイル読み込み失敗:", err)
        return
    }

    dsn := fmt.Sprintf(
        "%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&parseTime=True&loc=Local",
        os.Getenv("MYSQL_USER"),
        os.Getenv("MYSQL_PASSWORD"),
        os.Getenv("MYSQL_HOST"),
        os.Getenv("MYSQL_PORT"),
        os.Getenv("MYSQL_DATABASE"),
    )
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        fmt.Println("Open失敗:", err)
        return
    }

    if err := db.AutoMigrate(&User{}, &Reservation{}); err != nil {
        fmt.Println("マイグレーション失敗:", err)
        return
    }

    u := User{Name: "Taro", Email: "taro@example.com"}
    if err := db.Create(&u).Error; err != nil {
        fmt.Println("User作成失敗:", err)
        return
    }
    if err := db.Create(&Reservation{UserID: u.ID, RoomID: 10}).Error; err != nil {
        fmt.Println("Reservation作成失敗:", err)
        return
    }
    fmt.Println("UserとReservationを作成しました UserID:", u.ID)
}

実行してテーブル作成とレコード登録を確認します。

go run main.go

以下のような実行結果が表示されます(UserID は実行のたびに変わります)。

UserとReservationを作成しました UserID: 2

reservations テーブルが新規に作成され、指定した user_id と room_id = 10 の予約が1件登録されました。

コードを解説します。

if err := db.AutoMigrate(&User{}, &Reservation{}); err != nil {
    ...
}

AutoMigrate は複数のモデルを可変長引数で受け取れます。ここでは User と Reservation の両方をまとめて渡し、users と reservations のテーブル定義を最新の構造体定義に揃えます。

if err := db.Create(&Reservation{UserID: u.ID, RoomID: 10}).Error; err != nil {
    ...
}

Reservation の構造体に UserID と RoomID を詰めて Create を呼ぶと、INSERTが発行されます。この時点で reservations テーブルにユーザとの紐付きが記録されました。

3. Preload での関連取得

ユーザと紐づく予約を一緒に取得するには Preload を使います。database/sql では、ユーザを1件取り出したうえで別途 reservations テーブルにクエリを打ち、Goのコードでスライスに詰め直す必要がありますが、GORMでは1メソッドで書けます。書き方は以下のとおりです。

db.Preload("関連フィールド名").First(&変数, 主キー値)   // 関連レコードも自動で埋めて取得

main.go を以下のように書き換えます。これは、直前のステップで作成したユーザとその予約を、Preload を使って一緒に取り出して表示するコードです。id は直前の実行時に表示されたIDに置き換えてください。

package main

import (
    "fmt"
    "os"

    "github.com/joho/godotenv"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
)

type User struct {
    ID           uint   `gorm:"primaryKey"`
    Name         string `gorm:"size:50;not null"`
    Email        string `gorm:"size:100;not null;uniqueIndex"`
    Reservations []Reservation
}

type Reservation struct {
    ID     uint `gorm:"primaryKey"`
    RoomID uint `gorm:"not null"`
    UserID uint `gorm:"not null"`
    User   User
}

func main() {
    if err := godotenv.Load(); err != nil {
        fmt.Println(".envファイル読み込み失敗:", err)
        return
    }

    dsn := fmt.Sprintf(
        "%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&parseTime=True&loc=Local",
        os.Getenv("MYSQL_USER"),
        os.Getenv("MYSQL_PASSWORD"),
        os.Getenv("MYSQL_HOST"),
        os.Getenv("MYSQL_PORT"),
        os.Getenv("MYSQL_DATABASE"),
    )
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        fmt.Println("Open失敗:", err)
        return
    }

    var u User
    if err := db.Preload("Reservations").First(&u, 2).Error; err != nil {
        fmt.Println("Preload失敗:", err)
        return
    }

    fmt.Printf("ユーザ: [%d] %s\n", u.ID, u.Name)
    for _, r := range u.Reservations {
        fmt.Printf("  Reservation: ID=%d Room=%d\n", r.ID, r.RoomID)
    }
}

実行してユーザと予約を一緒に取得できることを確認します。

go run main.go

以下のような実行結果が表示されます。

ユーザ: [2] Taro
  Reservation: ID=1 Room=10

Preload によりUserの取得と同時に紐づく Reservations が埋め込まれ、ユーザの情報と予約の ID・RoomID が並んで表示されました。

コードを解説します。

var u User
if err := db.Preload("Reservations").First(&u, 2).Error; err != nil { ... }

Preload("Reservations") を挟むと、Userの取得と同時に、そのUserに紐づく Reservations も自動で埋めてくれます。内部的には2回のクエリ(ユーザ本体と、そのIDに紐づく予約)が発行されます。

for _, r := range u.Reservations {
    fmt.Printf("  Reservation: ID=%d Room=%d\n", r.ID, r.RoomID)
}

u.Reservations が予約のスライスとして埋まっているので、そのままループで回して表示できます。

JOINしたい場合は Joins("Reservations") を使いますが、Preloadのほうが N+1問題(関連レコードを取得するために、親レコードの件数分だけ子レコードのクエリを発行してしまう問題)を避けつつシンプルに書けるため、多くの場合はPreloadが選ばれます。