Laravel 关联模型 ID 加载技巧

本文旨在介绍如何在 Laravel 中高效地加载关联模型的 ID 数组，避免多次使用 `transform` 函数，并通过 `pluck` 方法、循环处理以及使用查询构建器等多种方式，优化数据查询性能，最终提供简洁且高效的代码示例。 在 Laravel 开发中，经常会遇到需要加载关联模型，并且只需要关联模型的 ID 数组的情况。例如，一个 `Page` 模型与 `Country` 和 `State` 模型存在多对多关系，我们需要获取与该 `Page` 关联的所有 `Country` 和 `State` 的 ID 数组。虽然可以使用 `load` 方法加载关系，然后使用 `transform` 函数将结果转换为 ID 数组，但当需要加载多个关系时，这种方法会显得繁琐且效率较低。本文将介绍几种更高效的方法来实现这个目标。 ## 使用 `pluck` 方法 `pluck` 方法是 Laravel 集合提供的一个非常方便的函数，可以用于从集合中提取指定字段的值，并返回一个包含这些值的数组。我们可以利用 `pluck` 方法直接从关联关系中获取 ID 数组，而无需先加载整个关联模型。 ```php public function view(Page $page) { $result = $page->toArray(); $result['countries'] = $page->countries()->pluck('id'); $result['states'] = $page->states()->pluck('id'); return response()->json($result); }

这段代码首先将 Page 模型转换为数组，然后使用 countries() 和 states() 方法获取关联关系的查询构建器实例，并调用 pluck('id') 方法，直接获取 countries 和 states 表中的 id 字段值，并将结果赋值给 $result 数组中对应的键。最后，将 $result 数组作为 JSON 响应返回。

循环处理多个关系

如果需要加载的关系数量较多，可以考虑使用循环来简化代码。

public function view(Page $page)
{
    $result = $page->toArray();
    $relationships = ['countries', 'states'];
    foreach ($relationships as $rel) {
        $result[$rel] = $page->{$rel}()->pluck('id');
    }

    return response()->json($result);
}

这段代码定义了一个包含所有需要加载的关系名称的数组 $relationships，然后使用 foreach 循环遍历该数组，并在循环中动态地调用 Page 模型的关联关系方法，并使用 pluck('id') 方法获取 ID 数组。

使用查询构建器（Query Builder）

另一种方法是使用 Laravel 的查询构建器，通过 leftJoin 和 GROUP_CONCAT 函数，直接在数据库层面获取关联模型的 ID 数组。这种方法可以减少数据库查询次数，提高性能。

use Illuminate\Support\Facades\DB;

public function view(int $page)
{
    $result = DB::table('pages')
        ->select('pages.*')
        ->selectRaw('GROUP_CONCAT(page_country.country_id) AS countries')
        ->selectRaw('GROUP_CONCAT(page_state.state_id) AS states')
        ->leftJoin('page_country', 'page_country.page_id', '=', 'pages.id')
        ->leftJoin('page_state', 'page_state.page_id', '=', 'pages.id')
        ->where('pages.id', $page)
        ->groupBy('pages.id')
        ->first();

    // 将逗号分隔的字符串转换为数组
    if ($result) {
        $result->countries = $result->countries ? explode(',', $result->countries) : [];
        $result->states = $result->states ? explode(',', $result->states) : [];
    }

    return response()->json($result);
}

这段代码使用 DB::table 方法创建一个查询构建器实例，并指定要查询的表为 pages。然后，使用 selectRaw 方法添加两个自定义的 SQL 表达式，分别用于获取关联的 countries 和 states 的 ID 数组。GROUP_CONCAT 函数用于将多个 ID 连接成一个逗号分隔的字符串。接下来，使用 leftJoin 方法将 pages 表与 page_country 和 page_state 表进行左连接。最后，使用 where 方法指定查询条件，并使用 groupBy 方法按照 pages.id 进行分组。使用 first() 方法获取查询结果。

注意事项：

• 使用 GROUP_CONCAT 函数时，需要注意数据库的配置，确保 group_concat_max_len 参数的值足够大，以容纳所有连接的 ID。
• 返回的结果是一个逗号分隔的字符串，需要使用 explode 函数将其转换为数组。

Eloquent Resources 和 Collections

Eloquent Resources 和 Collections 提供了一种转换 Eloquent 模型和模型集合为 JSON 结构的优雅方式。 虽然它们的主要用途是格式化输出，但也可以用来简化获取关联模型 ID 数组的过程。

首先，创建一个 Resource：

 $this->id,
            'countries' => $this->countries()->pluck('id'),
            'states' => $this->states()->pluck('id'),
            // 其他属性
        ];
    }
}

然后，在控制器中使用 Resource：

use App\Http\Resources\PageResource;

public function view(Page $page)
{
    return new PageResource($page);
}

这样，就可以将 Page 模型转换为包含 countries 和 states ID 数组的 JSON 结构。

总结

本文介绍了四种在 Laravel 中高效加载关联模型 ID 数组的方法：使用 pluck 方法、循环处理多个关系、使用查询构建器以及使用 Eloquent Resources。可以根据实际情况选择最适合的方法。如果只需要加载少量关系，并且对性能要求不高，可以使用 pluck 方法或循环处理多个关系。如果需要加载大量关系，并且对性能要求较高，可以考虑使用查询构建器。使用 Eloquent Resources则提供了一种更结构化的方式来转换数据，特别是在API开发中。选择哪种方法取决于具体的需求和场景。