Symfony Api Platform 如何筛选获取父级行或parent为null的结果
Symfony Api Platform 自关联实体按parent可选筛选实现指南
核心问题定位
之前尝试使用Doctrine查询扩展实现筛选逻辑失败的核心原因是:全局查询扩展会对所有命中该实体的查询强制执行拼接WHERE条件,无法实现「仅在用户主动触发筛选时才追加过滤逻辑」的需求。
针对提出的「需要可选返回parent为null的顶级记录、或本身作为父级的记录,不影响其他查询场景」的需求,可通过以下两种无副作用的方案实现:
方案1:自定义按需触发的过滤器(完全匹配需求)
这是最适配场景的实现方式,过滤器的核心特性是仅当请求传入对应查询参数时才会修改查询逻辑,无全局强制约束。
实现步骤
- 编写自定义过滤器类,封装需要的筛选逻辑:
// src/Filter/RootUyapTypeFilter.php namespace App\Filter; use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\AbstractFilter; use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface; use Doctrine\ORM\QueryBuilder; final class RootUyapTypeFilter extends AbstractFilter { protected function filterProperty( string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null ) { // 仅监听自定义的root参数,参数值为1时才触发筛选 if ($property !== 'root' || $value !== '1') { return; } $rootAlias = $queryBuilder->getRootAliases()[0]; // 拼接需求的筛选规则:parent为null(顶级记录) 或 parent有值(父级记录) $queryBuilder->andWhere( sprintf('%s.parent IS NULL OR %s.parent IS NOT NULL', $rootAlias, $rootAlias) ); } // 供Api Platform自动生成接口文档使用 public function getDescription(string $resourceClass): array { return [ 'root' => [ 'property' => null, 'type' => 'string', 'required' => false, 'description' => '传入1时,仅返回顶级(parent为空)或作为父级的记录', ] ]; } } - 在实体类上注册该过滤器,保留原有按parent.id精确筛选的能力:
// 对应App\Entity\UyapType类的注解部分 /** * @ApiResource( * collectionOperations={"get", "post"}, * itemOperations={"get", "put", "delete"} * ) * @ApiFilter(NumericFilter::class, properties={"parent.id"}) * @ApiFilter(\App\Filter\RootUyapTypeFilter::class) * @ORM\Entity(repositoryClass=UyapTypeRepository::class) */
使用效果
- 默认请求
/api/uyap_types:返回全量记录,行为和原有系统完全一致,无额外过滤 - 触发筛选请求
/api/uyap_types?root=1:自动追加要求的WHERE条件,返回所有parent为null、或本身存在子级引用的父级记录 - 原有精确筛选能力不受影响:请求
/api/uyap_types?parent.id=3依然可以正常返回指定父级下的所有子记录
方案2:使用内置过滤器组合实现(零自定义代码)
如果不需要通过单个参数实现OR条件的合并筛选,可直接使用Api Platform内置的过滤器能力,无需编写自定义逻辑:
- 注册两个内置过滤器:
/** * @ApiFilter(ExistsFilter::class, properties={"parent"}) * @ApiFilter(NumericFilter::class, properties={"parent.id"}) */ - 前端可通过参数组合实现对应筛选能力:
- 筛选所有顶级(parent为null)的记录:请求
/api/uyap_types?parent.exists=0 - 筛选所有作为父级(parent字段有值)的记录:请求
/api/uyap_types?parent.exists=1 - 该方案的局限性是无法通过单次请求直接返回「parent为null 或 parent有值」的合并结果,需要前端拆分多次请求,胜在实现成本极低、无任何自定义代码维护成本。
- 筛选所有顶级(parent为null)的记录:请求
注:全局查询扩展仅适合用于所有场景都需要强制执行的权限校验、租户隔离类逻辑,不适合用于可选触发的业务筛选逻辑,否则会导致无差别修改所有查询的默认行为,和当前需求场景不匹配。
内容的提问来源于stack exchange,提问作者karatas.hakan
相关产品推荐
相关产品推荐

