Laravel Many-to-Many 关系数据的高效获取与格式化教程-php教程-PHP中文网

Laravel Many-to-Many 关系数据的高效获取与格式化教程

碧海醫心

发布： 2025-10-02 11:59:12

原创

489人浏览过

laravel many-to-many 关系数据的高效获取与格式化教程

本教程详细讲解如何在 Laravel 中高效地获取多对多（M:M）关系数据，并将其格式化为所需的数组结构。通过结合 Eloquent 的预加载（Eager Loading）功能与集合操作（如 map 和 pluck），以及引入 API 资源的概念，帮助开发者以清晰、专业的方式处理复杂关联数据，确保输出符合前端或 API 需求。

1. 理解多对多关系与数据需求

在 Web 应用开发中，多对多（Many-to-Many, M:M）关系是一种常见的数据关联模式。例如，一个人可以拥有多种技能，而一种技能也可以被多人拥有。在 Laravel 中，这种关系通常通过一个中间表（也称为枢纽表或连接表）来维护。

示例数据模型：

person_table: 存储人员信息
- id: 主键
- name_of_person: 人员姓名
skills_table: 存储技能信息
- id: 主键
- name_of_skill: 技能名称
person_skill: 中间表，连接 person_table 和 skills_table
- person_table_id: 外键，关联 person_table 的 id
- skills_table_id: 外键，关联 skills_table 的 id

目标输出格式：

我们希望获取每个人的信息时，能直接看到他们所拥有的技能列表，且技能以一个简单的名称数组形式呈现，而非完整的技能对象。

{
  "id": 1,
  "name": "harat",
  "skills": [
    "php",
    "laravel",
    "reactjs",
    "nodejs"
  ]
}

登录后复制

2. 定义 Eloquent 模型与关系

为了在 Laravel 中操作这些表，我们需要创建相应的 Eloquent 模型，并定义它们之间的多对多关系。

Person 模型 (app/Models/Person.php):

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Person extends Model
{
    use HasFactory;

    protected $table = 'person_table'; // 指定表名

    /**
     * 定义与 Skill 模型的多对多关系
     */
    public function skills()
    {
        // 第一个参数是关联模型，第二个参数是中间表名，
        // 第三个参数是当前模型在中间表中的外键，第四个参数是关联模型在中间表中的外键
        return $this->belongsToMany(Skill::class, 'person_skill', 'person_table_id', 'skills_table_id');
    }
}

登录后复制

Skill 模型 (app/Models/Skill.php):

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Skill extends Model
{
    use HasFactory;

    protected $table = 'skills_table'; // 指定表名

    /**
     * 定义与 Person 模型的多对多关系 (可选，但推荐用于双向关联)
     */
    public function persons()
    {
        return $this->belongsToMany(Person::class, 'person_skill', 'skills_table_id', 'person_table_id');
    }
}

登录后复制

3. 使用预加载（Eager Loading）获取关联数据

默认情况下，当你查询一个模型时，它的关联数据并不会被加载。如果后续需要访问关联数据，Laravel 会为每个模型单独执行一个查询，这会导致臭名昭昭的“N+1 查询问题”，严重影响性能。

为了避免 N+1 查询问题，我们应该使用 Eloquent 的预加载（Eager Loading）功能，通过 with() 方法一次性加载所有关联数据。

use App\Models\Person;

// 获取所有人员及其关联的技能
$people = Person::with('skills')->get();

// 如果只需要获取单个人员
// $person = Person::with('skills')->first();

登录后复制

执行上述查询后，$people 变量将是一个 Illuminate\Database\Eloquent\Collection 实例，其中每个 Person 模型都包含一个 skills 属性。这个 skills 属性本身也是一个 Collection，里面包含了完整的 Skill 模型对象（例如 id: 1, name_of_skill: php）。

4. 格式化数据：集合操作 map 与 pluck

虽然预加载解决了 N+1 问题，但 skills 属性中包含的是完整的 Skill 模型对象，而不是我们想要的技能名称数组。为了将数据格式化成目标结构，我们可以利用 Laravel 集合提供的强大方法，特别是 map 和 pluck。

比格设计

比格设计是135编辑器旗下一款一站式、多场景、智能化的在线图片编辑器

124

查看详情

map() 方法用于遍历集合中的每个元素，并对每个元素执行一个回调函数，然后返回一个新的集合。pluck() 方法则用于从集合中的每个对象中提取指定键的值，并返回一个包含这些值的集合。

use App\Models\Person;

$peopleWithFormattedSkills = Person::with('skills')->get()->map(function (Person $person) {
    return [
        'id' => $person->id,
        'name' => $person->name_of_person, // 注意这里使用数据库字段名
        'skills' => $person->skills->pluck('name_of_skill')->toArray(), // 提取技能名称并转换为数组
    ];
});

// $peopleWithFormattedSkills 现在是一个包含格式化数据的集合
// 如果需要将其转换为纯 PHP 数组，可以再调用 toArray()
// $resultArray = $peopleWithFormattedSkills->toArray();

登录后复制

代码解析：

Person::with('skills')->get(): 获取所有人员及其预加载的技能。
->map(function (Person $person) { ... }): 遍历每个 Person 模型实例。
'id' => $person->id: 获取人员的 id。
'name' => $person->name_of_person: 获取人员的姓名。请注意，这里直接使用了数据库字段名 name_of_person。
'skills' => $person->skills->pluck('name_of_skill')->toArray(): 这是关键步骤。
- $person->skills: 访问当前人员的技能集合。
- ->pluck('name_of_skill'): 从技能集合中的每个 Skill 模型中提取 name_of_skill 字段的值。这会返回一个只包含技能名称的新集合。
- ->toArray(): 将这个只包含技能名称的集合转换为一个纯 PHP 数组。

最终，$peopleWithFormattedSkills 将包含符合我们目标格式的数据。

5. 进阶格式化：利用 API 资源

对于更复杂的场景，或者当你在构建 API 时，Laravel 提供的 API 资源（API Resources） 是一个更优雅、更专业的解决方案。API 资源允许你将模型转换为 JSON 格式，并提供对数据的细粒度控制，包括隐藏字段、添加额外数据、以及处理关联数据等。

使用 API 资源的好处包括：

关注点分离： 将数据格式化的逻辑从控制器或模型中分离出来。
一致性： 确保 API 响应格式的一致性。
可维护性： 集中管理数据转换逻辑，易于维护和修改。

创建 Person 资源：

php artisan make:resource PersonResource

登录后复制

app/Http/Resources/PersonResource.php:

<?php

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class PersonResource extends JsonResource
{
    /**
     * 将资源转换为数组。
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'name' => $this->name_of_person,
            'skills' => $this->whenLoaded('skills', function () {
                return $this->skills->pluck('name_of_skill');
            }),
            // 或者更简洁地直接使用 SkillResource 转换关联技能
            // 'skills' => SkillResource::collection($this->whenLoaded('skills')),
        ];
    }
}

登录后复制

在控制器中使用：

use App\Models\Person;
use App\Http\Resources\PersonResource;

class PersonController extends Controller
{
    public function index()
    {
        $people = Person::with('skills')->get();
        return PersonResource::collection($people);
    }

    public function show($id)
    {
        $person = Person::with('skills')->findOrFail($id);
        return new PersonResource($person);
    }
}

登录后复制

whenLoaded('skills', ...) 方法确保只有在 skills 关系已经被预加载时，才会包含技能数据，从而避免了 N+1 查询问题。

6. 注意事项与最佳实践

始终使用预加载（with()）：在访问关联数据之前，养成使用 with() 预加载的习惯，以避免 N+1 查询问题，提升应用性能。
选择合适的格式化方法：
- 对于简单的、一次性的数据转换，map 和 pluck 是快速有效的。
- 对于复杂的 API 或需要长期维护的项目，API 资源是更推荐的选择，它提供了更好的结构和可扩展性。
命名规范：在模型中定义关系时，通常使用复数形式作为关系方法名（如 skills），这有助于代码的可读性。
数据库字段名：在 map 回调或 API 资源中访问模型属性时，请确保使用正确的数据库字段名（例如 name_of_person 和 name_of_skill）。

总结

通过本教程，我们学习了如何在 Laravel 中高效地处理多对多关系数据。首先，通过定义 Eloquent 模型和 belongsToMany 关系，建立了数据模型。接着，利用 with() 方法进行预加载，有效解决了 N+1 查询问题。最后，我们探讨了两种数据格式化方法：使用 map 和 pluck 进行灵活转换，以及利用 Laravel API 资源实现更专业、可维护的数据输出。掌握这些技术将帮助您在 Laravel 项目中更有效地管理和展示复杂关联数据。

以上就是Laravel Many-to-Many 关系数据的高效获取与格式化教程的详细内容，更多请关注php中文网其它相关文章！