模型关联5.59.x8.58.x7.x6.x5.85.75.65.55.45.3

　　简介 定义关联 一对一 一对多 一对多（反向） 多对多 远层一对多 多态关联 多对多多态关联 查询关联 关联方法 Vs. 动态属性 基于存在的关联查询 基于不存在的关联查询 关联数据计数 预加载 为预加载添加约束条件 延迟预加载 插入 & 更新关联模型 方法 方法 更新 关联 多对多关联 更新父级时间戳

　　数据库表通常相互关联。 例如，一篇博客文章可能有许多评论，或者一个订单对应一个下单用户。Eloquent 让这些关联的管理和使用变得简单，并支持多种类型的关联：

　　一对一 一对多 多对多 远层一对多 多态关联 多对多多态关联

　　Eloquent 关联在 Eloquent 模型类中以方法的形式呈现。如同 Eloquent 模型本身，关联也可以作为强大的 查询语句构造器 使用，提供了强大的链式调用和查询功能。例如，我们可以在 关联的链式调用中附加一个约束条件：

　　不过，在深入使用关联之前，让我们先学习如何定义每种关联类型。

　　一对一关联是最基本的关联关系。例如，一个 模型可能关联一个 模型。为了定义这个关联，我们要在 模型中写一个 方法，在 方法内部调用 方法并返回其结果：

　　方法的第一个参数是关联模型的类名。关联关系定义好后，我们就可以使用 Eloquent 动态属性获得相关的记录。您可以像在访问模型中定义的属性一样，使用动态属性：

　　Eloquent 会基于模型名决定外键名称。在当前场景中，Eloquent 假设 模型有一个 外键，如果外键名不是这个，可以通过给 方法传递第二个参数覆盖默认使用的外键名：

　　此外，Eloquent 假定外键值是与父级 （或自定义 ）列的值相匹配的。 换句话说，Eloquent 将在 记录的 列中查找与用户表的 列相匹配的值。 如果您希望该关联使用 以外的自定义键名，则可以给 方法传递第三个参数：

　　定义反向关联 我们已经能从 模型访问到 模型了。现在，再在 模型中定义一个关联，此关联能让我们访问到拥有此电话的 模型。这时，使用的是与 方法对应的 方法：

　　在上面的例子中，Eloquent 会尝试匹配 模型上的 至 模型上的 。 它是通过检查关系方法的名称并使用 作为后缀名来确定默认外键名称的。 但是，如果模型的外键不是，那么可以将自定义键名作为第二个参数传递给方法：

　　如果父级模型没有使用 作为主键，或者是希望用不同的字段来连接子级模型，则可以通过给 方法传递第三个参数的形式指定父级数据表的自定义键：

　　默认模型 关联允许定义默认模型，这适应于当关联结果返回的是 的情况。这种设计模式通常称为 空对象模式，为您免去了额外的条件判断代码。在下面的例子中， 关联如果没有找到文章的作者，就会返回一个空的 模型。

　　您也可以通过传递数组或者使用闭包的形式，填充默认模型的属性：

　　「一对多」关联用于定义单个模型拥有任意数量的其它关联模型。例如，一篇博客文章可能会有无限多条评论。就像其它的 Eloquent 关联一样，一对多关联的定义也是在 Eloquent 模型中写一个方法：

　　记住，Eloquent 会自动确定 模型上正确的外键字段。按照约定，Eloquent 使用父级模型名的「snake case」形式、加上 后缀名作为外键字段。对应到上面的场景，就是 Eloquent 假定 模型对应到 模型上的那个外键字段是 。

　　关联关系定义好后，我们就可以通过访问 属性获得评论集合。记住，因为 Eloquent 提供了「动态属性」，所以我们可以像在访问模型中定义的属性一样，访问关联方法：

　　当然，由于所有的关联还可以作为查询语句构造器使用，因此你可以使用链式调用的方式、在 方法上添加额外的约束条件：

　　形如 方法，您也可以在使用 方法的时候，通过传递额外参数来覆盖默认使用的外键与本地键。

　　现在，我们已经能获得一篇文章的所有评论，接着再定义一个通过评论获得所属文章的关联。这个关联是 关联的反向关联，在子级模型中使用 方法定义它：

　　关联关系定义好后，我们就可以在 模型上使用 「动态属性」获得 模型了。

　　在上面的例子中，Eloquent 会尝试用 模型的 与 模型的 进行匹配。默认外键名是 Eloquent 依据关联名、并在关联名后加上 后缀确定的。当然，如果 模型的外键不是 ，那么可以将自定义键名作为第二个参数传递给方法：

　　如果父级模型没有使用 作为主键，或者是希望用不同的字段来连接子级模型，则可以通过给 方法传递第三个参数的形式指定父级数据表的自定义键：

　　多对多关联比 和 关联稍微复杂些。这种关联的一个例子就是具有许多角色的用户，而角色也被其他用户共享。例如，许多用户都可以有「管理员」角色。要定义这种关联，需要用到三个数据库表：、 和 。 表是以相关联的两个模型数据表、依照字母顺序排列命名的，并且包含 和 字段。

　　多对多关联是通过写一个方法定义的，在方法内部调用 方法并返回其结果。例如，我们在 模型中定义一个 方法：

　　关联关系定义好后，我们就可以通过 动态属性获得用户的角色了：

　　当然，如同所有其它的关联类型，您可以调用 方法，利用链式调用对查询语句添加约束条件：

　　如前所述，为了确定连接表表名，Eloquent 会按照字母顺序合并两个关联模型的名称。 当然，您可以自由地覆盖这个约定，通过给 方法指定第二个参数实现：

　　除了自定义连接表表名，您也可以通过给 方法再次传递额外参数来自定义连接表里的键的字段名称。第三个参数是定义此关联的模型在连接表里的键名，第四个参数是另一个模型在连接表里的键名：

　　定义反向关联 定义多对多关联的反向关联，您只要在对方模型里再次调用 方法就可以了。让我们接着以用户角色为例，在 模型中定义一个 方法。

　　如你所见，除了引入的模型变为 外，其它与在 模型中定义的完全一样。由于我们重用了 方法，自定义连接表表名和自定义连接表里的键的字段名称在这里同样适用。

　　获得中间表字段 您已经学到，多对多关联需要有一个中间表支持，Eloquent 提供了一些有用的方法来和这张表进行交互。例如，假设我们的 对象关联了许多的 对象。在获得这些关联对象后，可以使用模型的 属性访问中间表数据：

　　需要注意的是，我们取得的每个 模型对象，都会被自动赋予 属性，它代表中间表的一个模型对象，能像其它的 Eloquent 模型一样使用。

　　默认情况下， 对象只包含两个关联模型的键。如果中间表里还有额外字段，则必须在定义关联时明确指出：

　　如果您想让中间表自动维护 和 时间戳，那么在定义关联时加上 方法即可。

　　通过中间表过滤关联数据 在定义关联时，您可以使用 和 方法过滤 返回的结果：

　　定义自定义中间表模型 如果您想定义一个自定义模型来表示关联关系中的中间表，可以在定义关联时调用 方法。所有自定义中间表模型都必须扩展自 类。例如，

　　我们在写 模型的关联时，使用自定义中间表模型 ：

　　当定义 模型时，我们要扩展自 类：

　　「远层一对多」关联提供了方便、简短的方式通过中间的关联来获得远层的关联。例如，一个 模型可以通过中间的 模型获得多个 模型。在这个例子中，您可以轻易地收集给定国家的所有博客文章。让我们来看看定义这种关联所需的数据表：

　　虽然 表中不包含 字段，但 关联能让我们通过 访问到一个国家下所有的用户文章。为了完成这个查询，Eloquent 会先检查中间表 的 字段，找到所有匹配的用户 ID 后，使用这些 ID，在 表中完成查找。

　　现在，我们已经知道了定义这种关联所需的数据表结构，接下来，让我们在 模型中定义它：

　　方法的第一个参数是我们最终希望访问的模型名称，而第二个参数是中间模型的名称。

　　当执行关联查询时，通常会使用 Eloquent 约定的外键名。如果您想要自定义关联的键，可以通过给 方法传递第三个和第四个参数实现，第三个参数表示中间模型的外键名，第四个参数表示最终模型的外键名。第五个参数表示本地键名，而第六个参数表示中间模型的本地键名：

　　数据表结构 多态关联允许一个模型在单个关联上属于多个其他模型。例如，想象一下使用您应用的用户可以「评论」文章和视频。使用多态关联，您可以用一个 表同时满足这两个使用场景。让我们来看看构建这种关联所需的数据表结构：

　　表中有两个需要注意的重要字段 和 。 用来保存文章或者视频的 ID 值，而 用来保存所属模型的类名。 是在我们访问 关联时， 让 ORM 确定所属的模型是哪个「类型」。

　　模型结构 接下来，我们来看看创建这种关联所需的模型定义：

　　获取多态关联 一旦您的数据库表准备好、模型定义完成后，就可以通过模型来访问关联了。例如，我们只要简单地使用 动态属性，就可以获得某篇文章下的所有评论：

　　您也可以在多态模型上，通过访问调用了 的关联方法获得多态关联的拥有者。在当前场景中，就是 模型的 方法。所以，我们可以使用动态属性来访问这个方法：

　　模型的 关联会返回 或者 实例，这取决于评论所属的模型类型。

　　自定义多态关联的类型字段 默认，Laravel 会使用完全限定类名作为关联模型保存在多态模型上的类型字段值。比如，在上面的例子中， 属于 或者 ，那么 的默认值对应地就是 和 。但是，您可能希望将数据库与程序内部结构解耦。那样的话，你可以定义一个「多态映射表」来指示 Eloquent 使用每个模型自定义类型字段名而不是类名：

　　您可以在 中的 函数中使用 方法注册「多态映射表」，或者使用一个独立的服务提供者注册。

　　数据表结构 除了传统的多态关联，您也可以定义「多对多」的多态关联。例如， 模型和 模型可以共享一个多态关联至 模型。 使用多对多多态关联可以让您在文章和视频中共享唯一的标签列表。首先，我们来看看数据表结构：

　　模型结构 接下来，我们准备在模型上定义关联关系。 和 两个模型都有一个 方法，方法内部都调用了 Eloquent 类自身的 方法：

　　定义反向关联 接下里，在 模型中，您应该为每个关联模型定义一个方法。在这个例子里，我们要定义一个 方法和一个 方法：

　　获取关联 一旦您的数据库表准备好、模型定义完成后，就可以通过模型来访问关联了。例如，我们只要简单地使用 动态属性，就可以获得某篇文章下的所有标签：

　　您也可以在多态模型上，通过访问调用了 的关联方法获得多态关联的拥有者。在当前场景中，就是 模型上的 方法和 方法。所以，我们可以使用动态属性来访问这两个方法：

　　由于所有类型的关联都通过方法定义，您可以调用这些方法来获取关联实例，而不需要实际运行关联的查询。此外，所有类型的关联都可以作为 查询语句构造器 使用，让你在向数据库执行 SQL 语句前，使用链式调用的方式添加约束条件。

　　例如，假设一个博客系统，其中 模型有许多关联的 模型：

　　您也可以像这样在 关联上添加额外约束条件：

　　您可以在关联上使用任何 查询语句构造器 的方法，所以，欢迎查阅查询语句构造器的相关文档以便了解您可以使用哪些方法。

　　如果您不需要给 Eloquent 关联查询添加额外约束条件，你可以简单的像访问属性一样访问关联。例如，我们刚刚的 和 模型例子中，我们可以这样访问所有用户的文章：

　　动态属性是「懒加载」的，意味着它们的关联数据只在实际被访问时才被加载。因此，开发者经常使用 预加载 提前加载他们之后会用到的关联数据。预加载有效减少了 SQL 语句请求数，避免了重复执行一个模型关联加载数据、发送 SQL 请求带来的性能问题。

　　当获取模型记录时，您可能希望根据存在的关联对结果进行限制。例如，您想获得至少有一条评论的所有博客文章。为了实现这个功能，您可以给 方法传递关联名称：

　　您也可以指定一个运算符和数目，进一步自定义查询：

　　也可以使用「点」符号构造嵌套的的 语句。例如，您可以获得所有至少有一条获赞评论的文章：

　　如果您需要更高级的用法，可以使用 和 方法在 查询里设置「where」条件。此方法可以让你增加自定义条件至关联约束中，例如对评论内容进行检查：

　　当获取模型记录时，您可能希望根据不存在的关联对结果进行限制。例如，您想获得 没有 任何评论的所有博客文章。为了实现这个功能，您可以给 方法传递关联名称：

　　如果您需要更高级的用法，可以使用 方法在 查询里设置「where」条件。此方法可以让你增加自定义条件至关联约束中，例如对评论内容进行检查：

　　如果您只想统计结果数而不需要加载实际数据，那么可以使用 方法，此方法会在您的结果集模型中添加一个 字段。例如：

　　您可以为多个关联数据「计数」，并为其查询添加约束条件：

　　您也可以为关联数据计数结果起别名，允许在同一个关联上多次计数：

　　当作为属性访问 Eloquent 关联时，关联数据是「懒加载」的。意味着在你第一次访问该属性时，才会加载关联数据。不过，是当你查询父模型时，Eloquent 可以「预加载」关联数据。预加载避免了 N + 1 查询问题。要说明 N + 1 查询问题，试想一个 模型关联到 模型：

　　现在，让我们来获得所有书籍和作者数据：

　　这个循环会运行一次查询取回所有数据表上的书籍数据，然后又运行一次查询获得每本书的作者数据。如果我们有 25 本书，则循环就会执行 26 次查询：1 次是获得所有书籍数据，另外 25 条查询用来获得每本书的作者数据。

　　谢天谢地，我们使用预加载让整个查询减少到 2 次。这是通过指定关联给 方法办到的：

　　整个操作，只执行了两条查询：

　　预加载多个关联 有时，你需要在一次操作中预加载几个不同的关联。为了实现这个功能，只需在 方法上传递额外的参数即可：

　　嵌套预加载 预加载嵌套关联，可以使用「点」语法。例如，在一个 Eloquent 语句中，预加载所有书籍作者和这些作者的联系信息：

　　有时，你可能希望在预加载关联数据的时候，为查询指定额外的约束条件。这有个例子：

　　在这个例子中，Eloquent 只会预加载标题里包含 文本的文章。您也可以调用其它的 查询语句构造器 进一步自定义预加载约束条件：

　　有时，您可能需要在获得父级模型后才去预加载关联数据。例如，当你需要来动态决定是否加载关联模型时，这可能很有帮助：

　　如果您想设置预加载查询的额外约束条件，可以通过给 添加数组键的形式达到目的，数组值是接收查询实例的闭包：

　　Eloquent 提供了便捷的方法来将新的模型增加至关联中。例如，也许你需要为一个 模型插入一个新的 。这时你无须为 手动设置 属性，直接在关联上使用 方法插入 即可：

　　需要注意的是，我们没有使用动态属性形式访问 关联。相反，我们调用了 方法获得关联实例。 方法会自动在新的 模型中添加正确的 值。

　　如果您需要保存多个关联模型，可以使用 方法：

　　除了 和 方法，您也可以使用 方法，它接收一个属性数组、创建模型并插入数据库。还有， 和 的不同之处在于， 接收的是一个完整的 Eloquent 模型实例，而 接收的是一个纯 PHP 数组：

　　{tip} 在使用 方法前，请确认您已经浏览了本文档的 批量赋值 章节。

　　您可以使用 方法保存多个关联模型：

　　当更新 关联时，可以使用 方法。此方法会在子模型中设置外键：

　　当删除 关联时，可以使用 方法。此方法会设置关联外键为 ：

　　附加 / 移除 Eloquent 也提供了几个额外的辅助方法，让操作关联模型更加便捷。例如：我们假设一个用户可以拥有多个角色，并且每个角色都可以被多个用户共享。给某个用户附加一个角色是通过向中间表插入一条记录实现的，使用 方法：

　　使用 方法时，您也可以通过传递一个数组参数向中间表写入额外数据：

　　当然，有时也需要移除用户的角色。删除多对多关联记录，使用 方法。 方法会移除掉正确的记录；当然，这两个模型数据依然保存在数据库中：

　　为了方便， 和 都允许传入 ID 数组：

　　同步关联 您也可以使用 方法来构造多对多关联。 方法可以接收 ID 数组，向中间表插入对应关联数据记录。所有没放在数组里的 IDs 都会从中间表里移除。所以，这步操作完成后，只有在数组里的 IDs 会被保留在中间表中。

　　您可以通过 ID 传递其他额外的数据到中间表：

　　如果您不想移除现有的 IDs，可以使用 方法：

　　切换关联 多对多关联也提供了一个 方法用于「切换」给定 IDs 的附加状态。如果给定 ID 已附加，就会被移除。同样的，如果给定 ID 已移除，就会被附加：

　　在中间表上保存额外数据 当处理多对多关联时， 方法还可以使用第二个参数，它是一个属性数组，包含插入到中间表的额外字段数据。

　　更新中间表记录 如果您需要更新中间表中已存在的记录，可以使用 方法。此方法接收中间记录的外键和一个属性数组进行更新：

　　当一个模型 或者 另一个模型，比如一个 属于一个 ，有时更新子模型导致更新父模型时间戳非常有用。例如，当一个 模型更新时，您要自动「触发」父级 模型的 时间戳的更新，Eloquent 让它变得简单。只要在子模型加一个包含关联名称的 属性即可：

　　现在，当你更新一个 时，对应父级 模型的 字段也会被同时更新，使其更方便得知何时让一个 模型的缓存失效：

　　用户名 头像 职能 签名 @baooab 翻译 我在 这儿 {note} 欢迎任何形式的转载，但请务必注明出处，尊重他人劳动共创开源社区。

　　转载请注明：本文档由 Laravel China 社区 laravel-china.org 组织翻译，详见 翻译召集帖。

　　文档永久地址： 《Laravel 中文文档》

　　本文章首发在 LearnKu.com 网站上。