CakePHP：限制 hasMany 查询中关联表的字段

本文介绍了在使用 Cakephp 的 hasMany 关联查询时，如何限制主表和关联表中返回的字段，以优化性能。重点讲解了必须选择主表主键的原因，并提供了使用 formatResults 方法过滤字段的示例代码，帮助开发者更有效地控制查询结果。

在使用 CakePHP 的 ORM 进行数据库查询时，经常需要使用 hasMany 关联来获取相关联的数据。然而，默认情况下，CakePHP 会返回所有字段，这在某些情况下可能会影响性能。本文将介绍如何限制主表和关联表中返回的字段，以优化查询效率。

限制关联表字段

在使用 contain() 方法进行关联查询时，可以通过回调函数来限制关联表的字段。回调函数接收一个查询对象作为参数，可以使用 select() 方法来指定要返回的字段。

$tablePA = TableRegistry::get('ProcessoAdministrativo');  $query = $tablePA->find()     ->select(['codigo_pa'])     ->contain([         'DocumentoProcessoAdministrativo' => function ($q) {             return $q->select(['id', 'descricao', 'ordem', 'processo_administrativo_id']);         }     ])->toArray();  debug($query);

在上面的示例中，我们限制了 DocumentoProcessoAdministrativo 表只返回 id、descricao、ordem 和 processo_administrativo_id 字段。

立即学习“PHP免费学习笔记（深入）”；

必须选择主表主键

在进行 hasMany 或 belongsToMany 关联查询时，必须选择主表的主键。这是因为 CakePHP 在 PHP 层面将从不同查询中获取的 hasMany/belongsToMany 记录合并到结果中。如果没有主表的主键，ORM 无法将 DocumentoProcessoAdministrativo 记录与对应的 ProcessoAdministrativo 记录关联起来，因为它无法根据 processo_administrativo_id 外键进行匹配。

$query = $tablePA     ->find()     ->select(['id', 'codigo_pa']) // 必须选择 'id' (主键)     ->contain([         'DocumentoProcessoAdministrativo' => function ($q) {             return $q->select(['id', 'descricao', 'ordem', 'processo_administrativo_id']);         }     ]);

在这个例子中，即使我们只想获取 codigo_pa 字段，也必须选择 id 字段（ProcessoAdministrativo 表的主键）。

移除主表主键

如果最终结果中不需要主表的主键字段，可以使用 formatResults() 方法在查询后过滤掉它。formatResults() 方法允许你对查询结果进行自定义处理。

use CakeCollectionCollectionInterface;  $query = $tablePA     ->find()     ->select(['id', 'codigo_pa'])     ->contain([         'DocumentoProcessoAdministrativo' => function ($q) {             return $q->select(['id', 'descricao', 'ordem', 'processo_administrativo_id']);         }     ])     ->formatResults(function (CollectionInterface $results) {         return $results->map(function ($row) {             unset($row['id']); // 移除 'id' 字段             return $row;         });     });

上面的代码首先选择了 id 字段（为了关联查询的正确性），然后在查询结果中使用 formatResults() 方法移除了 id 字段。

注意事项：

• formatResults() 方法是在 PHP 层面处理数据，因此可能会对性能产生一定影响。如果数据量非常大，可以考虑在数据库层面进行过滤。
• 确保选择主表的主键，否则关联查询将无法正确工作。

总结：

通过使用 select() 方法和 formatResults() 方法，可以有效地限制 hasMany 关联查询中返回的字段，从而优化性能并减少不必要的数据传输。务必注意选择主表的主键，以确保关联查询的正确性。