解决 Eloquent 关系中关联数据为空的问题：确保外键被选中

在使用 Laravel Eloquent 加载关联数据时，若主模型查询中指定了选择的列，但未包含用于建立关系的外键，则关联数据可能返回 null。本文将详细解释此问题的原因，并提供解决方案：在主模型查询的 select 语句中明确包含所有关联所需的外键，以确保 Eloquent 能够正确匹配并加载关联数据。

问题描述

在 Laravel 应用中，当尝试通过 Eloquent 的 with() 方法预加载关联数据（例如 Files 和 User 模型），同时在主模型（Course）的查询中使用了 select() 方法来指定需要获取的列时，可能会遇到关联数据返回 null 的情况。即使关联关系在模型中已正确定义，且外键实际存在于数据库中，但由于主查询未选择这些外键列，Eloquent 无法在内存中建立正确的关联映射。

考虑以下场景：我们希望从 Course 表中获取 id、courseDisplayName 和 aboutCourse 列，并同时预加载其关联的 files（获取 id、FileName、FilePath）和 user（获取 id、name）信息。

最初的 Eloquent 查询代码可能如下所示：

$course = Course::with(['files:id,FileName,FilePath','user:id,name'])
    ->select('id','courseDisplayName','aboutCourse')
    ->where('userId',$request->tutorId)
    ->get();

相应的 Course 模型中定义了与 Files 和 User 的 belongsTo 关系：

// Course Model
class Course extends Model
{
    public function files()
    {
        return $this->belongsTo(Files::class, 'fileId', 'id');
    }

    public function user()
    {
        return $this->belongsTo(User::class, 'userId', 'id');
    }
}

尽管关系定义正确，但上述查询的输出结果中，files 和 user 关联数据却显示为 null：

[
    {
        "id": 20,
        "courseDisplayName": "asasasb",
        "aboutCourse": null,
        "files": null, // 期望有数据，但为null
        "user": null   // 期望有数据，但为null
    },
    {
        "id": 14,
        "courseDisplayName": "yuu",
        "aboutCourse": "kljkl",
        "files": null,
        "user": null
    }
]

问题原因分析

这个问题产生的根本原因是 Eloquent 在预加载关联数据时，需要依赖主模型查询结果中的外键列来匹配和链接关联模型。当你在主模型查询中显式使用 select() 方法，并且没有包含用于建立关联的外键列（例如 fileId 和 userId），Eloquent 就无法获取到这些关键的连接信息。

具体来说，Course::with(['files', 'user']) 会首先执行主查询获取 Course 记录。然后，Eloquent 会收集这些 Course 记录中的 fileId 和 userId 值，并使用它们来执行单独的查询（或在某些情况下进行 JOIN 操作）来获取对应的 Files 和 User 记录。如果 fileId 和 userId 不在主查询的结果集中，Eloquent 就无法构建后续的关联查询，也无法将获取到的关联数据正确地“注入”到对应的 Course 对象中。

解决方案

解决此问题的方法非常直接：在主模型的 select() 语句中，除了选择所需的业务数据列外，还必须包含所有用于建立关联关系的外键列。

对于本例，Course 模型通过 fileId 关联 Files 模型，通过 userId 关联 User 模型。因此，在 select() 方法中，需要将 fileId 和 userId 也包含进来。

修正后的 Eloquent 查询代码如下：

$course = Course::with(['files:id,FileName,FilePath','user:id,name'])
    ->select('id','courseDisplayName','aboutCourse', 'userId', 'fileId') // 增加 'userId' 和 'fileId'
    ->where('userId',$request->tutorId)
    ->get();

通过在 select 语句中加入 userId 和 fileId，Eloquent 就能在获取 Course 记录的同时，获得这些外键值。这样，当 Eloquent 尝试加载 files 和 user 关联时，它能够正确地使用这些外键值来执行后续的关联查询，并将结果映射回 Course 对象。

注意事项与最佳实践

1. 外键的必要性： 当你对主模型使用 select() 方法时，务必记住：任何用于 with() 预加载关联关系的外键都必须包含在 select() 的列列表中。
2. 默认行为： 如果你的 Eloquent 查询没有使用 select() 方法，那么 Eloquent 默认会选择表中的所有列（SELECT *），在这种情况下，外键通常也会被包含在内，因此不会出现此问题。
3. 性能考量： 尽管为了解决关联问题需要包含外键，但在实际应用中，仍应遵循只选择必要列的原则，以优化查询性能和减少内存消耗。避免无谓地选择所有列，除非你确实需要它们。
4. 多级关联： 如果存在多级关联（例如 Course -> Files -> FileOwner），那么在预加载 FileOwner 时，也需要确保 Files 模型中用于关联 FileOwner 的外键被选中（如果 Files 模型也使用了 select()）。
5. 可读性与维护： 为了代码的可读性和未来的维护，建议将所有与关系相关的外键列明确地列在 select() 方法中，即使它们在某些情况下可能不是严格必需的（例如，当不使用 select() 时）。

总结

在使用 Laravel Eloquent 进行数据查询和关联预加载时，如果对主模型的结果集进行了列筛选（即使用了 select() 方法），务必确保将所有用于建立关联关系的外键列包含在 select() 的列表中。这是确保 Eloquent 能够正确识别并加载关联数据的关键步骤。遵循这一原则，可以有效避免因外键缺失而导致的关联数据为空的问题，从而构建出健壮且高效的 Laravel 应用。

以上是解决 Eloquent 关系中关联数据为空的问题：确保外键被选中的详细内容。更多信息请关注PHP中文网其他相关文章！