Laravel 多对多关系中获取特定列数据并格式化为数组教程

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

在 Laravel 应用开发中，多对多关系（Many-to-Many）是一种常见的关联类型，例如一个人可以拥有多种技能，而一种技能也可以被多人拥有。通常，这种关系通过一个中间表（也称作枢纽表或连接表）来实现。

假设我们有以下数据库表结构：

• person_table: 存储人员信息，包含 id 和 name_of_person 字段。
• skills_table: 存储技能信息，包含 id 和 name_of_skill 字段。
• person_skill: 中间表，包含 person_table_id 和 skills_table_id 字段，连接人员和技能。

我们的目标是获取每个人的信息，并将其拥有的所有技能名称以一个数组的形式附加到每个人员记录中，最终输出格式如下：

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

定义 Eloquent 模型关系

首先，在 Laravel Eloquent 模型中正确定义多对多关系是基础。在 Person 模型中，需要定义一个 belongsToMany 关系指向 Skill 模型。

// app/Models/Person.php
namespace App\Models;

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

class Person extends Model
{
    use HasFactory;

    protected $table = 'person_table'; // 如果表名不是persons，需要指定

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

// app/Models/Skill.php
namespace App\Models;

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

class Skill extends Model
{
    use HasFactory;

    protected $table = 'skills_table'; // 如果表名不是skills，需要指定
}

使用 with 预加载关联数据

为了避免 N+1 查询问题并高效地获取关联数据，我们应该使用 Eloquent 的 with 方法进行预加载（Eager Loading）。

use App\Models\Person;

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

此时，$people 是一个 Collection，其中每个 Person 模型实例都已加载了其关联的 skills 属性。$person-youjiankuohaophpcnskills 会返回一个包含 Skill 模型实例的 Collection。

格式化关联数据：map 和 pluck

直接访问 $person->skills 会得到一个 Skill 模型的集合，而不是我们期望的技能名称数组。为了提取特定的列（name_of_skill）并将其转换为一个简单的数组，我们可以结合使用 Collection 的 map 和 pluck 方法。

pluck('name_of_skill') 方法可以从 Skill 模型的集合中提取所有 name_of_skill 字段的值。然后，map 方法可以遍历 Person 模型的集合，对每个 Person 实例进行自定义的格式化。

序列猴子开放平台

具有长序列、多模态、单模型、大数据等特点的超大规模语言模型

0

查看详情

use App\Models\Person;

$formattedPeople = Person::with('skills')->get()->map(function (Person $person) {
    return [
        'id' => $person->id,
        'name' => $person->name_of_person, // 假设字段名为name_of_person
        'skills' => $person->skills->pluck('name_of_skill')->toArray(), // 提取技能名称并转换为数组
    ];
});

// $formattedPeople 现在是一个 Collection，其中每个元素都是一个符合预期格式的数组
// 如果需要最终的纯 PHP 数组，可以再调用 $formattedPeople->toArray();

代码解释：

• Person::with('skills')->get()：获取所有人员及其关联的技能，避免 N+1 查询。
• ->map(function (Person $person) { ... })：遍历每个人员模型。对于每个 Person 实例，执行回调函数来构造一个新的数组。
• 'id' => $person->id 和 'name' => $person->name_of_person：直接获取人员的主键和名称。
• 'skills' => $person->skills->pluck('name_of_skill')->toArray()：这是关键步骤。
  • $person->skills：访问已预加载的技能集合。
  • ->pluck('name_of_skill')：从技能集合中提取所有 name_of_skill 字段的值，返回一个新的 Collection。
  • ->toArray()：将这个只包含技能名称的 Collection 转换为一个纯 PHP 数组。

进阶：使用 Laravel API Resources

对于更复杂的 API 响应或需要更严格、可维护的输出格式，Laravel 提供了强大的 API Resources 功能。API Resources 允许你以对象导向的方式定义数据的转换逻辑，使得 API 响应的结构化更加清晰。

首先，创建一个 PersonResource：

php artisan make:resource PersonResource

然后，编辑生成的资源文件：

// app/Http/Resources/PersonResource.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 关系被加载时，才包含技能数据
            'skills' => $this->whenLoaded('skills', function () {
                return $this->skills->pluck('name_of_skill');
            }),
        ];
    }
}

在控制器或路由中，你可以这样使用它：

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

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

// 返回格式化后的数据
return PersonResource::collection($people);

API Resources 的优势：

• 分离关注点： 将数据转换逻辑从控制器中分离出来，使控制器更简洁。
• 一致性： 确保 API 响应在整个应用中保持一致的结构。
• 条件加载： whenLoaded('relation_name', callback) 方法可以确保只有在关系被预加载时才包含该数据，避免不必要的查询。
• 可重用性： 资源可以在不同的 API 端点中重用。

注意事项与最佳实践

1. N+1 查询问题： 始终使用 with() 进行预加载，尤其是在处理集合数据时，以避免为每个模型实例单独查询其关联数据，从而显著提高性能。
2. 字段命名： 确保 pluck() 中使用的字段名与数据库中的实际列名或模型中的访问器名称一致。
3. Collection 与 Array： Laravel Eloquent 返回的大多数结果都是 Collection 实例。如果你需要一个纯粹的 PHP 数组，记得在 Collection 上调用 ->toArray() 方法。
4. 关系定义： 确保 belongsToMany 关系在模型中正确定义，包括关联模型、中间表名以及外键。
5. 可读性： 对于简单的格式化，map 和 pluck 组合非常高效。对于复杂的输出结构或大型应用，API Resources 是更专业和可维护的选择。

总结

本教程详细介绍了在 Laravel 中处理多对多关系并格式化输出的两种主要方法。通过结合使用 Eloquent 的 with 方法进行高效预加载，然后利用 Collection 的 map 和 pluck 方法进行数据转换，我们可以轻松地将关联模型的特定列数据提取并整合到主模型的数据结构中。对于更复杂的 API 场景，Laravel API Resources 提供了一个优雅、可维护的解决方案，帮助我们构建结构清晰、易于管理的 API 响应。掌握这些技术将大大提升你在 Laravel 中处理复杂数据关联的效率和代码质量。

以上就是Laravel 多对多关系中获取特定列数据并格式化为数组教程的详细内容，更多请关注php中文网其它相关文章！