GORM中auto preload自动预加载失效问题求助

问题场景 #

尝试通过gorm:"PRELOAD"标签结合会话级Set("gorm:auto_preload", true)实现Exam模型关联Course和Venue的自动预加载，但关联数据始终为空；手动调用Preload("Course").Preload("Venue")则能正常获取完整关联数据。

原模型代码 #

// Exam model
type Exam struct {
    gorm.Model
    Course   Course    `gorm:"PRELOAD;references:ID"`
    VenueID  uint      `gorm:"column:venue_id"`  
    CourseID uint      `gorm:"column:course_id"` 
    Seat     string    `gorm:"column:seat"`
    Venue    Venue     `gorm:"PRELOAD;references:ID"`
    Duration string    `gorm:"column:duration"`
    Date     time.Time `gorm:"column:date"`
}

原控制器代码 #

type ExamController struct {
    BaseController
}

func NewExamController(db *gorm.DB) *ExamController {
    return &ExamController{BaseController: BaseController{db: db, model: models.Exam{}}}
}

// GetAllExams retrieves all exams with preloaded associations
func (examController *ExamController) GetAllExams(context *gin.Context) {
    var exams []models.Exam

    // Fetch all exams from the database with preloaded associations
    if err := examController.db.Set("gorm:auto_preload", true).Find(&exams).Error; err != nil {
        context.AbortWithStatus(500)
        log.Println(err)
        return
    }

    // Return the exams as JSON response
    context.JSON(200, &exams)
}

当前输出（自动预加载失效） #

{
    "ID": 2,
    "CreatedAt": "2023-07-02T12:50:58.929244104+03:00",
    "UpdatedAt": "2023-07-02T12:50:58.929244104+03:00",
    "DeletedAt": null,
    "Course": {
        "ID": 0,
        "CreatedAt": "0001-01-01T00:00:00Z",
        "UpdatedAt": "0001-01-01T00:00:00Z",
        "DeletedAt": null,
        "Name": "",
        "Code": "",
        "Facilitator": ""
    },
    "VenueID": 1,
    "CourseID": 2,
    "Seat": "A1",
    "Venue": {
        "ID": 0,
        "CreatedAt": "0001-01-01T00:00:00Z",
        "UpdatedAt": "0001-01-01T00:00:00Z",
        "DeletedAt": null,
        "Name": "",
        "Code": "",
        "Building": "",
        "Capacity": 0
    },
    "Duration": "2 hours",
    "Date": "0001-01-01T00:00:00Z"
}

预期输出（手动预加载正常） #

{
    "ID": 2,
    "CreatedAt": "2023-07-02T12:50:58.929244104+03:00",
    "UpdatedAt": "2023-07-02T12:50:58.929244104+03:00",
    "DeletedAt": null,
    "Course": {
        "ID": 2,
        "CreatedAt": "2023-07-02T11:40:50.236979619+03:00",
        "UpdatedAt": "2023-07-02T11:40:50.236979619+03:00",
        "DeletedAt": null,
        "Name": "CLINICAL PHARMACOLOGY",
        "Code": "CPO 200",
        "Facilitator": "JOSEPH JACKSON"
    },
    "VenueID": 1,
    "CourseID": 2,
    "Seat": "A1",
    "Venue": {
        "ID": 1,
        "CreatedAt": "2023-07-02T12:43:39.256215902+03:00",
        "UpdatedAt": "2023-07-02T12:43:39.256215902+03:00",
        "DeletedAt": null,
        "Name": "LECTURE HALL 7",
        "Code": "L5",
        "Building": "LECTURE HALL",
        "Capacity": 400
    },
    "Duration": "2 hours",
    "Date": "0001-01-01T00:00:00Z"
}

问题原因 #

1. gorm:"PRELOAD"标签用途错误：该标签是用于手动调用Preload时，指定关联是否默认被预加载，并非开启自动预加载的配置项。会话级gorm:auto_preload设置不需要配合该标签，错误配置反而会干扰GORM的关联识别。
2. 关联定义冗余：GORM默认会根据关联字段名（如Course）自动匹配外键CourseID，额外的references:ID在默认场景下冗余，配置不当会导致关联匹配失败。

解决方法 #

步骤1：修正Exam模型的关联标签 #

去掉gorm:"PRELOAD;references:ID"，保留必要列名配置，让GORM自动识别关联关系（明确外键配置可选，更清晰）：

// Exam model
type Exam struct {
    gorm.Model
    Course   Course    `gorm:"foreignKey:CourseID"` // 可选，明确外键关联
    VenueID  uint      `gorm:"column:venue_id"`  
    CourseID uint      `gorm:"column:course_id"` 
    Seat     string    `gorm:"column:seat"`
    Venue    Venue     `gorm:"foreignKey:VenueID"` // 可选，明确外键关联
    Duration string    `gorm:"column:duration"`
    Date     time.Time `gorm:"column:date"`
}

步骤2：确保自动预加载配置生效 #

会话级开启gorm:auto_preload的方式正确，无需修改控制器代码。若需全局开启自动预加载，可在初始化DB时配置：

db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{
    Preload: true, // 全局开启自动预加载
})

验证结果 #

重新运行接口后，Exam的Course和Venue关联数据会被自动预加载，输出与手动调用Preload的结果一致。

内容的提问来源于stack exchange，提问作者Dante